1 /* Find a variable's value in memory, for GDB, the GNU debugger.
3 Copyright (C) 1986-2013 Free Software Foundation, Inc.
5 This file is part of GDB.
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 3 of the License, or
10 (at your option) any later version.
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.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
28 #include "gdb_string.h"
29 #include "gdb_assert.h"
30 #include "floatformat.h"
31 #include "symfile.h" /* for overlay functions */
33 #include "user-regs.h"
38 /* Basic byte-swapping routines. All 'extract' functions return a
39 host-format integer from a target-format integer at ADDR which is
42 #if TARGET_CHAR_BIT != 8 || HOST_CHAR_BIT != 8
43 /* 8 bit characters are a pretty safe assumption these days, so we
44 assume it throughout all these swapping routines. If we had to deal with
45 9 bit characters, we would need to make len be in bits and would have
46 to re-write these routines... */
51 extract_signed_integer (const gdb_byte *addr, int len,
52 enum bfd_endian byte_order)
55 const unsigned char *p;
56 const unsigned char *startaddr = addr;
57 const unsigned char *endaddr = startaddr + len;
59 if (len > (int) sizeof (LONGEST))
61 That operation is not available on integers of more than %d bytes."),
62 (int) sizeof (LONGEST));
64 /* Start at the most significant end of the integer, and work towards
65 the least significant. */
66 if (byte_order == BFD_ENDIAN_BIG)
69 /* Do the sign extension once at the start. */
70 retval = ((LONGEST) * p ^ 0x80) - 0x80;
71 for (++p; p < endaddr; ++p)
72 retval = (retval << 8) | *p;
77 /* Do the sign extension once at the start. */
78 retval = ((LONGEST) * p ^ 0x80) - 0x80;
79 for (--p; p >= startaddr; --p)
80 retval = (retval << 8) | *p;
86 extract_unsigned_integer (const gdb_byte *addr, int len,
87 enum bfd_endian byte_order)
90 const unsigned char *p;
91 const unsigned char *startaddr = addr;
92 const unsigned char *endaddr = startaddr + len;
94 if (len > (int) sizeof (ULONGEST))
96 That operation is not available on integers of more than %d bytes."),
97 (int) sizeof (ULONGEST));
99 /* Start at the most significant end of the integer, and work towards
100 the least significant. */
102 if (byte_order == BFD_ENDIAN_BIG)
104 for (p = startaddr; p < endaddr; ++p)
105 retval = (retval << 8) | *p;
109 for (p = endaddr - 1; p >= startaddr; --p)
110 retval = (retval << 8) | *p;
115 /* Sometimes a long long unsigned integer can be extracted as a
116 LONGEST value. This is done so that we can print these values
117 better. If this integer can be converted to a LONGEST, this
118 function returns 1 and sets *PVAL. Otherwise it returns 0. */
121 extract_long_unsigned_integer (const gdb_byte *addr, int orig_len,
122 enum bfd_endian byte_order, LONGEST *pval)
125 const gdb_byte *first_addr;
129 if (byte_order == BFD_ENDIAN_BIG)
132 len > (int) sizeof (LONGEST) && p < addr + orig_len;
145 for (p = addr + orig_len - 1;
146 len > (int) sizeof (LONGEST) && p >= addr;
156 if (len <= (int) sizeof (LONGEST))
158 *pval = (LONGEST) extract_unsigned_integer (first_addr,
168 /* Treat the bytes at BUF as a pointer of type TYPE, and return the
169 address it represents. */
171 extract_typed_address (const gdb_byte *buf, struct type *type)
173 if (TYPE_CODE (type) != TYPE_CODE_PTR
174 && TYPE_CODE (type) != TYPE_CODE_REF)
175 internal_error (__FILE__, __LINE__,
176 _("extract_typed_address: "
177 "type is not a pointer or reference"));
179 return gdbarch_pointer_to_address (get_type_arch (type), type, buf);
182 /* All 'store' functions accept a host-format integer and store a
183 target-format integer at ADDR which is LEN bytes long. */
186 store_signed_integer (gdb_byte *addr, int len,
187 enum bfd_endian byte_order, LONGEST val)
190 gdb_byte *startaddr = addr;
191 gdb_byte *endaddr = startaddr + len;
193 /* Start at the least significant end of the integer, and work towards
194 the most significant. */
195 if (byte_order == BFD_ENDIAN_BIG)
197 for (p = endaddr - 1; p >= startaddr; --p)
205 for (p = startaddr; p < endaddr; ++p)
214 store_unsigned_integer (gdb_byte *addr, int len,
215 enum bfd_endian byte_order, ULONGEST val)
218 unsigned char *startaddr = (unsigned char *) addr;
219 unsigned char *endaddr = startaddr + len;
221 /* Start at the least significant end of the integer, and work towards
222 the most significant. */
223 if (byte_order == BFD_ENDIAN_BIG)
225 for (p = endaddr - 1; p >= startaddr; --p)
233 for (p = startaddr; p < endaddr; ++p)
241 /* Store the address ADDR as a pointer of type TYPE at BUF, in target
244 store_typed_address (gdb_byte *buf, struct type *type, CORE_ADDR addr)
246 if (TYPE_CODE (type) != TYPE_CODE_PTR
247 && TYPE_CODE (type) != TYPE_CODE_REF)
248 internal_error (__FILE__, __LINE__,
249 _("store_typed_address: "
250 "type is not a pointer or reference"));
252 gdbarch_address_to_pointer (get_type_arch (type), type, buf, addr);
257 /* Return a `value' with the contents of (virtual or cooked) register
258 REGNUM as found in the specified FRAME. The register's type is
259 determined by register_type(). */
262 value_of_register (int regnum, struct frame_info *frame)
264 struct gdbarch *gdbarch = get_frame_arch (frame);
268 struct value *reg_val;
269 struct type *reg_type;
271 gdb_byte raw_buffer[MAX_REGISTER_SIZE];
274 /* User registers lie completely outside of the range of normal
275 registers. Catch them early so that the target never sees them. */
276 if (regnum >= gdbarch_num_regs (gdbarch)
277 + gdbarch_num_pseudo_regs (gdbarch))
278 return value_of_user_reg (regnum, frame);
280 frame_register (frame, regnum, &optim, &unavail,
281 &lval, &addr, &realnum, raw_buffer);
283 reg_type = register_type (gdbarch, regnum);
285 reg_val = allocate_optimized_out_value (reg_type);
287 reg_val = allocate_value (reg_type);
289 if (!optim && !unavail)
290 memcpy (value_contents_raw (reg_val), raw_buffer,
291 register_size (gdbarch, regnum));
293 memset (value_contents_raw (reg_val), 0,
294 register_size (gdbarch, regnum));
296 VALUE_LVAL (reg_val) = lval;
297 set_value_address (reg_val, addr);
298 VALUE_REGNUM (reg_val) = regnum;
300 mark_value_bytes_unavailable (reg_val, 0, register_size (gdbarch, regnum));
301 VALUE_FRAME_ID (reg_val) = get_frame_id (frame);
305 /* Return a `value' with the contents of (virtual or cooked) register
306 REGNUM as found in the specified FRAME. The register's type is
307 determined by register_type(). The value is not fetched. */
310 value_of_register_lazy (struct frame_info *frame, int regnum)
312 struct gdbarch *gdbarch = get_frame_arch (frame);
313 struct value *reg_val;
315 gdb_assert (regnum < (gdbarch_num_regs (gdbarch)
316 + gdbarch_num_pseudo_regs (gdbarch)));
318 /* We should have a valid (i.e. non-sentinel) frame. */
319 gdb_assert (frame_id_p (get_frame_id (frame)));
321 reg_val = allocate_value_lazy (register_type (gdbarch, regnum));
322 VALUE_LVAL (reg_val) = lval_register;
323 VALUE_REGNUM (reg_val) = regnum;
324 VALUE_FRAME_ID (reg_val) = get_frame_id (frame);
328 /* Given a pointer of type TYPE in target form in BUF, return the
329 address it represents. */
331 unsigned_pointer_to_address (struct gdbarch *gdbarch,
332 struct type *type, const gdb_byte *buf)
334 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
336 return extract_unsigned_integer (buf, TYPE_LENGTH (type), byte_order);
340 signed_pointer_to_address (struct gdbarch *gdbarch,
341 struct type *type, const gdb_byte *buf)
343 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
345 return extract_signed_integer (buf, TYPE_LENGTH (type), byte_order);
348 /* Given an address, store it as a pointer of type TYPE in target
351 unsigned_address_to_pointer (struct gdbarch *gdbarch, struct type *type,
352 gdb_byte *buf, CORE_ADDR addr)
354 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
356 store_unsigned_integer (buf, TYPE_LENGTH (type), byte_order, addr);
360 address_to_signed_pointer (struct gdbarch *gdbarch, struct type *type,
361 gdb_byte *buf, CORE_ADDR addr)
363 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
365 store_signed_integer (buf, TYPE_LENGTH (type), byte_order, addr);
368 /* Will calling read_var_value or locate_var_value on SYM end
369 up caring what frame it is being evaluated relative to? SYM must
372 symbol_read_needs_frame (struct symbol *sym)
374 if (SYMBOL_COMPUTED_OPS (sym) != NULL)
375 return SYMBOL_COMPUTED_OPS (sym)->read_needs_frame (sym);
377 switch (SYMBOL_CLASS (sym))
379 /* All cases listed explicitly so that gcc -Wall will detect it if
380 we failed to consider one. */
382 gdb_assert_not_reached (_("LOC_COMPUTED variable missing a method"));
387 case LOC_REGPARM_ADDR:
397 /* Getting the address of a label can be done independently of the block,
398 even if some *uses* of that address wouldn't work so well without
402 case LOC_CONST_BYTES:
404 case LOC_OPTIMIZED_OUT:
410 /* Private data to be used with minsym_lookup_iterator_cb. */
412 struct minsym_lookup_data
414 /* The name of the minimal symbol we are searching for. */
417 /* The field where the callback should store the minimal symbol
418 if found. It should be initialized to NULL before the search
420 struct minimal_symbol *result;
422 /* The objfile in which the symbol was found. */
423 struct objfile *objfile;
426 /* A callback function for gdbarch_iterate_over_objfiles_in_search_order.
427 It searches by name for a minimal symbol within the given OBJFILE.
428 The arguments are passed via CB_DATA, which in reality is a pointer
429 to struct minsym_lookup_data. */
432 minsym_lookup_iterator_cb (struct objfile *objfile, void *cb_data)
434 struct minsym_lookup_data *data = (struct minsym_lookup_data *) cb_data;
436 gdb_assert (data->result == NULL);
438 data->result = lookup_minimal_symbol (data->name, NULL, objfile);
439 data->objfile = objfile;
441 /* The iterator should stop iff a match was found. */
442 return (data->result != NULL);
445 /* A default implementation for the "la_read_var_value" hook in
446 the language vector which should work in most situations. */
449 default_read_var_value (struct symbol *var, struct frame_info *frame)
452 struct type *type = SYMBOL_TYPE (var);
455 /* Call check_typedef on our type to make sure that, if TYPE is
456 a TYPE_CODE_TYPEDEF, its length is set to the length of the target type
457 instead of zero. However, we do not replace the typedef type by the
458 target type, because we want to keep the typedef in order to be able to
459 set the returned value type description correctly. */
460 check_typedef (type);
462 if (symbol_read_needs_frame (var))
465 if (SYMBOL_COMPUTED_OPS (var) != NULL)
466 return SYMBOL_COMPUTED_OPS (var)->read_variable (var, frame);
468 switch (SYMBOL_CLASS (var))
471 /* Put the constant back in target format. */
472 v = allocate_value (type);
473 store_signed_integer (value_contents_raw (v), TYPE_LENGTH (type),
474 gdbarch_byte_order (get_type_arch (type)),
475 (LONGEST) SYMBOL_VALUE (var));
476 VALUE_LVAL (v) = not_lval;
480 /* Put the constant back in target format. */
481 v = allocate_value (type);
482 if (overlay_debugging)
485 = symbol_overlayed_address (SYMBOL_VALUE_ADDRESS (var),
486 SYMBOL_OBJ_SECTION (SYMBOL_OBJFILE (var),
489 store_typed_address (value_contents_raw (v), type, addr);
492 store_typed_address (value_contents_raw (v), type,
493 SYMBOL_VALUE_ADDRESS (var));
494 VALUE_LVAL (v) = not_lval;
497 case LOC_CONST_BYTES:
498 v = allocate_value (type);
499 memcpy (value_contents_raw (v), SYMBOL_VALUE_BYTES (var),
501 VALUE_LVAL (v) = not_lval;
505 v = allocate_value_lazy (type);
506 if (overlay_debugging)
507 addr = symbol_overlayed_address (SYMBOL_VALUE_ADDRESS (var),
508 SYMBOL_OBJ_SECTION (SYMBOL_OBJFILE (var),
511 addr = SYMBOL_VALUE_ADDRESS (var);
515 addr = get_frame_args_address (frame);
517 error (_("Unknown argument list address for `%s'."),
518 SYMBOL_PRINT_NAME (var));
519 addr += SYMBOL_VALUE (var);
520 v = allocate_value_lazy (type);
528 argref = get_frame_args_address (frame);
530 error (_("Unknown argument list address for `%s'."),
531 SYMBOL_PRINT_NAME (var));
532 argref += SYMBOL_VALUE (var);
533 ref = value_at (lookup_pointer_type (type), argref);
534 addr = value_as_address (ref);
535 v = allocate_value_lazy (type);
540 addr = get_frame_locals_address (frame);
541 addr += SYMBOL_VALUE (var);
542 v = allocate_value_lazy (type);
546 error (_("Cannot look up value of a typedef `%s'."),
547 SYMBOL_PRINT_NAME (var));
551 v = allocate_value_lazy (type);
552 if (overlay_debugging)
553 addr = symbol_overlayed_address
554 (BLOCK_START (SYMBOL_BLOCK_VALUE (var)), SYMBOL_OBJ_SECTION (SYMBOL_OBJFILE (var),
557 addr = BLOCK_START (SYMBOL_BLOCK_VALUE (var));
561 case LOC_REGPARM_ADDR:
563 int regno = SYMBOL_REGISTER_OPS (var)
564 ->register_number (var, get_frame_arch (frame));
565 struct value *regval;
567 if (SYMBOL_CLASS (var) == LOC_REGPARM_ADDR)
569 regval = value_from_register (lookup_pointer_type (type),
574 error (_("Value of register variable not available for `%s'."),
575 SYMBOL_PRINT_NAME (var));
577 addr = value_as_address (regval);
578 v = allocate_value_lazy (type);
582 regval = value_from_register (type, regno, frame);
585 error (_("Value of register variable not available for `%s'."),
586 SYMBOL_PRINT_NAME (var));
593 gdb_assert_not_reached (_("LOC_COMPUTED variable missing a method"));
597 struct minsym_lookup_data lookup_data;
598 struct minimal_symbol *msym;
599 struct obj_section *obj_section;
601 memset (&lookup_data, 0, sizeof (lookup_data));
602 lookup_data.name = SYMBOL_LINKAGE_NAME (var);
604 gdbarch_iterate_over_objfiles_in_search_order
605 (get_objfile_arch (SYMBOL_SYMTAB (var)->objfile),
606 minsym_lookup_iterator_cb, &lookup_data,
607 SYMBOL_SYMTAB (var)->objfile);
608 msym = lookup_data.result;
611 error (_("No global symbol \"%s\"."), SYMBOL_LINKAGE_NAME (var));
612 if (overlay_debugging)
613 addr = symbol_overlayed_address (SYMBOL_VALUE_ADDRESS (msym),
614 SYMBOL_OBJ_SECTION (lookup_data.objfile,
617 addr = SYMBOL_VALUE_ADDRESS (msym);
619 obj_section = SYMBOL_OBJ_SECTION (lookup_data.objfile, msym);
621 && (obj_section->the_bfd_section->flags & SEC_THREAD_LOCAL) != 0)
622 addr = target_translate_tls_address (obj_section->objfile, addr);
623 v = allocate_value_lazy (type);
627 case LOC_OPTIMIZED_OUT:
628 return allocate_optimized_out_value (type);
631 error (_("Cannot look up value of a botched symbol `%s'."),
632 SYMBOL_PRINT_NAME (var));
636 VALUE_LVAL (v) = lval_memory;
637 set_value_address (v, addr);
641 /* Calls VAR's language la_read_var_value hook with the given arguments. */
644 read_var_value (struct symbol *var, struct frame_info *frame)
646 const struct language_defn *lang = language_def (SYMBOL_LANGUAGE (var));
648 gdb_assert (lang != NULL);
649 gdb_assert (lang->la_read_var_value != NULL);
651 return lang->la_read_var_value (var, frame);
654 /* Install default attributes for register values. */
657 default_value_from_register (struct type *type, int regnum,
658 struct frame_info *frame)
660 struct gdbarch *gdbarch = get_frame_arch (frame);
661 int len = TYPE_LENGTH (type);
662 struct value *value = allocate_value (type);
664 VALUE_LVAL (value) = lval_register;
665 VALUE_FRAME_ID (value) = get_frame_id (frame);
666 VALUE_REGNUM (value) = regnum;
668 /* Any structure stored in more than one register will always be
669 an integral number of registers. Otherwise, you need to do
670 some fiddling with the last register copied here for little
672 if (gdbarch_byte_order (gdbarch) == BFD_ENDIAN_BIG
673 && len < register_size (gdbarch, regnum))
674 /* Big-endian, and we want less than full size. */
675 set_value_offset (value, register_size (gdbarch, regnum) - len);
677 set_value_offset (value, 0);
682 /* VALUE must be an lval_register value. If regnum is the value's
683 associated register number, and len the length of the values type,
684 read one or more registers in FRAME, starting with register REGNUM,
685 until we've read LEN bytes.
687 If any of the registers we try to read are optimized out, then mark the
688 complete resulting value as optimized out. */
691 read_frame_register_value (struct value *value, struct frame_info *frame)
693 struct gdbarch *gdbarch = get_frame_arch (frame);
695 int reg_offset = value_offset (value);
696 int regnum = VALUE_REGNUM (value);
697 int len = TYPE_LENGTH (check_typedef (value_type (value)));
699 gdb_assert (VALUE_LVAL (value) == lval_register);
701 /* Skip registers wholly inside of REG_OFFSET. */
702 while (reg_offset >= register_size (gdbarch, regnum))
704 reg_offset -= register_size (gdbarch, regnum);
711 struct value *regval = get_frame_register_value (frame, regnum);
712 int reg_len = TYPE_LENGTH (value_type (regval)) - reg_offset;
714 if (value_optimized_out (regval))
716 set_value_optimized_out (value, 1);
720 /* If the register length is larger than the number of bytes
721 remaining to copy, then only copy the appropriate bytes. */
725 value_contents_copy (value, offset, regval, reg_offset, reg_len);
734 /* Return a value of type TYPE, stored in register REGNUM, in frame FRAME. */
737 value_from_register (struct type *type, int regnum, struct frame_info *frame)
739 struct gdbarch *gdbarch = get_frame_arch (frame);
740 struct type *type1 = check_typedef (type);
743 if (gdbarch_convert_register_p (gdbarch, regnum, type1))
745 int optim, unavail, ok;
747 /* The ISA/ABI need to something weird when obtaining the
748 specified value from this register. It might need to
749 re-order non-adjacent, starting with REGNUM (see MIPS and
750 i386). It might need to convert the [float] register into
751 the corresponding [integer] type (see Alpha). The assumption
752 is that gdbarch_register_to_value populates the entire value
753 including the location. */
754 v = allocate_value (type);
755 VALUE_LVAL (v) = lval_register;
756 VALUE_FRAME_ID (v) = get_frame_id (frame);
757 VALUE_REGNUM (v) = regnum;
758 ok = gdbarch_register_to_value (gdbarch, frame, regnum, type1,
759 value_contents_raw (v), &optim,
765 set_value_optimized_out (v, 1);
767 mark_value_bytes_unavailable (v, 0, TYPE_LENGTH (type));
772 /* Construct the value. */
773 v = gdbarch_value_from_register (gdbarch, type, regnum, frame);
776 read_frame_register_value (v, frame);
782 /* Return contents of register REGNUM in frame FRAME as address,
783 interpreted as value of type TYPE. Will abort if register
784 value is not available. */
787 address_from_register (struct type *type, int regnum, struct frame_info *frame)
792 value = value_from_register (type, regnum, frame);
795 result = value_as_address (value);
796 release_value (value);