1 /* Find a variable's value in memory, for GDB, the GNU debugger.
3 Copyright 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994,
4 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2003, 2004 Free Software
7 This file is part of GDB.
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.
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.
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. */
32 #include "gdb_string.h"
33 #include "gdb_assert.h"
34 #include "floatformat.h"
35 #include "symfile.h" /* for overlay functions */
37 #include "user-regs.h"
40 /* Basic byte-swapping routines. GDB has needed these for a long time...
41 All extract a target-format integer at ADDR which is LEN bytes long. */
43 #if TARGET_CHAR_BIT != 8 || HOST_CHAR_BIT != 8
44 /* 8 bit characters are a pretty safe assumption these days, so we
45 assume it throughout all these swapping routines. If we had to deal with
46 9 bit characters, we would need to make len be in bits and would have
47 to re-write these routines... */
52 extract_signed_integer (const void *addr, int len)
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 (TARGET_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 void *addr, int len)
89 const unsigned char *p;
90 const unsigned char *startaddr = addr;
91 const unsigned char *endaddr = startaddr + len;
93 if (len > (int) sizeof (ULONGEST))
95 That operation is not available on integers of more than %d bytes.",
96 (int) sizeof (ULONGEST));
98 /* Start at the most significant end of the integer, and work towards
99 the least significant. */
101 if (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
103 for (p = startaddr; p < endaddr; ++p)
104 retval = (retval << 8) | *p;
108 for (p = endaddr - 1; p >= startaddr; --p)
109 retval = (retval << 8) | *p;
114 /* Sometimes a long long unsigned integer can be extracted as a
115 LONGEST value. This is done so that we can print these values
116 better. If this integer can be converted to a LONGEST, this
117 function returns 1 and sets *PVAL. Otherwise it returns 0. */
120 extract_long_unsigned_integer (const void *addr, int orig_len, LONGEST *pval)
122 char *p, *first_addr;
126 if (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
128 for (p = (char *) addr;
129 len > (int) sizeof (LONGEST) && p < (char *) addr + orig_len;
141 first_addr = (char *) addr;
142 for (p = (char *) addr + orig_len - 1;
143 len > (int) sizeof (LONGEST) && p >= (char *) addr;
153 if (len <= (int) sizeof (LONGEST))
155 *pval = (LONGEST) extract_unsigned_integer (first_addr,
164 /* Treat the bytes at BUF as a pointer of type TYPE, and return the
165 address it represents. */
167 extract_typed_address (const void *buf, struct type *type)
169 if (TYPE_CODE (type) != TYPE_CODE_PTR
170 && TYPE_CODE (type) != TYPE_CODE_REF)
171 internal_error (__FILE__, __LINE__,
172 "extract_typed_address: "
173 "type is not a pointer or reference");
175 return POINTER_TO_ADDRESS (type, buf);
180 store_signed_integer (void *addr, int len, LONGEST val)
183 unsigned char *startaddr = (unsigned char *) addr;
184 unsigned char *endaddr = startaddr + len;
186 /* Start at the least significant end of the integer, and work towards
187 the most significant. */
188 if (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
190 for (p = endaddr - 1; p >= startaddr; --p)
198 for (p = startaddr; p < endaddr; ++p)
207 store_unsigned_integer (void *addr, int len, ULONGEST val)
210 unsigned char *startaddr = (unsigned char *) addr;
211 unsigned char *endaddr = startaddr + len;
213 /* Start at the least significant end of the integer, and work towards
214 the most significant. */
215 if (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
217 for (p = endaddr - 1; p >= startaddr; --p)
225 for (p = startaddr; p < endaddr; ++p)
233 /* Store the address ADDR as a pointer of type TYPE at BUF, in target
236 store_typed_address (void *buf, struct type *type, CORE_ADDR addr)
238 if (TYPE_CODE (type) != TYPE_CODE_PTR
239 && TYPE_CODE (type) != TYPE_CODE_REF)
240 internal_error (__FILE__, __LINE__,
241 "store_typed_address: "
242 "type is not a pointer or reference");
244 ADDRESS_TO_POINTER (type, buf, addr);
249 /* Return a `value' with the contents of (virtual or cooked) register
250 REGNUM as found in the specified FRAME. The register's type is
251 determined by register_type().
253 NOTE: returns NULL if register value is not available. Caller will
254 check return value or die! */
257 value_of_register (int regnum, struct frame_info *frame)
261 struct value *reg_val;
263 char raw_buffer[MAX_REGISTER_SIZE];
266 /* User registers lie completely outside of the range of normal
267 registers. Catch them early so that the target never sees them. */
268 if (regnum >= NUM_REGS + NUM_PSEUDO_REGS)
269 return value_of_user_reg (regnum, frame);
271 frame_register (frame, regnum, &optim, &lval, &addr, &realnum, raw_buffer);
273 /* FIXME: cagney/2002-05-15: This test is just bogus.
275 It indicates that the target failed to supply a value for a
276 register because it was "not available" at this time. Problem
277 is, the target still has the register and so get saved_register()
278 may be returning a value saved on the stack. */
280 if (register_cached (regnum) < 0)
281 return NULL; /* register value not available */
283 reg_val = allocate_value (register_type (current_gdbarch, regnum));
285 /* Convert raw data to virtual format if necessary. */
287 if (DEPRECATED_REGISTER_RAW_SIZE (regnum) == DEPRECATED_REGISTER_VIRTUAL_SIZE (regnum))
288 memcpy (VALUE_CONTENTS_RAW (reg_val), raw_buffer,
289 DEPRECATED_REGISTER_RAW_SIZE (regnum));
291 internal_error (__FILE__, __LINE__,
292 "Register \"%s\" (%d) has conflicting raw (%d) and virtual (%d) size",
293 REGISTER_NAME (regnum),
295 DEPRECATED_REGISTER_RAW_SIZE (regnum),
296 DEPRECATED_REGISTER_VIRTUAL_SIZE (regnum));
297 VALUE_LVAL (reg_val) = lval;
298 VALUE_ADDRESS (reg_val) = addr;
299 VALUE_REGNO (reg_val) = regnum;
300 VALUE_OPTIMIZED_OUT (reg_val) = optim;
304 /* Given a pointer of type TYPE in target form in BUF, return the
305 address it represents. */
307 unsigned_pointer_to_address (struct type *type, const void *buf)
309 return extract_unsigned_integer (buf, TYPE_LENGTH (type));
313 signed_pointer_to_address (struct type *type, const void *buf)
315 return extract_signed_integer (buf, TYPE_LENGTH (type));
318 /* Given an address, store it as a pointer of type TYPE in target
321 unsigned_address_to_pointer (struct type *type, void *buf, CORE_ADDR addr)
323 store_unsigned_integer (buf, TYPE_LENGTH (type), addr);
327 address_to_signed_pointer (struct type *type, void *buf, CORE_ADDR addr)
329 store_signed_integer (buf, TYPE_LENGTH (type), addr);
332 /* Will calling read_var_value or locate_var_value on SYM end
333 up caring what frame it is being evaluated relative to? SYM must
336 symbol_read_needs_frame (struct symbol *sym)
338 switch (SYMBOL_CLASS (sym))
340 /* All cases listed explicitly so that gcc -Wall will detect it if
341 we failed to consider one. */
343 case LOC_COMPUTED_ARG:
344 /* FIXME: cagney/2004-01-26: It should be possible to
345 unconditionally call the SYMBOL_OPS method when available.
346 Unfortunately DWARF 2 stores the frame-base (instead of the
347 function) location in a function's symbol. Oops! For the
348 moment enable this when/where applicable. */
349 return SYMBOL_OPS (sym)->read_needs_frame (sym);
355 case LOC_REGPARM_ADDR:
359 case LOC_BASEREG_ARG:
360 case LOC_HP_THREAD_LOCAL_STATIC:
370 /* Getting the address of a label can be done independently of the block,
371 even if some *uses* of that address wouldn't work so well without
375 case LOC_CONST_BYTES:
377 case LOC_OPTIMIZED_OUT:
383 /* Given a struct symbol for a variable,
384 and a stack frame id, read the value of the variable
385 and return a (pointer to a) struct value containing the value.
386 If the variable cannot be found, return a zero pointer.
387 If FRAME is NULL, use the deprecated_selected_frame. */
390 read_var_value (struct symbol *var, struct frame_info *frame)
393 struct type *type = SYMBOL_TYPE (var);
397 v = allocate_value (type);
398 VALUE_LVAL (v) = lval_memory; /* The most likely possibility. */
399 VALUE_BFD_SECTION (v) = SYMBOL_BFD_SECTION (var);
401 len = TYPE_LENGTH (type);
404 /* FIXME drow/2003-09-06: this call to the selected frame should be
405 pushed upwards to the callers. */
407 frame = deprecated_safe_get_selected_frame ();
409 switch (SYMBOL_CLASS (var))
412 /* Put the constant back in target format. */
413 store_signed_integer (VALUE_CONTENTS_RAW (v), len,
414 (LONGEST) SYMBOL_VALUE (var));
415 VALUE_LVAL (v) = not_lval;
419 /* Put the constant back in target format. */
420 if (overlay_debugging)
423 = symbol_overlayed_address (SYMBOL_VALUE_ADDRESS (var),
424 SYMBOL_BFD_SECTION (var));
425 store_typed_address (VALUE_CONTENTS_RAW (v), type, addr);
428 store_typed_address (VALUE_CONTENTS_RAW (v), type,
429 SYMBOL_VALUE_ADDRESS (var));
430 VALUE_LVAL (v) = not_lval;
433 case LOC_CONST_BYTES:
436 bytes_addr = SYMBOL_VALUE_BYTES (var);
437 memcpy (VALUE_CONTENTS_RAW (v), bytes_addr, len);
438 VALUE_LVAL (v) = not_lval;
443 if (overlay_debugging)
444 addr = symbol_overlayed_address (SYMBOL_VALUE_ADDRESS (var),
445 SYMBOL_BFD_SECTION (var));
447 addr = SYMBOL_VALUE_ADDRESS (var);
452 /* The import slot does not have a real address in it from the
453 dynamic loader (dld.sl on HP-UX), if the target hasn't
454 begun execution yet, so check for that. */
457 if (!target_has_execution)
459 Attempt to access variable defined in different shared object or load module when\n\
460 addresses have not been bound by the dynamic loader. Try again when executable is running.");
462 locaddr = SYMBOL_VALUE_ADDRESS (var);
463 loc = value_at (lookup_pointer_type (type), locaddr, NULL);
464 addr = value_as_address (loc);
470 addr = get_frame_args_address (frame);
473 addr += SYMBOL_VALUE (var);
482 argref = get_frame_args_address (frame);
485 argref += SYMBOL_VALUE (var);
486 ref = value_at (lookup_pointer_type (type), argref, NULL);
487 addr = value_as_address (ref);
495 addr = get_frame_locals_address (frame);
496 addr += SYMBOL_VALUE (var);
500 case LOC_BASEREG_ARG:
501 case LOC_HP_THREAD_LOCAL_STATIC:
503 struct value *regval;
505 regval = value_from_register (lookup_pointer_type (type),
506 SYMBOL_BASEREG (var), frame);
508 error ("Value of base register not available.");
509 addr = value_as_address (regval);
510 addr += SYMBOL_VALUE (var);
515 error ("Cannot look up value of a typedef");
519 if (overlay_debugging)
520 VALUE_ADDRESS (v) = symbol_overlayed_address
521 (BLOCK_START (SYMBOL_BLOCK_VALUE (var)), SYMBOL_BFD_SECTION (var));
523 VALUE_ADDRESS (v) = BLOCK_START (SYMBOL_BLOCK_VALUE (var));
528 case LOC_REGPARM_ADDR:
531 int regno = SYMBOL_VALUE (var);
532 struct value *regval;
536 b = get_frame_block (frame, 0);
538 if (SYMBOL_CLASS (var) == LOC_REGPARM_ADDR)
540 regval = value_from_register (lookup_pointer_type (type),
545 error ("Value of register variable not available.");
547 addr = value_as_address (regval);
548 VALUE_LVAL (v) = lval_memory;
552 regval = value_from_register (type, regno, frame);
555 error ("Value of register variable not available.");
562 case LOC_COMPUTED_ARG:
563 /* FIXME: cagney/2004-01-26: It should be possible to
564 unconditionally call the SYMBOL_OPS method when available.
565 Unfortunately DWARF 2 stores the frame-base (instead of the
566 function) location in a function's symbol. Oops! For the
567 moment enable this when/where applicable. */
568 if (frame == 0 && SYMBOL_OPS (var)->read_needs_frame (var))
570 return SYMBOL_OPS (var)->read_variable (var, frame);
574 struct minimal_symbol *msym;
576 msym = lookup_minimal_symbol (DEPRECATED_SYMBOL_NAME (var), NULL, NULL);
579 if (overlay_debugging)
580 addr = symbol_overlayed_address (SYMBOL_VALUE_ADDRESS (msym),
581 SYMBOL_BFD_SECTION (msym));
583 addr = SYMBOL_VALUE_ADDRESS (msym);
587 case LOC_OPTIMIZED_OUT:
588 VALUE_LVAL (v) = not_lval;
589 VALUE_OPTIMIZED_OUT (v) = 1;
593 error ("Cannot look up value of a botched symbol.");
597 VALUE_ADDRESS (v) = addr;
602 /* Return a value of type TYPE, stored in register REGNUM, in frame
605 NOTE: returns NULL if register value is not available.
606 Caller will check return value or die! */
609 value_from_register (struct type *type, int regnum, struct frame_info *frame)
611 struct gdbarch *gdbarch = get_frame_arch (frame);
612 struct value *v = allocate_value (type);
613 CHECK_TYPEDEF (type);
615 if (TYPE_LENGTH (type) == 0)
617 /* It doesn't matter much what we return for this: since the
618 length is zero, it could be anything. But if allowed to see
619 a zero-length type, the register-finding loop below will set
620 neither mem_stor nor reg_stor, and then report an internal
623 Zero-length types can legitimately arise from declarations
624 like 'struct {}' (a GCC extension, not valid ISO C). GDB may
625 also create them when it finds bogus debugging information;
626 for example, in GCC 2.95.4 and binutils 2.11.93.0.2, the
627 STABS BINCL->EXCL compression process can create bad type
628 numbers. GDB reads these as TYPE_CODE_UNDEF types, with zero
629 length. (That bug is actually the only known way to get a
630 zero-length value allocated to a register --- which is what
631 it takes to make it here.)
633 We'll just attribute the value to the original register. */
634 VALUE_LVAL (v) = lval_register;
635 VALUE_ADDRESS (v) = regnum;
636 VALUE_REGNO (v) = regnum;
638 else if (CONVERT_REGISTER_P (regnum, type))
640 /* The ISA/ABI need to something weird when obtaining the
641 specified value from this register. It might need to
642 re-order non-adjacent, starting with REGNUM (see MIPS and
643 i386). It might need to convert the [float] register into
644 the corresponding [integer] type (see Alpha). The assumption
645 is that REGISTER_TO_VALUE populates the entire value
646 including the location. */
647 REGISTER_TO_VALUE (frame, regnum, type, VALUE_CONTENTS_RAW (v));
648 VALUE_LVAL (v) = lval_reg_frame_relative;
649 VALUE_FRAME_ID (v) = get_frame_id (frame);
650 VALUE_FRAME_REGNUM (v) = regnum;
655 int mem_stor = 0, reg_stor = 0;
656 int mem_tracking = 1;
657 CORE_ADDR last_addr = 0;
658 CORE_ADDR first_addr = 0;
659 int first_realnum = regnum;
660 int len = TYPE_LENGTH (type);
661 int value_bytes_copied;
663 char *value_bytes = (char *) alloca (len + MAX_REGISTER_SIZE);
665 /* Copy all of the data out, whereever it may be. */
666 for (local_regnum = regnum, value_bytes_copied = 0;
667 value_bytes_copied < len;
668 (value_bytes_copied += DEPRECATED_REGISTER_RAW_SIZE (local_regnum),
675 frame_register (frame, local_regnum, &optim, &lval, &addr,
676 &realnum, value_bytes + value_bytes_copied);
678 if (register_cached (local_regnum) == -1)
679 return NULL; /* register value not available */
681 if (regnum == local_regnum)
684 first_realnum = realnum;
686 if (lval == lval_register)
692 mem_tracking = (mem_tracking
693 && (regnum == local_regnum
694 || addr == last_addr));
699 /* FIXME: cagney/2003-06-04: Shouldn't this always use
700 lval_reg_frame_relative? If it doesn't and the register's
701 location changes (say after a resume) then this value is
702 going to have wrong information. */
703 if ((reg_stor && mem_stor)
704 || (mem_stor && !mem_tracking))
705 /* Mixed storage; all of the hassle we just went through was
706 for some good purpose. */
708 VALUE_LVAL (v) = lval_reg_frame_relative;
709 VALUE_FRAME_ID (v) = get_frame_id (frame);
710 VALUE_FRAME_REGNUM (v) = regnum;
714 VALUE_LVAL (v) = lval_memory;
715 VALUE_ADDRESS (v) = first_addr;
719 VALUE_LVAL (v) = lval_register;
720 VALUE_ADDRESS (v) = first_addr;
721 VALUE_REGNO (v) = first_realnum;
724 internal_error (__FILE__, __LINE__,
725 "value_from_register: Value not stored anywhere!");
727 VALUE_OPTIMIZED_OUT (v) = optimized;
729 /* Any structure stored in more than one register will always be
730 an integral number of registers. Otherwise, you need to do
731 some fiddling with the last register copied here for little
733 if (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG
734 && len < DEPRECATED_REGISTER_RAW_SIZE (regnum))
735 /* Big-endian, and we want less than full size. */
736 VALUE_OFFSET (v) = DEPRECATED_REGISTER_RAW_SIZE (regnum) - len;
738 VALUE_OFFSET (v) = 0;
739 memcpy (VALUE_CONTENTS_RAW (v), value_bytes + VALUE_OFFSET (v), len);
745 /* Given a struct symbol for a variable or function,
746 and a stack frame id,
747 return a (pointer to a) struct value containing the properly typed
751 locate_var_value (struct symbol *var, struct frame_info *frame)
754 struct type *type = SYMBOL_TYPE (var);
755 struct value *lazy_value;
757 /* Evaluate it first; if the result is a memory address, we're fine.
758 Lazy evaluation pays off here. */
760 lazy_value = read_var_value (var, frame);
762 error ("Address of \"%s\" is unknown.", SYMBOL_PRINT_NAME (var));
764 if (VALUE_LAZY (lazy_value)
765 || TYPE_CODE (type) == TYPE_CODE_FUNC)
769 addr = VALUE_ADDRESS (lazy_value);
770 val = value_from_pointer (lookup_pointer_type (type), addr);
771 VALUE_BFD_SECTION (val) = VALUE_BFD_SECTION (lazy_value);
775 /* Not a memory address; check what the problem was. */
776 switch (VALUE_LVAL (lazy_value))
779 gdb_assert (REGISTER_NAME (VALUE_REGNO (lazy_value)) != NULL
780 && *REGISTER_NAME (VALUE_REGNO (lazy_value)) != '\0');
781 error("Address requested for identifier "
782 "\"%s\" which is in register $%s",
783 SYMBOL_PRINT_NAME (var),
784 REGISTER_NAME (VALUE_REGNO (lazy_value)));
787 case lval_reg_frame_relative:
788 gdb_assert (REGISTER_NAME (VALUE_FRAME_REGNUM (lazy_value)) != NULL
789 && *REGISTER_NAME (VALUE_FRAME_REGNUM (lazy_value)) != '\0');
790 error("Address requested for identifier "
791 "\"%s\" which is in frame register $%s",
792 SYMBOL_PRINT_NAME (var),
793 REGISTER_NAME (VALUE_FRAME_REGNUM (lazy_value)));
797 error ("Can't take address of \"%s\" which isn't an lvalue.",
798 SYMBOL_PRINT_NAME (var));
801 return 0; /* For lint -- never reached */