1 /* Cache and manage frames for GDB, the GNU debugger.
3 Copyright 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000,
4 2001, 2002, 2003 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
27 #include "inferior.h" /* for inferior_ptid */
29 #include "gdb_assert.h"
30 #include "gdb_string.h"
31 #include "user-regs.h"
32 #include "gdb_obstack.h"
33 #include "dummy-frame.h"
34 #include "sentinel-frame.h"
38 #include "frame-unwind.h"
39 #include "frame-base.h"
43 /* We keep a cache of stack frames, each of which is a "struct
44 frame_info". The innermost one gets allocated (in
45 wait_for_inferior) each time the inferior stops; current_frame
46 points to it. Additional frames get allocated (in get_prev_frame)
47 as needed, and are chained through the next and prev fields. Any
48 time that the frame cache becomes invalid (most notably when we
49 execute something, but also if we change how we interpret the
50 frames (e.g. "set heuristic-fence-post" in mips-tdep.c, or anything
51 which reads new symbols)), we should call reinit_frame_cache. */
55 /* Level of this frame. The inner-most (youngest) frame is at level
56 0. As you move towards the outer-most (oldest) frame, the level
57 increases. This is a cached value. It could just as easily be
58 computed by counting back from the selected frame to the inner
60 /* NOTE: cagney/2002-04-05: Perhaphs a level of ``-1'' should be
61 reserved to indicate a bogus frame - one that has been created
62 just to keep GDB happy (GDB always needs a frame). For the
63 moment leave this as speculation. */
66 /* The frame's type. */
67 /* FIXME: cagney/2003-04-02: Should instead be returning
68 ->unwind->type. Unfortunatly, legacy code is still explicitly
69 setting the type using the method deprecated_set_frame_type.
70 Eliminate that method and this field can be eliminated. */
73 /* For each register, address of where it was saved on entry to the
74 frame, or zero if it was not saved on entry to this frame. This
75 includes special registers such as pc and fp saved in special
76 ways in the stack frame. The SP_REGNUM is even more special, the
77 address here is the sp for the previous frame, not the address
78 where the sp was saved. */
79 /* Allocated by frame_saved_regs_zalloc () which is called /
80 initialized by DEPRECATED_FRAME_INIT_SAVED_REGS(). */
81 CORE_ADDR
*saved_regs
; /*NUM_REGS + NUM_PSEUDO_REGS*/
83 /* Anything extra for this structure that may have been defined in
84 the machine dependent files. */
85 /* Allocated by frame_extra_info_zalloc () which is called /
86 initialized by DEPRECATED_INIT_EXTRA_FRAME_INFO */
87 struct frame_extra_info
*extra_info
;
89 /* If dwarf2 unwind frame informations is used, this structure holds
90 all related unwind data. */
91 struct context
*context
;
93 /* The frame's low-level unwinder and corresponding cache. The
94 low-level unwinder is responsible for unwinding register values
95 for the previous frame. The low-level unwind methods are
96 selected based on the presence, or otherwize, of register unwind
97 information such as CFI. */
99 const struct frame_unwind
*unwind
;
101 /* Cached copy of the previous frame's resume address. */
107 /* Cached copy of the previous frame's function address. */
114 /* This frame's ID. */
118 struct frame_id value
;
121 /* The frame's high-level base methods, and corresponding cache.
122 The high level base methods are selected based on the frame's
124 const struct frame_base
*base
;
127 /* Pointers to the next (down, inner, younger) and previous (up,
128 outer, older) frame_info's in the frame cache. */
129 struct frame_info
*next
; /* down, inner, younger */
131 struct frame_info
*prev
; /* up, outer, older */
134 /* Flag to control debugging. */
136 static int frame_debug
;
138 /* Flag to indicate whether backtraces should stop at main. */
140 static int backtrace_below_main
;
143 fprint_frame_id (struct ui_file
*file
, struct frame_id id
)
145 fprintf_unfiltered (file
, "{stack=0x%s,code=0x%s}",
146 paddr_nz (id
.stack_addr
),
147 paddr_nz (id
.code_addr
));
151 fprint_frame_type (struct ui_file
*file
, enum frame_type type
)
156 fprintf_unfiltered (file
, "UNKNOWN_FRAME");
159 fprintf_unfiltered (file
, "NORMAL_FRAME");
162 fprintf_unfiltered (file
, "DUMMY_FRAME");
165 fprintf_unfiltered (file
, "SIGTRAMP_FRAME");
168 fprintf_unfiltered (file
, "<unknown type>");
174 fprint_frame (struct ui_file
*file
, struct frame_info
*fi
)
178 fprintf_unfiltered (file
, "<NULL frame>");
181 fprintf_unfiltered (file
, "{");
182 fprintf_unfiltered (file
, "level=%d", fi
->level
);
183 fprintf_unfiltered (file
, ",");
184 fprintf_unfiltered (file
, "type=");
185 fprint_frame_type (file
, fi
->type
);
186 fprintf_unfiltered (file
, ",");
187 fprintf_unfiltered (file
, "unwind=");
188 if (fi
->unwind
!= NULL
)
189 gdb_print_host_address (fi
->unwind
, file
);
191 fprintf_unfiltered (file
, "<unknown>");
192 fprintf_unfiltered (file
, ",");
193 fprintf_unfiltered (file
, "pc=");
194 if (fi
->next
!= NULL
&& fi
->next
->prev_pc
.p
)
195 fprintf_unfiltered (file
, "0x%s", paddr_nz (fi
->next
->prev_pc
.value
));
197 fprintf_unfiltered (file
, "<unknown>");
198 fprintf_unfiltered (file
, ",");
199 fprintf_unfiltered (file
, "id=");
201 fprint_frame_id (file
, fi
->this_id
.value
);
203 fprintf_unfiltered (file
, "<unknown>");
204 fprintf_unfiltered (file
, ",");
205 fprintf_unfiltered (file
, "func=");
206 if (fi
->next
!= NULL
&& fi
->next
->prev_func
.p
)
207 fprintf_unfiltered (file
, "0x%s", paddr_nz (fi
->next
->prev_func
.addr
));
209 fprintf_unfiltered (file
, "<unknown>");
210 fprintf_unfiltered (file
, "}");
213 /* Return a frame uniq ID that can be used to, later, re-find the
217 get_frame_id (struct frame_info
*fi
)
221 return null_frame_id
;
225 gdb_assert (!legacy_frame_p (current_gdbarch
));
227 fprintf_unfiltered (gdb_stdlog
, "{ get_frame_id (fi=%d) ",
229 /* Find the unwinder. */
230 if (fi
->unwind
== NULL
)
232 fi
->unwind
= frame_unwind_find_by_pc (current_gdbarch
,
234 /* FIXME: cagney/2003-04-02: Rather than storing the frame's
235 type in the frame, the unwinder's type should be returned
236 directly. Unfortunatly, legacy code, called by
237 legacy_get_prev_frame, explicitly set the frames type
238 using the method deprecated_set_frame_type(). */
239 gdb_assert (fi
->unwind
->type
!= UNKNOWN_FRAME
);
240 fi
->type
= fi
->unwind
->type
;
242 /* Find THIS frame's ID. */
243 fi
->unwind
->this_id (fi
->next
, &fi
->prologue_cache
, &fi
->this_id
.value
);
247 fprintf_unfiltered (gdb_stdlog
, "-> ");
248 fprint_frame_id (gdb_stdlog
, fi
->this_id
.value
);
249 fprintf_unfiltered (gdb_stdlog
, " }\n");
252 return fi
->this_id
.value
;
255 const struct frame_id null_frame_id
; /* All zeros. */
258 frame_id_build (CORE_ADDR stack_addr
, CORE_ADDR code_addr
)
261 id
.stack_addr
= stack_addr
;
262 id
.code_addr
= code_addr
;
267 frame_id_p (struct frame_id l
)
270 /* The .code can be NULL but the .stack cannot. */
271 p
= (l
.stack_addr
!= 0);
274 fprintf_unfiltered (gdb_stdlog
, "{ frame_id_p (l=");
275 fprint_frame_id (gdb_stdlog
, l
);
276 fprintf_unfiltered (gdb_stdlog
, ") -> %d }\n", p
);
282 frame_id_eq (struct frame_id l
, struct frame_id r
)
285 if (l
.stack_addr
== 0 || r
.stack_addr
== 0)
286 /* Like a NaN, if either ID is invalid, the result is false. */
288 else if (l
.stack_addr
!= r
.stack_addr
)
289 /* If .stack addresses are different, the frames are different. */
291 else if (l
.code_addr
== 0 || r
.code_addr
== 0)
292 /* A zero code addr is a wild card, always succeed. */
294 else if (l
.code_addr
== r
.code_addr
)
295 /* The .stack and .code are identical, the ID's are identical. */
302 fprintf_unfiltered (gdb_stdlog
, "{ frame_id_eq (l=");
303 fprint_frame_id (gdb_stdlog
, l
);
304 fprintf_unfiltered (gdb_stdlog
, ",r=");
305 fprint_frame_id (gdb_stdlog
, r
);
306 fprintf_unfiltered (gdb_stdlog
, ") -> %d }\n", eq
);
312 frame_id_inner (struct frame_id l
, struct frame_id r
)
315 if (l
.stack_addr
== 0 || r
.stack_addr
== 0)
316 /* Like NaN, any operation involving an invalid ID always fails. */
319 /* Only return non-zero when strictly inner than. Note that, per
320 comment in "frame.h", there is some fuzz here. Frameless
321 functions are not strictly inner than (same .stack but
323 inner
= INNER_THAN (l
.stack_addr
, r
.stack_addr
);
326 fprintf_unfiltered (gdb_stdlog
, "{ frame_id_inner (l=");
327 fprint_frame_id (gdb_stdlog
, l
);
328 fprintf_unfiltered (gdb_stdlog
, ",r=");
329 fprint_frame_id (gdb_stdlog
, r
);
330 fprintf_unfiltered (gdb_stdlog
, ") -> %d }\n", inner
);
336 frame_find_by_id (struct frame_id id
)
338 struct frame_info
*frame
;
340 /* ZERO denotes the null frame, let the caller decide what to do
341 about it. Should it instead return get_current_frame()? */
342 if (!frame_id_p (id
))
345 for (frame
= get_current_frame ();
347 frame
= get_prev_frame (frame
))
349 struct frame_id
this = get_frame_id (frame
);
350 if (frame_id_eq (id
, this))
351 /* An exact match. */
353 if (frame_id_inner (id
, this))
356 /* Either, we're not yet gone far enough out along the frame
357 chain (inner(this,id), or we're comparing frameless functions
358 (same .base, different .func, no test available). Struggle
359 on until we've definitly gone to far. */
365 frame_pc_unwind (struct frame_info
*this_frame
)
367 if (!this_frame
->prev_pc
.p
)
370 if (gdbarch_unwind_pc_p (current_gdbarch
))
372 /* The right way. The `pure' way. The one true way. This
373 method depends solely on the register-unwind code to
374 determine the value of registers in THIS frame, and hence
375 the value of this frame's PC (resume address). A typical
376 implementation is no more than:
378 frame_unwind_register (this_frame, ISA_PC_REGNUM, buf);
379 return extract_unsigned_integer (buf, size of ISA_PC_REGNUM);
381 Note: this method is very heavily dependent on a correct
382 register-unwind implementation, it pays to fix that
383 method first; this method is frame type agnostic, since
384 it only deals with register values, it works with any
385 frame. This is all in stark contrast to the old
386 FRAME_SAVED_PC which would try to directly handle all the
387 different ways that a PC could be unwound. */
388 pc
= gdbarch_unwind_pc (current_gdbarch
, this_frame
);
390 else if (this_frame
->level
< 0)
392 /* FIXME: cagney/2003-03-06: Old code and and a sentinel
393 frame. Do like was always done. Fetch the PC's value
394 direct from the global registers array (via read_pc).
395 This assumes that this frame belongs to the current
396 global register cache. The assumption is dangerous. */
399 else if (DEPRECATED_FRAME_SAVED_PC_P ())
401 /* FIXME: cagney/2003-03-06: Old code, but not a sentinel
402 frame. Do like was always done. Note that this method,
403 unlike unwind_pc(), tries to handle all the different
404 frame cases directly. It fails. */
405 pc
= DEPRECATED_FRAME_SAVED_PC (this_frame
);
408 internal_error (__FILE__
, __LINE__
, "No gdbarch_unwind_pc method");
409 this_frame
->prev_pc
.value
= pc
;
410 this_frame
->prev_pc
.p
= 1;
412 fprintf_unfiltered (gdb_stdlog
,
413 "{ frame_pc_unwind (this_frame=%d) -> 0x%s }\n",
415 paddr_nz (this_frame
->prev_pc
.value
));
417 return this_frame
->prev_pc
.value
;
421 frame_func_unwind (struct frame_info
*fi
)
423 if (!fi
->prev_func
.p
)
426 fi
->prev_func
.addr
= get_pc_function_start (frame_pc_unwind (fi
));
428 fprintf_unfiltered (gdb_stdlog
,
429 "{ frame_func_unwind (fi=%d) -> 0x%s }\n",
430 fi
->level
, paddr_nz (fi
->prev_func
.addr
));
432 return fi
->prev_func
.addr
;
436 get_frame_func (struct frame_info
*fi
)
438 return frame_func_unwind (fi
->next
);
442 do_frame_unwind_register (void *src
, int regnum
, void *buf
)
444 frame_unwind_register (src
, regnum
, buf
);
449 frame_pop (struct frame_info
*this_frame
)
451 struct regcache
*scratch_regcache
;
452 struct cleanup
*cleanups
;
454 if (DEPRECATED_POP_FRAME_P ())
456 /* A legacy architecture that has implemented a custom pop
457 function. All new architectures should instead be using the
458 generic code below. */
459 DEPRECATED_POP_FRAME
;
463 /* Make a copy of all the register values unwound from this
464 frame. Save them in a scratch buffer so that there isn't a
465 race betweening trying to extract the old values from the
466 current_regcache while, at the same time writing new values
467 into that same cache. */
468 struct regcache
*scratch
= regcache_xmalloc (current_gdbarch
);
469 struct cleanup
*cleanups
= make_cleanup_regcache_xfree (scratch
);
470 regcache_save (scratch
, do_frame_unwind_register
, this_frame
);
471 /* FIXME: cagney/2003-03-16: It should be possible to tell the
472 target's register cache that it is about to be hit with a
473 burst register transfer and that the sequence of register
474 writes should be batched. The pair target_prepare_to_store()
475 and target_store_registers() kind of suggest this
476 functionality. Unfortunatly, they don't implement it. Their
477 lack of a formal definition can lead to targets writing back
478 bogus values (arguably a bug in the target code mind). */
479 /* Now copy those saved registers into the current regcache.
480 Here, regcache_cpy() calls regcache_restore(). */
481 regcache_cpy (current_regcache
, scratch
);
482 do_cleanups (cleanups
);
484 /* We've made right mess of GDB's local state, just discard
486 flush_cached_frames ();
490 frame_register_unwind (struct frame_info
*frame
, int regnum
,
491 int *optimizedp
, enum lval_type
*lvalp
,
492 CORE_ADDR
*addrp
, int *realnump
, void *bufferp
)
494 struct frame_unwind_cache
*cache
;
498 fprintf_unfiltered (gdb_stdlog
,
499 "{ frame_register_unwind (frame=%d,regnum=\"%s\",...) ",
500 frame
->level
, frame_map_regnum_to_name (frame
, regnum
));
503 /* Require all but BUFFERP to be valid. A NULL BUFFERP indicates
504 that the value proper does not need to be fetched. */
505 gdb_assert (optimizedp
!= NULL
);
506 gdb_assert (lvalp
!= NULL
);
507 gdb_assert (addrp
!= NULL
);
508 gdb_assert (realnump
!= NULL
);
509 /* gdb_assert (bufferp != NULL); */
511 /* NOTE: cagney/2002-11-27: A program trying to unwind a NULL frame
512 is broken. There is always a frame. If there, for some reason,
513 isn't, there is some pretty busted code as it should have
514 detected the problem before calling here. */
515 gdb_assert (frame
!= NULL
);
517 /* Find the unwinder. */
518 if (frame
->unwind
== NULL
)
520 frame
->unwind
= frame_unwind_find_by_pc (current_gdbarch
,
521 get_frame_pc (frame
));
522 /* FIXME: cagney/2003-04-02: Rather than storing the frame's
523 type in the frame, the unwinder's type should be returned
524 directly. Unfortunatly, legacy code, called by
525 legacy_get_prev_frame, explicitly set the frames type using
526 the method deprecated_set_frame_type(). */
527 gdb_assert (frame
->unwind
->type
!= UNKNOWN_FRAME
);
528 frame
->type
= frame
->unwind
->type
;
531 /* Ask this frame to unwind its register. See comment in
532 "frame-unwind.h" for why NEXT frame and this unwind cace are
534 frame
->unwind
->prev_register (frame
->next
, &frame
->prologue_cache
, regnum
,
535 optimizedp
, lvalp
, addrp
, realnump
, bufferp
);
539 fprintf_unfiltered (gdb_stdlog
, "->");
540 fprintf_unfiltered (gdb_stdlog
, " *optimizedp=%d", (*optimizedp
));
541 fprintf_unfiltered (gdb_stdlog
, " *lvalp=%d", (int) (*lvalp
));
542 fprintf_unfiltered (gdb_stdlog
, " *addrp=0x%s", paddr_nz ((*addrp
)));
543 fprintf_unfiltered (gdb_stdlog
, " *bufferp=");
545 fprintf_unfiltered (gdb_stdlog
, "<NULL>");
549 const unsigned char *buf
= bufferp
;
550 fprintf_unfiltered (gdb_stdlog
, "[");
551 for (i
= 0; i
< register_size (current_gdbarch
, regnum
); i
++)
552 fprintf_unfiltered (gdb_stdlog
, "%02x", buf
[i
]);
553 fprintf_unfiltered (gdb_stdlog
, "]");
555 fprintf_unfiltered (gdb_stdlog
, " }\n");
560 frame_register (struct frame_info
*frame
, int regnum
,
561 int *optimizedp
, enum lval_type
*lvalp
,
562 CORE_ADDR
*addrp
, int *realnump
, void *bufferp
)
564 /* Require all but BUFFERP to be valid. A NULL BUFFERP indicates
565 that the value proper does not need to be fetched. */
566 gdb_assert (optimizedp
!= NULL
);
567 gdb_assert (lvalp
!= NULL
);
568 gdb_assert (addrp
!= NULL
);
569 gdb_assert (realnump
!= NULL
);
570 /* gdb_assert (bufferp != NULL); */
572 /* Ulgh! Old code that, for lval_register, sets ADDRP to the offset
573 of the register in the register cache. It should instead return
574 the REGNUM corresponding to that register. Translate the . */
575 if (DEPRECATED_GET_SAVED_REGISTER_P ())
577 DEPRECATED_GET_SAVED_REGISTER (bufferp
, optimizedp
, addrp
, frame
,
579 /* Compute the REALNUM if the caller wants it. */
580 if (*lvalp
== lval_register
)
583 for (regnum
= 0; regnum
< NUM_REGS
+ NUM_PSEUDO_REGS
; regnum
++)
585 if (*addrp
== register_offset_hack (current_gdbarch
, regnum
))
591 internal_error (__FILE__
, __LINE__
,
592 "Failed to compute the register number corresponding"
593 " to 0x%s", paddr_d (*addrp
));
599 /* Obtain the register value by unwinding the register from the next
600 (more inner frame). */
601 gdb_assert (frame
!= NULL
&& frame
->next
!= NULL
);
602 frame_register_unwind (frame
->next
, regnum
, optimizedp
, lvalp
, addrp
,
607 frame_unwind_register (struct frame_info
*frame
, int regnum
, void *buf
)
613 frame_register_unwind (frame
, regnum
, &optimized
, &lval
, &addr
,
618 get_frame_register (struct frame_info
*frame
,
619 int regnum
, void *buf
)
621 frame_unwind_register (frame
->next
, regnum
, buf
);
625 frame_unwind_register_signed (struct frame_info
*frame
, int regnum
)
627 char buf
[MAX_REGISTER_SIZE
];
628 frame_unwind_register (frame
, regnum
, buf
);
629 return extract_signed_integer (buf
, REGISTER_VIRTUAL_SIZE (regnum
));
633 get_frame_register_signed (struct frame_info
*frame
, int regnum
)
635 return frame_unwind_register_signed (frame
->next
, regnum
);
639 frame_unwind_register_unsigned (struct frame_info
*frame
, int regnum
)
641 char buf
[MAX_REGISTER_SIZE
];
642 frame_unwind_register (frame
, regnum
, buf
);
643 return extract_unsigned_integer (buf
, REGISTER_VIRTUAL_SIZE (regnum
));
647 get_frame_register_unsigned (struct frame_info
*frame
, int regnum
)
649 return frame_unwind_register_unsigned (frame
->next
, regnum
);
653 frame_unwind_signed_register (struct frame_info
*frame
, int regnum
,
656 char buf
[MAX_REGISTER_SIZE
];
657 frame_unwind_register (frame
, regnum
, buf
);
658 (*val
) = extract_signed_integer (buf
, REGISTER_VIRTUAL_SIZE (regnum
));
662 frame_unwind_unsigned_register (struct frame_info
*frame
, int regnum
,
665 char buf
[MAX_REGISTER_SIZE
];
666 frame_unwind_register (frame
, regnum
, buf
);
667 (*val
) = extract_unsigned_integer (buf
, REGISTER_VIRTUAL_SIZE (regnum
));
671 frame_read_register (struct frame_info
*frame
, int regnum
, void *buf
)
673 gdb_assert (frame
!= NULL
&& frame
->next
!= NULL
);
674 frame_unwind_register (frame
->next
, regnum
, buf
);
678 frame_read_unsigned_register (struct frame_info
*frame
, int regnum
,
681 /* NOTE: cagney/2002-10-31: There is a bit of dogma here - there is
682 always a frame. Both this, and the equivalent
683 frame_read_signed_register() function, can only be called with a
684 valid frame. If, for some reason, this function is called
685 without a frame then the problem isn't here, but rather in the
686 caller. It should of first created a frame and then passed that
688 /* NOTE: cagney/2002-10-31: As a side bar, keep in mind that the
689 ``current_frame'' should not be treated as a special case. While
690 ``get_next_frame (current_frame) == NULL'' currently holds, it
691 should, as far as possible, not be relied upon. In the future,
692 ``get_next_frame (current_frame)'' may instead simply return a
693 normal frame object that simply always gets register values from
694 the register cache. Consequently, frame code should try to avoid
695 tests like ``if get_next_frame() == NULL'' and instead just rely
696 on recursive frame calls (like the below code) when manipulating
698 gdb_assert (frame
!= NULL
&& frame
->next
!= NULL
);
699 frame_unwind_unsigned_register (frame
->next
, regnum
, val
);
703 frame_read_signed_register (struct frame_info
*frame
, int regnum
,
706 /* See note above in frame_read_unsigned_register(). */
707 gdb_assert (frame
!= NULL
&& frame
->next
!= NULL
);
708 frame_unwind_signed_register (frame
->next
, regnum
, val
);
712 put_frame_register (struct frame_info
*frame
, int regnum
, const void *buf
)
714 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
719 frame_register (frame
, regnum
, &optim
, &lval
, &addr
, &realnum
, NULL
);
721 error ("Attempt to assign to a value that was optimized out.");
726 /* FIXME: write_memory doesn't yet take constant buffers.
728 char tmp
[MAX_REGISTER_SIZE
];
729 memcpy (tmp
, buf
, register_size (gdbarch
, regnum
));
730 write_memory (addr
, tmp
, register_size (gdbarch
, regnum
));
734 regcache_cooked_write (current_regcache
, realnum
, buf
);
737 error ("Attempt to assign to an unmodifiable value.");
741 /* frame_register_read ()
743 Find and return the value of REGNUM for the specified stack frame.
744 The number of bytes copied is REGISTER_RAW_SIZE (REGNUM).
746 Returns 0 if the register value could not be found. */
749 frame_register_read (struct frame_info
*frame
, int regnum
, void *myaddr
)
755 frame_register (frame
, regnum
, &optimized
, &lval
, &addr
, &realnum
, myaddr
);
757 /* FIXME: cagney/2002-05-15: This test, is just bogus.
759 It indicates that the target failed to supply a value for a
760 register because it was "not available" at this time. Problem
761 is, the target still has the register and so get saved_register()
762 may be returning a value saved on the stack. */
764 if (register_cached (regnum
) < 0)
765 return 0; /* register value not available */
771 /* Map between a frame register number and its name. A frame register
772 space is a superset of the cooked register space --- it also
773 includes builtin registers. */
776 frame_map_name_to_regnum (struct frame_info
*frame
, const char *name
, int len
)
778 return user_reg_map_name_to_regnum (get_frame_arch (frame
), name
, len
);
782 frame_map_regnum_to_name (struct frame_info
*frame
, int regnum
)
784 return user_reg_map_regnum_to_name (get_frame_arch (frame
), regnum
);
787 /* Create a sentinel frame. */
789 static struct frame_info
*
790 create_sentinel_frame (struct regcache
*regcache
)
792 struct frame_info
*frame
= FRAME_OBSTACK_ZALLOC (struct frame_info
);
793 frame
->type
= NORMAL_FRAME
;
795 /* Explicitly initialize the sentinel frame's cache. Provide it
796 with the underlying regcache. In the future additional
797 information, such as the frame's thread will be added. */
798 frame
->prologue_cache
= sentinel_frame_cache (regcache
);
799 /* For the moment there is only one sentinel frame implementation. */
800 frame
->unwind
= sentinel_frame_unwind
;
801 /* Link this frame back to itself. The frame is self referential
802 (the unwound PC is the same as the pc), so make it so. */
804 /* Make the sentinel frame's ID valid, but invalid. That way all
805 comparisons with it should fail. */
806 frame
->this_id
.p
= 1;
807 frame
->this_id
.value
= null_frame_id
;
810 fprintf_unfiltered (gdb_stdlog
, "{ create_sentinel_frame (...) -> ");
811 fprint_frame (gdb_stdlog
, frame
);
812 fprintf_unfiltered (gdb_stdlog
, " }\n");
817 /* Info about the innermost stack frame (contents of FP register) */
819 static struct frame_info
*current_frame
;
821 /* Cache for frame addresses already read by gdb. Valid only while
822 inferior is stopped. Control variables for the frame cache should
823 be local to this module. */
825 static struct obstack frame_cache_obstack
;
828 frame_obstack_zalloc (unsigned long size
)
830 void *data
= obstack_alloc (&frame_cache_obstack
, size
);
831 memset (data
, 0, size
);
836 frame_saved_regs_zalloc (struct frame_info
*fi
)
838 fi
->saved_regs
= (CORE_ADDR
*)
839 frame_obstack_zalloc (SIZEOF_FRAME_SAVED_REGS
);
840 return fi
->saved_regs
;
844 get_frame_saved_regs (struct frame_info
*fi
)
846 return fi
->saved_regs
;
849 /* Return the innermost (currently executing) stack frame. This is
850 split into two functions. The function unwind_to_current_frame()
851 is wrapped in catch exceptions so that, even when the unwind of the
852 sentinel frame fails, the function still returns a stack frame. */
855 unwind_to_current_frame (struct ui_out
*ui_out
, void *args
)
857 struct frame_info
*frame
= get_prev_frame (args
);
858 /* A sentinel frame can fail to unwind, eg, because it's PC value
859 lands in somewhere like start. */
862 current_frame
= frame
;
867 get_current_frame (void)
869 /* First check, and report, the lack of registers. Having GDB
870 report "No stack!" or "No memory" when the target doesn't even
871 have registers is very confusing. Besides, "printcmd.exp"
872 explicitly checks that ``print $pc'' with no registers prints "No
874 if (!target_has_registers
)
875 error ("No registers.");
876 if (!target_has_stack
)
878 if (!target_has_memory
)
879 error ("No memory.");
880 if (current_frame
== NULL
)
882 struct frame_info
*sentinel_frame
=
883 create_sentinel_frame (current_regcache
);
884 if (catch_exceptions (uiout
, unwind_to_current_frame
, sentinel_frame
,
885 NULL
, RETURN_MASK_ERROR
) != 0)
887 /* Oops! Fake a current frame? Is this useful? It has a PC
888 of zero, for instance. */
889 current_frame
= sentinel_frame
;
892 return current_frame
;
895 /* The "selected" stack frame is used by default for local and arg
896 access. May be zero, for no selected frame. */
898 struct frame_info
*deprecated_selected_frame
;
900 /* Return the selected frame. Always non-null (unless there isn't an
901 inferior sufficient for creating a frame) in which case an error is
905 get_selected_frame (void)
907 if (deprecated_selected_frame
== NULL
)
908 /* Hey! Don't trust this. It should really be re-finding the
909 last selected frame of the currently selected thread. This,
910 though, is better than nothing. */
911 select_frame (get_current_frame ());
912 /* There is always a frame. */
913 gdb_assert (deprecated_selected_frame
!= NULL
);
914 return deprecated_selected_frame
;
917 /* Select frame FI (or NULL - to invalidate the current frame). */
920 select_frame (struct frame_info
*fi
)
922 register struct symtab
*s
;
924 deprecated_selected_frame
= fi
;
925 /* NOTE: cagney/2002-05-04: FI can be NULL. This occures when the
926 frame is being invalidated. */
927 if (selected_frame_level_changed_hook
)
928 selected_frame_level_changed_hook (frame_relative_level (fi
));
930 /* FIXME: kseitz/2002-08-28: It would be nice to call
931 selected_frame_level_changed_event right here, but due to limitations
932 in the current interfaces, we would end up flooding UIs with events
933 because select_frame is used extensively internally.
935 Once we have frame-parameterized frame (and frame-related) commands,
936 the event notification can be moved here, since this function will only
937 be called when the users selected frame is being changed. */
939 /* Ensure that symbols for this frame are read in. Also, determine the
940 source language of this frame, and switch to it if desired. */
943 s
= find_pc_symtab (get_frame_pc (fi
));
945 && s
->language
!= current_language
->la_language
946 && s
->language
!= language_unknown
947 && language_mode
== language_mode_auto
)
949 set_language (s
->language
);
954 /* Return the register saved in the simplistic ``saved_regs'' cache.
955 If the value isn't here AND a value is needed, try the next inner
959 legacy_saved_regs_prev_register (struct frame_info
*next_frame
,
960 void **this_prologue_cache
,
961 int regnum
, int *optimizedp
,
962 enum lval_type
*lvalp
, CORE_ADDR
*addrp
,
963 int *realnump
, void *bufferp
)
965 /* HACK: New code is passed the next frame and this cache.
966 Unfortunatly, old code expects this frame. Since this is a
967 backward compatibility hack, cheat by walking one level along the
968 prologue chain to the frame the old code expects.
970 Do not try this at home. Professional driver, closed course. */
971 struct frame_info
*frame
= next_frame
->prev
;
972 gdb_assert (frame
!= NULL
);
974 if (get_frame_saved_regs (frame
) == NULL
)
976 /* If nothing's initialized the saved regs, do it now. */
977 gdb_assert (DEPRECATED_FRAME_INIT_SAVED_REGS_P ());
978 DEPRECATED_FRAME_INIT_SAVED_REGS (frame
);
979 gdb_assert (get_frame_saved_regs (frame
) != NULL
);
982 if (get_frame_saved_regs (frame
) != NULL
983 && get_frame_saved_regs (frame
)[regnum
] != 0)
985 if (regnum
== SP_REGNUM
)
987 /* SP register treated specially. */
993 /* NOTE: cagney/2003-05-09: In-lined store_address with
994 it's body - store_unsigned_integer. */
995 store_unsigned_integer (bufferp
, REGISTER_RAW_SIZE (regnum
),
996 get_frame_saved_regs (frame
)[regnum
]);
1000 /* Any other register is saved in memory, fetch it but cache
1001 a local copy of its value. */
1003 *lvalp
= lval_memory
;
1004 *addrp
= get_frame_saved_regs (frame
)[regnum
];
1006 if (bufferp
!= NULL
)
1009 /* Save each register value, as it is read in, in a
1010 frame based cache. */
1011 void **regs
= (*this_prologue_cache
);
1014 int sizeof_cache
= ((NUM_REGS
+ NUM_PSEUDO_REGS
)
1016 regs
= frame_obstack_zalloc (sizeof_cache
);
1017 (*this_prologue_cache
) = regs
;
1019 if (regs
[regnum
] == NULL
)
1022 = frame_obstack_zalloc (REGISTER_RAW_SIZE (regnum
));
1023 read_memory (get_frame_saved_regs (frame
)[regnum
], regs
[regnum
],
1024 REGISTER_RAW_SIZE (regnum
));
1026 memcpy (bufferp
, regs
[regnum
], REGISTER_RAW_SIZE (regnum
));
1028 /* Read the value in from memory. */
1029 read_memory (get_frame_saved_regs (frame
)[regnum
], bufferp
,
1030 REGISTER_RAW_SIZE (regnum
));
1037 /* No luck. Assume this and the next frame have the same register
1038 value. Pass the unwind request down the frame chain to the next
1039 frame. Hopefully that frame will find the register's location. */
1040 frame_register_unwind (next_frame
, regnum
, optimizedp
, lvalp
, addrp
,
1045 legacy_saved_regs_this_id (struct frame_info
*next_frame
,
1046 void **this_prologue_cache
,
1047 struct frame_id
*id
)
1049 /* legacy_get_prev_frame() always sets ->this_id.p, hence this is
1051 internal_error (__FILE__
, __LINE__
, "legacy_saved_regs_this_id() called");
1054 const struct frame_unwind legacy_saved_regs_unwinder
= {
1055 /* Not really. It gets overridden by legacy_get_prev_frame. */
1057 legacy_saved_regs_this_id
,
1058 legacy_saved_regs_prev_register
1060 const struct frame_unwind
*legacy_saved_regs_unwind
= &legacy_saved_regs_unwinder
;
1063 /* Function: deprecated_generic_get_saved_register
1064 Find register number REGNUM relative to FRAME and put its (raw,
1065 target format) contents in *RAW_BUFFER.
1067 Set *OPTIMIZED if the variable was optimized out (and thus can't be
1068 fetched). Note that this is never set to anything other than zero
1069 in this implementation.
1071 Set *LVAL to lval_memory, lval_register, or not_lval, depending on
1072 whether the value was fetched from memory, from a register, or in a
1073 strange and non-modifiable way (e.g. a frame pointer which was
1074 calculated rather than fetched). We will use not_lval for values
1075 fetched from generic dummy frames.
1077 Set *ADDRP to the address, either in memory or as a REGISTER_BYTE
1078 offset into the registers array. If the value is stored in a dummy
1079 frame, set *ADDRP to zero.
1081 The argument RAW_BUFFER must point to aligned memory. */
1084 deprecated_generic_get_saved_register (char *raw_buffer
, int *optimized
,
1086 struct frame_info
*frame
, int regnum
,
1087 enum lval_type
*lval
)
1089 if (!target_has_registers
)
1090 error ("No registers.");
1092 /* Normal systems don't optimize out things with register numbers. */
1093 if (optimized
!= NULL
)
1096 if (addrp
) /* default assumption: not found in memory */
1099 /* Note: since the current frame's registers could only have been
1100 saved by frames INTERIOR TO the current frame, we skip examining
1101 the current frame itself: otherwise, we would be getting the
1102 previous frame's registers which were saved by the current frame. */
1106 for (frame
= get_next_frame (frame
);
1107 frame_relative_level (frame
) >= 0;
1108 frame
= get_next_frame (frame
))
1110 if (get_frame_type (frame
) == DUMMY_FRAME
)
1112 if (lval
) /* found it in a CALL_DUMMY frame */
1115 /* FIXME: cagney/2002-06-26: This should be via the
1116 gdbarch_register_read() method so that it, on the
1117 fly, constructs either a raw or pseudo register
1118 from the raw register cache. */
1120 (deprecated_find_dummy_frame_regcache (get_frame_pc (frame
),
1121 get_frame_base (frame
)),
1122 regnum
, raw_buffer
);
1126 DEPRECATED_FRAME_INIT_SAVED_REGS (frame
);
1127 if (get_frame_saved_regs (frame
) != NULL
1128 && get_frame_saved_regs (frame
)[regnum
] != 0)
1130 if (lval
) /* found it saved on the stack */
1131 *lval
= lval_memory
;
1132 if (regnum
== SP_REGNUM
)
1134 if (raw_buffer
) /* SP register treated specially */
1135 /* NOTE: cagney/2003-05-09: In-line store_address
1136 with it's body - store_unsigned_integer. */
1137 store_unsigned_integer (raw_buffer
,
1138 REGISTER_RAW_SIZE (regnum
),
1139 get_frame_saved_regs (frame
)[regnum
]);
1143 if (addrp
) /* any other register */
1144 *addrp
= get_frame_saved_regs (frame
)[regnum
];
1146 read_memory (get_frame_saved_regs (frame
)[regnum
], raw_buffer
,
1147 REGISTER_RAW_SIZE (regnum
));
1154 /* If we get thru the loop to this point, it means the register was
1155 not saved in any frame. Return the actual live-register value. */
1157 if (lval
) /* found it in a live register */
1158 *lval
= lval_register
;
1160 *addrp
= REGISTER_BYTE (regnum
);
1162 deprecated_read_register_gen (regnum
, raw_buffer
);
1165 /* Determine the frame's type based on its PC. */
1167 static enum frame_type
1168 frame_type_from_pc (CORE_ADDR pc
)
1170 /* FIXME: cagney/2002-11-24: Can't yet directly call
1171 pc_in_dummy_frame() as some architectures don't set
1172 PC_IN_CALL_DUMMY() to generic_pc_in_call_dummy() (remember the
1173 latter is implemented by simply calling pc_in_dummy_frame). */
1174 if (DEPRECATED_USE_GENERIC_DUMMY_FRAMES
1175 && DEPRECATED_PC_IN_CALL_DUMMY (pc
, 0, 0))
1180 find_pc_partial_function (pc
, &name
, NULL
, NULL
);
1181 if (PC_IN_SIGTRAMP (pc
, name
))
1182 return SIGTRAMP_FRAME
;
1184 return NORMAL_FRAME
;
1188 /* Create an arbitrary (i.e. address specified by user) or innermost frame.
1189 Always returns a non-NULL value. */
1192 create_new_frame (CORE_ADDR addr
, CORE_ADDR pc
)
1194 struct frame_info
*fi
;
1198 fprintf_unfiltered (gdb_stdlog
,
1199 "{ create_new_frame (addr=0x%s, pc=0x%s) ",
1200 paddr_nz (addr
), paddr_nz (pc
));
1203 fi
= frame_obstack_zalloc (sizeof (struct frame_info
));
1205 fi
->next
= create_sentinel_frame (current_regcache
);
1207 /* Select/initialize both the unwind function and the frame's type
1209 fi
->unwind
= frame_unwind_find_by_pc (current_gdbarch
, pc
);
1210 if (fi
->unwind
->type
!= UNKNOWN_FRAME
)
1211 fi
->type
= fi
->unwind
->type
;
1213 fi
->type
= frame_type_from_pc (pc
);
1216 deprecated_update_frame_base_hack (fi
, addr
);
1217 deprecated_update_frame_pc_hack (fi
, pc
);
1219 if (DEPRECATED_INIT_EXTRA_FRAME_INFO_P ())
1220 DEPRECATED_INIT_EXTRA_FRAME_INFO (0, fi
);
1224 fprintf_unfiltered (gdb_stdlog
, "-> ");
1225 fprint_frame (gdb_stdlog
, fi
);
1226 fprintf_unfiltered (gdb_stdlog
, " }\n");
1232 /* Return the frame that THIS_FRAME calls (NULL if THIS_FRAME is the
1233 innermost frame). Be careful to not fall off the bottom of the
1234 frame chain and onto the sentinel frame. */
1237 get_next_frame (struct frame_info
*this_frame
)
1239 if (this_frame
->level
> 0)
1240 return this_frame
->next
;
1246 deprecated_get_next_frame_hack (struct frame_info
*this_frame
)
1248 return this_frame
->next
;
1251 /* Flush the entire frame cache. */
1254 flush_cached_frames (void)
1256 /* Since we can't really be sure what the first object allocated was */
1257 obstack_free (&frame_cache_obstack
, 0);
1258 obstack_init (&frame_cache_obstack
);
1260 current_frame
= NULL
; /* Invalidate cache */
1261 select_frame (NULL
);
1262 annotate_frames_invalid ();
1264 fprintf_unfiltered (gdb_stdlog
, "{ flush_cached_frames () }\n");
1267 /* Flush the frame cache, and start a new one if necessary. */
1270 reinit_frame_cache (void)
1272 flush_cached_frames ();
1274 /* FIXME: The inferior_ptid test is wrong if there is a corefile. */
1275 if (PIDGET (inferior_ptid
) != 0)
1277 select_frame (get_current_frame ());
1281 /* Create the previous frame using the deprecated methods
1282 INIT_EXTRA_INFO, INIT_FRAME_PC and INIT_FRAME_PC_FIRST. */
1284 static struct frame_info
*
1285 legacy_get_prev_frame (struct frame_info
*this_frame
)
1287 CORE_ADDR address
= 0;
1288 struct frame_info
*prev
;
1291 /* Don't frame_debug print legacy_get_prev_frame() here, just
1292 confuses the output. */
1294 /* Allocate the new frame.
1296 There is no reason to worry about memory leaks, should the
1297 remainder of the function fail. The allocated memory will be
1298 quickly reclaimed when the frame cache is flushed, and the `we've
1299 been here before' check, in get_prev_frame will stop repeated
1300 memory allocation calls. */
1301 prev
= FRAME_OBSTACK_ZALLOC (struct frame_info
);
1302 prev
->level
= this_frame
->level
+ 1;
1304 /* Do not completly wire it in to the frame chain. Some (bad) code
1305 in INIT_FRAME_EXTRA_INFO tries to look along frame->prev to pull
1306 some fancy tricks (of course such code is, by definition,
1309 On the other hand, methods, such as get_frame_pc() and
1310 get_frame_base() rely on being able to walk along the frame
1311 chain. Make certain that at least they work by providing that
1312 link. Of course things manipulating prev can't go back. */
1313 prev
->next
= this_frame
;
1315 /* NOTE: cagney/2002-11-18: Should have been correctly setting the
1316 frame's type here, before anything else, and not last, at the
1317 bottom of this function. The various
1318 DEPRECATED_INIT_EXTRA_FRAME_INFO, DEPRECATED_INIT_FRAME_PC,
1319 DEPRECATED_INIT_FRAME_PC_FIRST and
1320 DEPRECATED_FRAME_INIT_SAVED_REGS methods are full of work-arounds
1321 that handle the frame not being correctly set from the start.
1322 Unfortunatly those same work-arounds rely on the type defaulting
1323 to NORMAL_FRAME. Ulgh! The new frame code does not have this
1325 prev
->type
= UNKNOWN_FRAME
;
1327 /* A legacy frame's ID is always computed here. Mark it as valid. */
1328 prev
->this_id
.p
= 1;
1330 /* Handle sentinel frame unwind as a special case. */
1331 if (this_frame
->level
< 0)
1333 /* Try to unwind the PC. If that doesn't work, assume we've reached
1334 the oldest frame and simply return. Is there a better sentinal
1335 value? The unwound PC value is then used to initialize the new
1336 previous frame's type.
1338 Note that the pc-unwind is intentionally performed before the
1339 frame chain. This is ok since, for old targets, both
1340 frame_pc_unwind (nee, DEPRECATED_FRAME_SAVED_PC) and
1341 DEPRECATED_FRAME_CHAIN()) assume THIS_FRAME's data structures
1342 have already been initialized (using
1343 DEPRECATED_INIT_EXTRA_FRAME_INFO) and hence the call order
1346 By unwinding the PC first, it becomes possible to, in the case of
1347 a dummy frame, avoid also unwinding the frame ID. This is
1348 because (well ignoring the PPC) a dummy frame can be located
1349 using THIS_FRAME's frame ID. */
1351 deprecated_update_frame_pc_hack (prev
, frame_pc_unwind (this_frame
));
1352 if (get_frame_pc (prev
) == 0)
1354 /* The allocated PREV_FRAME will be reclaimed when the frame
1355 obstack is next purged. */
1358 fprintf_unfiltered (gdb_stdlog
, "-> ");
1359 fprint_frame (gdb_stdlog
, NULL
);
1360 fprintf_unfiltered (gdb_stdlog
,
1361 " // unwound legacy PC zero }\n");
1366 /* Set the unwind functions based on that identified PC. Ditto
1367 for the "type" but strongly prefer the unwinder's frame type. */
1368 prev
->unwind
= frame_unwind_find_by_pc (current_gdbarch
,
1369 get_frame_pc (prev
));
1370 if (prev
->unwind
->type
== UNKNOWN_FRAME
)
1371 prev
->type
= frame_type_from_pc (get_frame_pc (prev
));
1373 prev
->type
= prev
->unwind
->type
;
1375 /* Find the prev's frame's ID. */
1376 if (prev
->type
== DUMMY_FRAME
1377 && gdbarch_unwind_dummy_id_p (current_gdbarch
))
1379 /* When unwinding a normal frame, the stack structure is
1380 determined by analyzing the frame's function's code (be
1381 it using brute force prologue analysis, or the dwarf2
1382 CFI). In the case of a dummy frame, that simply isn't
1383 possible. The The PC is either the program entry point,
1384 or some random address on the stack. Trying to use that
1385 PC to apply standard frame ID unwind techniques is just
1386 asking for trouble. */
1387 /* Use an architecture specific method to extract the prev's
1388 dummy ID from the next frame. Note that this method uses
1389 frame_register_unwind to obtain the register values
1390 needed to determine the dummy frame's ID. */
1391 prev
->this_id
.value
= gdbarch_unwind_dummy_id (current_gdbarch
,
1396 /* We're unwinding a sentinel frame, the PC of which is
1397 pointing at a stack dummy. Fake up the dummy frame's ID
1398 using the same sequence as is found a traditional
1399 unwinder. Once all architectures supply the
1400 unwind_dummy_id method, this code can go away. */
1401 prev
->this_id
.value
= frame_id_build (deprecated_read_fp (),
1405 /* Check that the unwound ID is valid. */
1406 if (!frame_id_p (prev
->this_id
.value
))
1410 fprintf_unfiltered (gdb_stdlog
, "-> ");
1411 fprint_frame (gdb_stdlog
, NULL
);
1412 fprintf_unfiltered (gdb_stdlog
,
1413 " // unwound legacy ID invalid }\n");
1418 /* Check that the new frame isn't inner to (younger, below,
1419 next) the old frame. If that happens the frame unwind is
1421 /* FIXME: cagney/2003-02-25: Ignore the sentinel frame since
1422 that doesn't have a valid frame ID. Should instead set the
1423 sentinel frame's frame ID to a `sentinel'. Leave it until
1424 after the switch to storing the frame ID, instead of the
1425 frame base, in the frame object. */
1428 this_frame
->prev
= prev
;
1430 /* FIXME: cagney/2002-01-19: This call will go away. Instead of
1431 initializing extra info, all frames will use the frame_cache
1432 (passed to the unwind functions) to store additional frame
1433 info. Unfortunatly legacy targets can't use
1434 legacy_get_prev_frame() to unwind the sentinel frame and,
1435 consequently, are forced to take this code path and rely on
1436 the below call to DEPRECATED_INIT_EXTRA_FRAME_INFO to
1437 initialize the inner-most frame. */
1438 if (DEPRECATED_INIT_EXTRA_FRAME_INFO_P ())
1440 DEPRECATED_INIT_EXTRA_FRAME_INFO (0, prev
);
1443 if (prev
->type
== NORMAL_FRAME
)
1444 prev
->this_id
.value
.code_addr
1445 = get_pc_function_start (prev
->this_id
.value
.code_addr
);
1449 fprintf_unfiltered (gdb_stdlog
, "-> ");
1450 fprint_frame (gdb_stdlog
, prev
);
1451 fprintf_unfiltered (gdb_stdlog
, " } // legacy innermost frame\n");
1456 /* This code only works on normal frames. A sentinel frame, where
1457 the level is -1, should never reach this code. */
1458 gdb_assert (this_frame
->level
>= 0);
1460 /* On some machines it is possible to call a function without
1461 setting up a stack frame for it. On these machines, we
1462 define this macro to take two args; a frameinfo pointer
1463 identifying a frame and a variable to set or clear if it is
1464 or isn't leafless. */
1466 /* Still don't want to worry about this except on the innermost
1467 frame. This macro will set FROMLEAF if THIS_FRAME is a frameless
1468 function invocation. */
1469 if (this_frame
->level
== 0)
1470 /* FIXME: 2002-11-09: Frameless functions can occure anywhere in
1471 the frame chain, not just the inner most frame! The generic,
1472 per-architecture, frame code should handle this and the below
1473 should simply be removed. */
1474 fromleaf
= FRAMELESS_FUNCTION_INVOCATION (this_frame
);
1479 /* A frameless inner-most frame. The `FP' (which isn't an
1480 architecture frame-pointer register!) of the caller is the same
1482 /* FIXME: 2002-11-09: There isn't any reason to special case this
1483 edge condition. Instead the per-architecture code should hande
1485 /* FIXME: cagney/2003-06-16: This returns the inner most stack
1486 address for the previous frame, that, however, is wrong. It
1487 should be the inner most stack address for the previous to
1488 previous frame. This is because it is the previous to previous
1489 frame's innermost stack address that is constant through out
1490 the lifetime of the previous frame (trust me :-). */
1491 address
= get_frame_base (this_frame
);
1494 /* Two macros defined in tm.h specify the machine-dependent
1495 actions to be performed here.
1497 First, get the frame's chain-pointer.
1499 If that is zero, the frame is the outermost frame or a leaf
1500 called by the outermost frame. This means that if start
1501 calls main without a frame, we'll return 0 (which is fine
1504 Nope; there's a problem. This also returns when the current
1505 routine is a leaf of main. This is unacceptable. We move
1506 this to after the ffi test; I'd rather have backtraces from
1507 start go curfluy than have an abort called from main not show
1509 if (DEPRECATED_FRAME_CHAIN_P ())
1510 address
= DEPRECATED_FRAME_CHAIN (this_frame
);
1513 /* Someone is part way through coverting an old architecture
1514 to the new frame code. Implement FRAME_CHAIN the way the
1516 /* Find PREV frame's unwinder. */
1517 prev
->unwind
= frame_unwind_find_by_pc (current_gdbarch
,
1518 frame_pc_unwind (this_frame
));
1519 /* FIXME: cagney/2003-04-02: Rather than storing the frame's
1520 type in the frame, the unwinder's type should be returned
1521 directly. Unfortunatly, legacy code, called by
1522 legacy_get_prev_frame, explicitly set the frames type
1523 using the method deprecated_set_frame_type(). */
1524 prev
->type
= prev
->unwind
->type
;
1525 /* Find PREV frame's ID. */
1526 prev
->unwind
->this_id (this_frame
,
1527 &prev
->prologue_cache
,
1528 &prev
->this_id
.value
);
1529 prev
->this_id
.p
= 1;
1530 address
= prev
->this_id
.value
.stack_addr
;
1533 if (!legacy_frame_chain_valid (address
, this_frame
))
1537 fprintf_unfiltered (gdb_stdlog
, "-> ");
1538 fprint_frame (gdb_stdlog
, NULL
);
1539 fprintf_unfiltered (gdb_stdlog
,
1540 " // legacy frame chain invalid }\n");
1549 fprintf_unfiltered (gdb_stdlog
, "-> ");
1550 fprint_frame (gdb_stdlog
, NULL
);
1551 fprintf_unfiltered (gdb_stdlog
,
1552 " // legacy frame chain NULL }\n");
1557 /* Link in the already allocated prev frame. */
1558 this_frame
->prev
= prev
;
1559 deprecated_update_frame_base_hack (prev
, address
);
1561 /* This change should not be needed, FIXME! We should determine
1562 whether any targets *need* DEPRECATED_INIT_FRAME_PC to happen
1563 after DEPRECATED_INIT_EXTRA_FRAME_INFO and come up with a simple
1564 way to express what goes on here.
1566 DEPRECATED_INIT_EXTRA_FRAME_INFO is called from two places:
1567 create_new_frame (where the PC is already set up) and here (where
1568 it isn't). DEPRECATED_INIT_FRAME_PC is only called from here,
1569 always after DEPRECATED_INIT_EXTRA_FRAME_INFO.
1571 The catch is the MIPS, where DEPRECATED_INIT_EXTRA_FRAME_INFO
1572 requires the PC value (which hasn't been set yet). Some other
1573 machines appear to require DEPRECATED_INIT_EXTRA_FRAME_INFO
1574 before they can do DEPRECATED_INIT_FRAME_PC. Phoo.
1576 We shouldn't need DEPRECATED_INIT_FRAME_PC_FIRST to add more
1577 complication to an already overcomplicated part of GDB.
1578 gnu@cygnus.com, 15Sep92.
1580 Assuming that some machines need DEPRECATED_INIT_FRAME_PC after
1581 DEPRECATED_INIT_EXTRA_FRAME_INFO, one possible scheme:
1583 SETUP_INNERMOST_FRAME(): Default version is just create_new_frame
1584 (deprecated_read_fp ()), read_pc ()). Machines with extra frame
1585 info would do that (or the local equivalent) and then set the
1588 SETUP_ARBITRARY_FRAME(argc, argv): Only change here is that
1589 create_new_frame would no longer init extra frame info;
1590 SETUP_ARBITRARY_FRAME would have to do that.
1592 INIT_PREV_FRAME(fromleaf, prev) Replace
1593 DEPRECATED_INIT_EXTRA_FRAME_INFO and DEPRECATED_INIT_FRAME_PC.
1594 This should also return a flag saying whether to keep the new
1595 frame, or whether to discard it, because on some machines (e.g.
1596 mips) it is really awkward to have DEPRECATED_FRAME_CHAIN_VALID
1597 called BEFORE DEPRECATED_INIT_EXTRA_FRAME_INFO (there is no good
1598 way to get information deduced in DEPRECATED_FRAME_CHAIN_VALID
1599 into the extra fields of the new frame). std_frame_pc(fromleaf,
1602 This is the default setting for INIT_PREV_FRAME. It just does
1603 what the default DEPRECATED_INIT_FRAME_PC does. Some machines
1604 will call it from INIT_PREV_FRAME (either at the beginning, the
1605 end, or in the middle). Some machines won't use it.
1607 kingdon@cygnus.com, 13Apr93, 31Jan94, 14Dec94. */
1609 /* NOTE: cagney/2002-11-09: Just ignore the above! There is no
1610 reason for things to be this complicated.
1612 The trick is to assume that there is always a frame. Instead of
1613 special casing the inner-most frame, create fake frame
1614 (containing the hardware registers) that is inner to the
1615 user-visible inner-most frame (...) and then unwind from that.
1616 That way architecture code can use use the standard
1617 frame_XX_unwind() functions and not differentiate between the
1618 inner most and any other case.
1620 Since there is always a frame to unwind from, there is always
1621 somewhere (THIS_FRAME) to store all the info needed to construct
1622 a new (previous) frame without having to first create it. This
1623 means that the convolution below - needing to carefully order a
1624 frame's initialization - isn't needed.
1626 The irony here though, is that DEPRECATED_FRAME_CHAIN(), at least
1627 for a more up-to-date architecture, always calls
1628 FRAME_SAVED_PC(), and FRAME_SAVED_PC() computes the PC but
1629 without first needing the frame! Instead of the convolution
1630 below, we could have simply called FRAME_SAVED_PC() and been done
1631 with it! Note that FRAME_SAVED_PC() is being superseed by
1632 frame_pc_unwind() and that function does have somewhere to cache
1635 if (DEPRECATED_INIT_FRAME_PC_FIRST_P ())
1636 deprecated_update_frame_pc_hack (prev
,
1637 DEPRECATED_INIT_FRAME_PC_FIRST (fromleaf
,
1640 if (DEPRECATED_INIT_EXTRA_FRAME_INFO_P ())
1641 DEPRECATED_INIT_EXTRA_FRAME_INFO (fromleaf
, prev
);
1643 /* This entry is in the frame queue now, which is good since
1644 FRAME_SAVED_PC may use that queue to figure out its value (see
1645 tm-sparc.h). We want the pc saved in the inferior frame. */
1646 if (DEPRECATED_INIT_FRAME_PC_P ())
1647 deprecated_update_frame_pc_hack (prev
,
1648 DEPRECATED_INIT_FRAME_PC (fromleaf
,
1651 /* If ->frame and ->pc are unchanged, we are in the process of
1652 getting ourselves into an infinite backtrace. Some architectures
1653 check this in DEPRECATED_FRAME_CHAIN or thereabouts, but it seems
1654 like there is no reason this can't be an architecture-independent
1656 if (get_frame_base (prev
) == get_frame_base (this_frame
)
1657 && get_frame_pc (prev
) == get_frame_pc (this_frame
))
1659 this_frame
->prev
= NULL
;
1660 obstack_free (&frame_cache_obstack
, prev
);
1663 fprintf_unfiltered (gdb_stdlog
, "-> ");
1664 fprint_frame (gdb_stdlog
, NULL
);
1665 fprintf_unfiltered (gdb_stdlog
,
1666 " // legacy this.id == prev.id }\n");
1671 /* Initialize the code used to unwind the frame PREV based on the PC
1672 (and probably other architectural information). The PC lets you
1673 check things like the debug info at that point (dwarf2cfi?) and
1674 use that to decide how the frame should be unwound.
1676 If there isn't a FRAME_CHAIN, the code above will have already
1678 if (prev
->unwind
== NULL
)
1679 prev
->unwind
= frame_unwind_find_by_pc (current_gdbarch
,
1680 get_frame_pc (prev
));
1682 /* If the unwinder provides a frame type, use it. Otherwize
1683 continue on to that heuristic mess. */
1684 if (prev
->unwind
->type
!= UNKNOWN_FRAME
)
1686 prev
->type
= prev
->unwind
->type
;
1687 if (prev
->type
== NORMAL_FRAME
)
1688 /* FIXME: cagney/2003-06-16: would get_frame_pc() be better? */
1689 prev
->this_id
.value
.code_addr
1690 = get_pc_function_start (prev
->this_id
.value
.code_addr
);
1693 fprintf_unfiltered (gdb_stdlog
, "-> ");
1694 fprint_frame (gdb_stdlog
, prev
);
1695 fprintf_unfiltered (gdb_stdlog
, " } // legacy with unwound type\n");
1700 /* NOTE: cagney/2002-11-18: The code segments, found in
1701 create_new_frame and get_prev_frame(), that initializes the
1702 frames type is subtly different. The latter only updates ->type
1703 when it encounters a SIGTRAMP_FRAME or DUMMY_FRAME. This stops
1704 get_prev_frame() overriding the frame's type when the INIT code
1705 has previously set it. This is really somewhat bogus. The
1706 initialization, as seen in create_new_frame(), should occur
1707 before the INIT function has been called. */
1708 if (DEPRECATED_USE_GENERIC_DUMMY_FRAMES
1709 && (DEPRECATED_PC_IN_CALL_DUMMY_P ()
1710 ? DEPRECATED_PC_IN_CALL_DUMMY (get_frame_pc (prev
), 0, 0)
1711 : pc_in_dummy_frame (get_frame_pc (prev
))))
1712 prev
->type
= DUMMY_FRAME
;
1715 /* FIXME: cagney/2002-11-10: This should be moved to before the
1716 INIT code above so that the INIT code knows what the frame's
1717 type is (in fact, for a [generic] dummy-frame, the type can
1718 be set and then the entire initialization can be skipped.
1719 Unforunatly, its the INIT code that sets the PC (Hmm, catch
1722 find_pc_partial_function (get_frame_pc (prev
), &name
, NULL
, NULL
);
1723 if (PC_IN_SIGTRAMP (get_frame_pc (prev
), name
))
1724 prev
->type
= SIGTRAMP_FRAME
;
1725 /* FIXME: cagney/2002-11-11: Leave prev->type alone. Some
1726 architectures are forcing the frame's type in INIT so we
1727 don't want to override it here. Remember, NORMAL_FRAME == 0,
1728 so it all works (just :-/). Once this initialization is
1729 moved to the start of this function, all this nastness will
1733 if (prev
->type
== NORMAL_FRAME
)
1734 prev
->this_id
.value
.code_addr
1735 = get_pc_function_start (prev
->this_id
.value
.code_addr
);
1739 fprintf_unfiltered (gdb_stdlog
, "-> ");
1740 fprint_frame (gdb_stdlog
, prev
);
1741 fprintf_unfiltered (gdb_stdlog
, " } // legacy with confused type\n");
1747 /* Return a structure containing various interesting information
1748 about the frame that called THIS_FRAME. Returns NULL
1749 if there is no such frame. */
1752 get_prev_frame (struct frame_info
*this_frame
)
1754 struct frame_info
*prev_frame
;
1758 fprintf_unfiltered (gdb_stdlog
, "{ get_prev_frame (this_frame=");
1759 if (this_frame
!= NULL
)
1760 fprintf_unfiltered (gdb_stdlog
, "%d", this_frame
->level
);
1762 fprintf_unfiltered (gdb_stdlog
, "<NULL>");
1763 fprintf_unfiltered (gdb_stdlog
, ") ");
1766 /* Return the inner-most frame, when the caller passes in NULL. */
1767 /* NOTE: cagney/2002-11-09: Not sure how this would happen. The
1768 caller should have previously obtained a valid frame using
1769 get_selected_frame() and then called this code - only possibility
1770 I can think of is code behaving badly.
1772 NOTE: cagney/2003-01-10: Talk about code behaving badly. Check
1773 block_innermost_frame(). It does the sequence: frame = NULL;
1774 while (1) { frame = get_prev_frame (frame); .... }. Ulgh! Why
1775 it couldn't be written better, I don't know.
1777 NOTE: cagney/2003-01-11: I suspect what is happening is
1778 block_innermost_frame() is, when the target has no state
1779 (registers, memory, ...), still calling this function. The
1780 assumption being that this function will return NULL indicating
1781 that a frame isn't possible, rather than checking that the target
1782 has state and then calling get_current_frame() and
1783 get_prev_frame(). This is a guess mind. */
1784 if (this_frame
== NULL
)
1786 /* NOTE: cagney/2002-11-09: There was a code segment here that
1787 would error out when CURRENT_FRAME was NULL. The comment
1788 that went with it made the claim ...
1790 ``This screws value_of_variable, which just wants a nice
1791 clean NULL return from block_innermost_frame if there are no
1792 frames. I don't think I've ever seen this message happen
1793 otherwise. And returning NULL here is a perfectly legitimate
1796 Per the above, this code shouldn't even be called with a NULL
1798 return current_frame
;
1801 /* There is always a frame. If this assertion fails, suspect that
1802 something should be calling get_selected_frame() or
1803 get_current_frame(). */
1804 gdb_assert (this_frame
!= NULL
);
1806 if (this_frame
->level
>= 0
1807 && !backtrace_below_main
1808 && inside_main_func (get_frame_pc (this_frame
)))
1809 /* Don't unwind past main(), bug always unwind the sentinel frame.
1810 Note, this is done _before_ the frame has been marked as
1811 previously unwound. That way if the user later decides to
1812 allow unwinds past main(), that just happens. */
1815 fprintf_unfiltered (gdb_stdlog
, "-> NULL // inside main func }\n");
1819 /* If we're already inside the entry function for the main objfile,
1820 then it isn't valid. Don't apply this test to a dummy frame -
1821 dummy frame PC's typically land in the entry func. Don't apply
1822 this test to the sentinel frame. Sentinel frames should always
1823 be allowed to unwind. */
1824 /* NOTE: cagney/2003-02-25: Don't enable until someone has found
1825 hard evidence that this is needed. */
1826 /* NOTE: cagney/2003-07-07: Fixed a bug in inside_main_func - wasn't
1827 checking for "main" in the minimal symbols. With that fixed
1828 asm-source tests now stop in "main" instead of halting the
1829 backtrace in wierd and wonderful ways somewhere inside the entry
1830 file. Suspect that inside_entry_file and inside_entry_func tests
1831 were added to work around that (now fixed) case. */
1832 /* NOTE: cagney/2003-07-15: danielj (if I'm reading it right)
1833 suggested having the inside_entry_func test use the
1834 inside_main_func msymbol trick (along with entry_point_address I
1835 guess) to determine the address range of the start function.
1836 That should provide a far better stopper than the current
1838 /* NOTE: cagney/2003-07-15: Need to add a "set backtrace
1839 beyond-entry-func" command so that this can be selectively
1843 && backtrace_beyond_entry_func
1845 && this_frame
->type
!= DUMMY_FRAME
&& this_frame
->level
>= 0
1846 && inside_entry_func (get_frame_pc (this_frame
)))
1850 fprintf_unfiltered (gdb_stdlog
, "-> ");
1851 fprint_frame (gdb_stdlog
, NULL
);
1852 fprintf_unfiltered (gdb_stdlog
, "// inside entry func }\n");
1857 /* Only try to do the unwind once. */
1858 if (this_frame
->prev_p
)
1862 fprintf_unfiltered (gdb_stdlog
, "-> ");
1863 fprint_frame (gdb_stdlog
, this_frame
->prev
);
1864 fprintf_unfiltered (gdb_stdlog
, " // cached \n");
1866 return this_frame
->prev
;
1868 this_frame
->prev_p
= 1;
1871 /* If we're inside the entry file, it isn't valid. Don't apply this
1872 test to a dummy frame - dummy frame PC's typically land in the
1873 entry file. Don't apply this test to the sentinel frame.
1874 Sentinel frames should always be allowed to unwind. */
1875 /* NOTE: drow/2002-12-25: should there be a way to disable this
1876 check? It assumes a single small entry file, and the way some
1877 debug readers (e.g. dbxread) figure out which object is the
1878 entry file is somewhat hokey. */
1879 /* NOTE: cagney/2003-01-10: If there is a way of disabling this test
1880 then it should probably be moved to before the ->prev_p test,
1882 /* NOTE: vinschen/2003-04-01: Disabled. It turns out that the call to
1883 inside_entry_file destroys a meaningful backtrace under some
1884 conditions. E. g. the backtrace tests in the asm-source testcase
1885 are broken for some targets. In this test the functions are all
1886 implemented as part of one file and the testcase is not necessarily
1887 linked with a start file (depending on the target). What happens is,
1888 that the first frame is printed normaly and following frames are
1889 treated as being inside the enttry file then. This way, only the
1890 #0 frame is printed in the backtrace output. */
1891 if (this_frame
->type
!= DUMMY_FRAME
&& this_frame
->level
>= 0
1892 && inside_entry_file (get_frame_pc (this_frame
)))
1896 fprintf_unfiltered (gdb_stdlog
, "-> ");
1897 fprint_frame (gdb_stdlog
, NULL
);
1898 fprintf_unfiltered (gdb_stdlog
, " // inside entry file }\n");
1904 /* If any of the old frame initialization methods are around, use
1905 the legacy get_prev_frame method. */
1906 if (legacy_frame_p (current_gdbarch
))
1908 prev_frame
= legacy_get_prev_frame (this_frame
);
1912 /* Check that this frame's ID was valid. If it wasn't, don't try to
1913 unwind to the prev frame. Be careful to not apply this test to
1914 the sentinel frame. */
1915 if (this_frame
->level
>= 0 && !frame_id_p (get_frame_id (this_frame
)))
1919 fprintf_unfiltered (gdb_stdlog
, "-> ");
1920 fprint_frame (gdb_stdlog
, NULL
);
1921 fprintf_unfiltered (gdb_stdlog
, " // this ID is NULL }\n");
1926 /* Check that this frame's ID isn't inner to (younger, below, next)
1927 the next frame. This happens when a frame unwind goes backwards.
1928 Since the sentinel frame doesn't really exist, don't compare the
1929 inner-most against that sentinel. */
1930 if (this_frame
->level
> 0
1931 && frame_id_inner (get_frame_id (this_frame
),
1932 get_frame_id (this_frame
->next
)))
1933 error ("Previous frame inner to this frame (corrupt stack?)");
1935 /* Check that this and the next frame are not identical. If they
1936 are, there is most likely a stack cycle. As with the inner-than
1937 test above, avoid comparing the inner-most and sentinel frames. */
1938 if (this_frame
->level
> 0
1939 && frame_id_eq (get_frame_id (this_frame
),
1940 get_frame_id (this_frame
->next
)))
1941 error ("Previous frame identical to this frame (corrupt stack?)");
1943 /* Allocate the new frame but do not wire it in to the frame chain.
1944 Some (bad) code in INIT_FRAME_EXTRA_INFO tries to look along
1945 frame->next to pull some fancy tricks (of course such code is, by
1946 definition, recursive). Try to prevent it.
1948 There is no reason to worry about memory leaks, should the
1949 remainder of the function fail. The allocated memory will be
1950 quickly reclaimed when the frame cache is flushed, and the `we've
1951 been here before' check above will stop repeated memory
1952 allocation calls. */
1953 prev_frame
= FRAME_OBSTACK_ZALLOC (struct frame_info
);
1954 prev_frame
->level
= this_frame
->level
+ 1;
1956 /* Try to unwind the PC. If that doesn't work, assume we've reached
1957 the oldest frame and simply return. Is there a better sentinal
1958 value? The unwound PC value is then used to initialize the new
1959 previous frame's type.
1961 Note that the pc-unwind is intentionally performed before the
1962 frame chain. This is ok since, for old targets, both
1963 frame_pc_unwind (nee, FRAME_SAVED_PC) and
1964 DEPRECATED_FRAME_CHAIN()) assume THIS_FRAME's data structures
1965 have already been initialized (using
1966 DEPRECATED_INIT_EXTRA_FRAME_INFO) and hence the call order
1969 By unwinding the PC first, it becomes possible to, in the case of
1970 a dummy frame, avoid also unwinding the frame ID. This is
1971 because (well ignoring the PPC) a dummy frame can be located
1972 using THIS_FRAME's frame ID. */
1974 if (frame_pc_unwind (this_frame
) == 0)
1976 /* The allocated PREV_FRAME will be reclaimed when the frame
1977 obstack is next purged. */
1980 fprintf_unfiltered (gdb_stdlog
, "-> ");
1981 fprint_frame (gdb_stdlog
, NULL
);
1982 fprintf_unfiltered (gdb_stdlog
, " // unwound PC zero }\n");
1987 /* Don't yet compute ->unwind (and hence ->type). It is computed
1988 on-demand in get_frame_type, frame_register_unwind, and
1991 /* Don't yet compute the frame's ID. It is computed on-demand by
1994 /* The unwound frame ID is validate at the start of this function,
1995 as part of the logic to decide if that frame should be further
1996 unwound, and not here while the prev frame is being created.
1997 Doing this makes it possible for the user to examine a frame that
1998 has an invalid frame ID.
2000 Some very old VAX code noted: [...] For the sake of argument,
2001 suppose that the stack is somewhat trashed (which is one reason
2002 that "info frame" exists). So, return 0 (indicating we don't
2003 know the address of the arglist) if we don't know what frame this
2007 this_frame
->prev
= prev_frame
;
2008 prev_frame
->next
= this_frame
;
2012 fprintf_unfiltered (gdb_stdlog
, "-> ");
2013 fprint_frame (gdb_stdlog
, prev_frame
);
2014 fprintf_unfiltered (gdb_stdlog
, " }\n");
2021 get_frame_pc (struct frame_info
*frame
)
2023 gdb_assert (frame
->next
!= NULL
);
2024 return frame_pc_unwind (frame
->next
);
2027 /* Return an address of that falls within the frame's code block. */
2030 frame_unwind_address_in_block (struct frame_info
*next_frame
)
2032 /* A draft address. */
2033 CORE_ADDR pc
= frame_pc_unwind (next_frame
);
2035 /* If THIS frame is not inner most (i.e., NEXT isn't the sentinel),
2036 and NEXT is `normal' (i.e., not a sigtramp, dummy, ....) THIS
2037 frame's PC ends up pointing at the instruction fallowing the
2038 "call". Adjust that PC value so that it falls on the call
2039 instruction (which, hopefully, falls within THIS frame's code
2040 block. So far it's proved to be a very good approximation. See
2041 get_frame_type for why ->type can't be used. */
2042 if (next_frame
->level
>= 0
2043 && get_frame_type (next_frame
) == NORMAL_FRAME
)
2049 get_frame_address_in_block (struct frame_info
*this_frame
)
2051 return frame_unwind_address_in_block (this_frame
->next
);
2055 pc_notcurrent (struct frame_info
*frame
)
2057 /* If FRAME is not the innermost frame, that normally means that
2058 FRAME->pc points at the return instruction (which is *after* the
2059 call instruction), and we want to get the line containing the
2060 call (because the call is where the user thinks the program is).
2061 However, if the next frame is either a SIGTRAMP_FRAME or a
2062 DUMMY_FRAME, then the next frame will contain a saved interrupt
2063 PC and such a PC indicates the current (rather than next)
2064 instruction/line, consequently, for such cases, want to get the
2065 line containing fi->pc. */
2066 struct frame_info
*next
= get_next_frame (frame
);
2067 int notcurrent
= (next
!= NULL
&& get_frame_type (next
) == NORMAL_FRAME
);
2072 find_frame_sal (struct frame_info
*frame
, struct symtab_and_line
*sal
)
2074 (*sal
) = find_pc_line (get_frame_pc (frame
), pc_notcurrent (frame
));
2077 /* Per "frame.h", return the ``address'' of the frame. Code should
2078 really be using get_frame_id(). */
2080 get_frame_base (struct frame_info
*fi
)
2082 return get_frame_id (fi
).stack_addr
;
2085 /* High-level offsets into the frame. Used by the debug info. */
2088 get_frame_base_address (struct frame_info
*fi
)
2090 if (get_frame_type (fi
) != NORMAL_FRAME
)
2092 if (fi
->base
== NULL
)
2093 fi
->base
= frame_base_find_by_pc (current_gdbarch
, get_frame_pc (fi
));
2094 /* Sneaky: If the low-level unwind and high-level base code share a
2095 common unwinder, let them share the prologue cache. */
2096 if (fi
->base
->unwind
== fi
->unwind
)
2097 return fi
->base
->this_base (fi
->next
, &fi
->prologue_cache
);
2098 return fi
->base
->this_base (fi
->next
, &fi
->base_cache
);
2102 get_frame_locals_address (struct frame_info
*fi
)
2105 if (get_frame_type (fi
) != NORMAL_FRAME
)
2107 /* If there isn't a frame address method, find it. */
2108 if (fi
->base
== NULL
)
2109 fi
->base
= frame_base_find_by_pc (current_gdbarch
, get_frame_pc (fi
));
2110 /* Sneaky: If the low-level unwind and high-level base code share a
2111 common unwinder, let them share the prologue cache. */
2112 if (fi
->base
->unwind
== fi
->unwind
)
2113 cache
= &fi
->prologue_cache
;
2115 cache
= &fi
->base_cache
;
2116 return fi
->base
->this_locals (fi
->next
, cache
);
2120 get_frame_args_address (struct frame_info
*fi
)
2123 if (get_frame_type (fi
) != NORMAL_FRAME
)
2125 /* If there isn't a frame address method, find it. */
2126 if (fi
->base
== NULL
)
2127 fi
->base
= frame_base_find_by_pc (current_gdbarch
, get_frame_pc (fi
));
2128 /* Sneaky: If the low-level unwind and high-level base code share a
2129 common unwinder, let them share the prologue cache. */
2130 if (fi
->base
->unwind
== fi
->unwind
)
2131 cache
= &fi
->prologue_cache
;
2133 cache
= &fi
->base_cache
;
2134 return fi
->base
->this_args (fi
->next
, cache
);
2137 /* Level of the selected frame: 0 for innermost, 1 for its caller, ...
2138 or -1 for a NULL frame. */
2141 frame_relative_level (struct frame_info
*fi
)
2150 get_frame_type (struct frame_info
*frame
)
2152 /* Some targets still don't use [generic] dummy frames. Catch them
2154 if (!DEPRECATED_USE_GENERIC_DUMMY_FRAMES
2155 && deprecated_frame_in_dummy (frame
))
2158 /* Some legacy code, e.g, mips_init_extra_frame_info() wants
2159 to determine the frame's type prior to it being completely
2160 initialized. Don't attempt to lazily initialize ->unwind for
2161 legacy code. It will be initialized in legacy_get_prev_frame(). */
2162 if (frame
->unwind
== NULL
&& !legacy_frame_p (current_gdbarch
))
2164 /* Initialize the frame's unwinder because it is that which
2165 provides the frame's type. */
2166 frame
->unwind
= frame_unwind_find_by_pc (current_gdbarch
,
2167 get_frame_pc (frame
));
2168 /* FIXME: cagney/2003-04-02: Rather than storing the frame's
2169 type in the frame, the unwinder's type should be returned
2170 directly. Unfortunatly, legacy code, called by
2171 legacy_get_prev_frame, explicitly set the frames type using
2172 the method deprecated_set_frame_type(). */
2173 gdb_assert (frame
->unwind
->type
!= UNKNOWN_FRAME
);
2174 frame
->type
= frame
->unwind
->type
;
2176 if (frame
->type
== UNKNOWN_FRAME
)
2177 return NORMAL_FRAME
;
2183 deprecated_set_frame_type (struct frame_info
*frame
, enum frame_type type
)
2185 /* Arrrg! See comment in "frame.h". */
2189 struct frame_extra_info
*
2190 get_frame_extra_info (struct frame_info
*fi
)
2192 return fi
->extra_info
;
2195 struct frame_extra_info
*
2196 frame_extra_info_zalloc (struct frame_info
*fi
, long size
)
2198 fi
->extra_info
= frame_obstack_zalloc (size
);
2199 return fi
->extra_info
;
2203 deprecated_update_frame_pc_hack (struct frame_info
*frame
, CORE_ADDR pc
)
2206 fprintf_unfiltered (gdb_stdlog
,
2207 "{ deprecated_update_frame_pc_hack (frame=%d,pc=0x%s) }\n",
2208 frame
->level
, paddr_nz (pc
));
2209 /* NOTE: cagney/2003-03-11: Some architectures (e.g., Arm) are
2210 maintaining a locally allocated frame object. Since such frame's
2211 are not in the frame chain, it isn't possible to assume that the
2212 frame has a next. Sigh. */
2213 if (frame
->next
!= NULL
)
2215 /* While we're at it, update this frame's cached PC value, found
2216 in the next frame. Oh for the day when "struct frame_info"
2217 is opaque and this hack on hack can just go away. */
2218 frame
->next
->prev_pc
.value
= pc
;
2219 frame
->next
->prev_pc
.p
= 1;
2224 deprecated_update_frame_base_hack (struct frame_info
*frame
, CORE_ADDR base
)
2227 fprintf_unfiltered (gdb_stdlog
,
2228 "{ deprecated_update_frame_base_hack (frame=%d,base=0x%s) }\n",
2229 frame
->level
, paddr_nz (base
));
2230 /* See comment in "frame.h". */
2231 frame
->this_id
.value
.stack_addr
= base
;
2235 deprecated_set_frame_saved_regs_hack (struct frame_info
*frame
,
2236 CORE_ADDR
*saved_regs
)
2238 frame
->saved_regs
= saved_regs
;
2242 deprecated_set_frame_extra_info_hack (struct frame_info
*frame
,
2243 struct frame_extra_info
*extra_info
)
2245 frame
->extra_info
= extra_info
;
2249 deprecated_set_frame_next_hack (struct frame_info
*fi
,
2250 struct frame_info
*next
)
2256 deprecated_set_frame_prev_hack (struct frame_info
*fi
,
2257 struct frame_info
*prev
)
2263 deprecated_get_frame_context (struct frame_info
*fi
)
2269 deprecated_set_frame_context (struct frame_info
*fi
,
2270 struct context
*context
)
2272 fi
->context
= context
;
2276 deprecated_frame_xmalloc (void)
2278 struct frame_info
*frame
= FRAME_OBSTACK_ZALLOC (struct frame_info
);
2279 frame
->this_id
.p
= 1;
2284 deprecated_frame_xmalloc_with_cleanup (long sizeof_saved_regs
,
2285 long sizeof_extra_info
)
2287 struct frame_info
*frame
= deprecated_frame_xmalloc ();
2288 make_cleanup (xfree
, frame
);
2289 if (sizeof_saved_regs
> 0)
2291 frame
->saved_regs
= xcalloc (1, sizeof_saved_regs
);
2292 make_cleanup (xfree
, frame
->saved_regs
);
2294 if (sizeof_extra_info
> 0)
2296 frame
->extra_info
= xcalloc (1, sizeof_extra_info
);
2297 make_cleanup (xfree
, frame
->extra_info
);
2302 /* Memory access methods. */
2305 get_frame_memory (struct frame_info
*this_frame
, CORE_ADDR addr
, void *buf
,
2308 read_memory (addr
, buf
, len
);
2312 get_frame_memory_signed (struct frame_info
*this_frame
, CORE_ADDR addr
,
2315 return read_memory_integer (addr
, len
);
2319 get_frame_memory_unsigned (struct frame_info
*this_frame
, CORE_ADDR addr
,
2322 return read_memory_unsigned_integer (addr
, len
);
2325 /* Architecture method. */
2328 get_frame_arch (struct frame_info
*this_frame
)
2330 return current_gdbarch
;
2333 /* Stack pointer methods. */
2336 get_frame_sp (struct frame_info
*this_frame
)
2338 return frame_sp_unwind (this_frame
->next
);
2342 frame_sp_unwind (struct frame_info
*next_frame
)
2344 /* Normality, an architecture that provides a way of obtaining any
2345 frame inner-most address. */
2346 if (gdbarch_unwind_sp_p (current_gdbarch
))
2347 return gdbarch_unwind_sp (current_gdbarch
, next_frame
);
2348 /* Things are looking grim. If it's the inner-most frame and there
2349 is a TARGET_READ_SP then that can be used. */
2350 if (next_frame
->level
< 0 && TARGET_READ_SP_P ())
2351 return TARGET_READ_SP ();
2352 /* Now things are really are grim. Hope that the value returned by
2353 the SP_REGNUM register is meaningful. */
2357 frame_unwind_unsigned_register (next_frame
, SP_REGNUM
, &sp
);
2360 internal_error (__FILE__
, __LINE__
, "Missing unwind SP method");
2365 legacy_frame_p (struct gdbarch
*current_gdbarch
)
2367 return (DEPRECATED_INIT_FRAME_PC_P ()
2368 || DEPRECATED_INIT_FRAME_PC_FIRST_P ()
2369 || DEPRECATED_INIT_EXTRA_FRAME_INFO_P ()
2370 || DEPRECATED_FRAME_CHAIN_P ()
2371 || !gdbarch_unwind_dummy_id_p (current_gdbarch
));
2374 extern initialize_file_ftype _initialize_frame
; /* -Wmissing-prototypes */
2377 _initialize_frame (void)
2379 obstack_init (&frame_cache_obstack
);
2381 /* FIXME: cagney/2003-01-19: This command needs a rename. Suggest
2382 `set backtrace {past,beyond,...}-main'. Also suggest adding `set
2383 backtrace ...-start' to control backtraces past start. The
2384 problem with `below' is that it stops the `up' command. */
2386 add_setshow_boolean_cmd ("backtrace-below-main", class_obscure
,
2387 &backtrace_below_main
, "\
2388 Set whether backtraces should continue past \"main\".\n\
2389 Normally the caller of \"main\" is not of interest, so GDB will terminate\n\
2390 the backtrace at \"main\". Set this variable if you need to see the rest\n\
2391 of the stack trace.", "\
2392 Show whether backtraces should continue past \"main\".\n\
2393 Normally the caller of \"main\" is not of interest, so GDB will terminate\n\
2394 the backtrace at \"main\". Set this variable if you need to see the rest\n\
2395 of the stack trace.",
2396 NULL
, NULL
, &setlist
, &showlist
);
2399 /* Debug this files internals. */
2400 add_show_from_set (add_set_cmd ("frame", class_maintenance
, var_zinteger
,
2401 &frame_debug
, "Set frame debugging.\n\
2402 When non-zero, frame specific internal debugging is enabled.", &setdebuglist
),