* lib/gdb.exp (inferior_exited_re): Match. leading `['. Wrap in
[deliverable/binutils-gdb.git] / gdb / frame.c
CommitLineData
4f460812 1/* Cache and manage frames for GDB, the GNU debugger.
96cb11df 2
6aba47ca 3 Copyright (C) 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000, 2001,
7b6bb8da
JB
4 2002, 2003, 2004, 2007, 2008, 2009, 2010, 2011
5 Free Software Foundation, Inc.
d65fe839
AC
6
7 This file is part of GDB.
8
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
a9762ec7 11 the Free Software Foundation; either version 3 of the License, or
d65fe839
AC
12 (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
a9762ec7 20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
d65fe839
AC
21
22#include "defs.h"
23#include "frame.h"
24#include "target.h"
25#include "value.h"
39f77062 26#include "inferior.h" /* for inferior_ptid */
4e052eda 27#include "regcache.h"
4f460812 28#include "gdb_assert.h"
e36180d7 29#include "gdb_string.h"
eb8bc282 30#include "user-regs.h"
4c1e7e9d
AC
31#include "gdb_obstack.h"
32#include "dummy-frame.h"
a94dd1fd 33#include "sentinel-frame.h"
4c1e7e9d
AC
34#include "gdbcore.h"
35#include "annotate.h"
6e7f8b9c 36#include "language.h"
494cca16 37#include "frame-unwind.h"
da62e633 38#include "frame-base.h"
eb4f72c5
AC
39#include "command.h"
40#include "gdbcmd.h"
f4c5303c 41#include "observer.h"
c8cd9f6c 42#include "objfiles.h"
60250e8b 43#include "exceptions.h"
8ea051c5 44#include "gdbthread.h"
edb3359d
DJ
45#include "block.h"
46#include "inline-frame.h"
2ce6d6bf 47#include "tracepoint.h"
eb4f72c5 48
5613d8d3 49static struct frame_info *get_prev_frame_1 (struct frame_info *this_frame);
edb3359d 50static struct frame_info *get_prev_frame_raw (struct frame_info *this_frame);
5613d8d3 51
bd013d54
AC
52/* We keep a cache of stack frames, each of which is a "struct
53 frame_info". The innermost one gets allocated (in
54 wait_for_inferior) each time the inferior stops; current_frame
55 points to it. Additional frames get allocated (in get_prev_frame)
56 as needed, and are chained through the next and prev fields. Any
57 time that the frame cache becomes invalid (most notably when we
58 execute something, but also if we change how we interpret the
59 frames (e.g. "set heuristic-fence-post" in mips-tdep.c, or anything
60 which reads new symbols)), we should call reinit_frame_cache. */
61
62struct frame_info
63{
64 /* Level of this frame. The inner-most (youngest) frame is at level
65 0. As you move towards the outer-most (oldest) frame, the level
66 increases. This is a cached value. It could just as easily be
67 computed by counting back from the selected frame to the inner
68 most frame. */
bbde78fa 69 /* NOTE: cagney/2002-04-05: Perhaps a level of ``-1'' should be
bd013d54
AC
70 reserved to indicate a bogus frame - one that has been created
71 just to keep GDB happy (GDB always needs a frame). For the
72 moment leave this as speculation. */
73 int level;
74
6c95b8df
PA
75 /* The frame's program space. */
76 struct program_space *pspace;
77
78 /* The frame's address space. */
79 struct address_space *aspace;
80
bd013d54
AC
81 /* The frame's low-level unwinder and corresponding cache. The
82 low-level unwinder is responsible for unwinding register values
83 for the previous frame. The low-level unwind methods are
bbde78fa 84 selected based on the presence, or otherwise, of register unwind
bd013d54
AC
85 information such as CFI. */
86 void *prologue_cache;
87 const struct frame_unwind *unwind;
88
36f15f55
UW
89 /* Cached copy of the previous frame's architecture. */
90 struct
91 {
92 int p;
93 struct gdbarch *arch;
94 } prev_arch;
95
bd013d54
AC
96 /* Cached copy of the previous frame's resume address. */
97 struct {
98 int p;
99 CORE_ADDR value;
100 } prev_pc;
101
102 /* Cached copy of the previous frame's function address. */
103 struct
104 {
105 CORE_ADDR addr;
106 int p;
107 } prev_func;
108
109 /* This frame's ID. */
110 struct
111 {
112 int p;
113 struct frame_id value;
114 } this_id;
115
116 /* The frame's high-level base methods, and corresponding cache.
117 The high level base methods are selected based on the frame's
118 debug info. */
119 const struct frame_base *base;
120 void *base_cache;
121
122 /* Pointers to the next (down, inner, younger) and previous (up,
123 outer, older) frame_info's in the frame cache. */
124 struct frame_info *next; /* down, inner, younger */
125 int prev_p;
126 struct frame_info *prev; /* up, outer, older */
55feb689
DJ
127
128 /* The reason why we could not set PREV, or UNWIND_NO_REASON if we
129 could. Only valid when PREV_P is set. */
130 enum unwind_stop_reason stop_reason;
bd013d54
AC
131};
132
b83e9eb7
JB
133/* A frame stash used to speed up frame lookups. */
134
135/* We currently only stash one frame at a time, as this seems to be
136 sufficient for now. */
137static struct frame_info *frame_stash = NULL;
138
139/* Add the following FRAME to the frame stash. */
140
141static void
142frame_stash_add (struct frame_info *frame)
143{
144 frame_stash = frame;
145}
146
147/* Search the frame stash for an entry with the given frame ID.
148 If found, return that frame. Otherwise return NULL. */
149
150static struct frame_info *
151frame_stash_find (struct frame_id id)
152{
153 if (frame_stash && frame_id_eq (frame_stash->this_id.value, id))
154 return frame_stash;
155
156 return NULL;
157}
158
159/* Invalidate the frame stash by removing all entries in it. */
160
161static void
162frame_stash_invalidate (void)
163{
164 frame_stash = NULL;
165}
166
ac2bd0a9
AC
167/* Flag to control debugging. */
168
669fac23 169int frame_debug;
920d2a44
AC
170static void
171show_frame_debug (struct ui_file *file, int from_tty,
172 struct cmd_list_element *c, const char *value)
173{
174 fprintf_filtered (file, _("Frame debugging is %s.\n"), value);
175}
ac2bd0a9 176
25d29d70
AC
177/* Flag to indicate whether backtraces should stop at main et.al. */
178
179static int backtrace_past_main;
920d2a44
AC
180static void
181show_backtrace_past_main (struct ui_file *file, int from_tty,
182 struct cmd_list_element *c, const char *value)
183{
3e43a32a
MS
184 fprintf_filtered (file,
185 _("Whether backtraces should "
186 "continue past \"main\" is %s.\n"),
920d2a44
AC
187 value);
188}
189
2315ffec 190static int backtrace_past_entry;
920d2a44
AC
191static void
192show_backtrace_past_entry (struct ui_file *file, int from_tty,
193 struct cmd_list_element *c, const char *value)
194{
3e43a32a
MS
195 fprintf_filtered (file, _("Whether backtraces should continue past the "
196 "entry point of a program is %s.\n"),
920d2a44
AC
197 value);
198}
199
4a5e53e8 200static int backtrace_limit = INT_MAX;
920d2a44
AC
201static void
202show_backtrace_limit (struct ui_file *file, int from_tty,
203 struct cmd_list_element *c, const char *value)
204{
3e43a32a
MS
205 fprintf_filtered (file,
206 _("An upper bound on the number "
207 "of backtrace levels is %s.\n"),
920d2a44
AC
208 value);
209}
210
eb4f72c5 211
ca73dd9d
AC
212static void
213fprint_field (struct ui_file *file, const char *name, int p, CORE_ADDR addr)
214{
215 if (p)
5af949e3 216 fprintf_unfiltered (file, "%s=%s", name, hex_string (addr));
ca73dd9d
AC
217 else
218 fprintf_unfiltered (file, "!%s", name);
219}
d65fe839 220
00905d52 221void
7f78e237
AC
222fprint_frame_id (struct ui_file *file, struct frame_id id)
223{
ca73dd9d
AC
224 fprintf_unfiltered (file, "{");
225 fprint_field (file, "stack", id.stack_addr_p, id.stack_addr);
226 fprintf_unfiltered (file, ",");
227 fprint_field (file, "code", id.code_addr_p, id.code_addr);
228 fprintf_unfiltered (file, ",");
229 fprint_field (file, "special", id.special_addr_p, id.special_addr);
edb3359d
DJ
230 if (id.inline_depth)
231 fprintf_unfiltered (file, ",inlined=%d", id.inline_depth);
ca73dd9d 232 fprintf_unfiltered (file, "}");
7f78e237
AC
233}
234
235static void
236fprint_frame_type (struct ui_file *file, enum frame_type type)
237{
238 switch (type)
239 {
7f78e237
AC
240 case NORMAL_FRAME:
241 fprintf_unfiltered (file, "NORMAL_FRAME");
242 return;
243 case DUMMY_FRAME:
244 fprintf_unfiltered (file, "DUMMY_FRAME");
245 return;
edb3359d
DJ
246 case INLINE_FRAME:
247 fprintf_unfiltered (file, "INLINE_FRAME");
248 return;
249 case SENTINEL_FRAME:
250 fprintf_unfiltered (file, "SENTINEL_FRAME");
251 return;
7f78e237
AC
252 case SIGTRAMP_FRAME:
253 fprintf_unfiltered (file, "SIGTRAMP_FRAME");
254 return;
36f15f55
UW
255 case ARCH_FRAME:
256 fprintf_unfiltered (file, "ARCH_FRAME");
257 return;
7f78e237
AC
258 default:
259 fprintf_unfiltered (file, "<unknown type>");
260 return;
261 };
262}
263
264static void
265fprint_frame (struct ui_file *file, struct frame_info *fi)
266{
267 if (fi == NULL)
268 {
269 fprintf_unfiltered (file, "<NULL frame>");
270 return;
271 }
272 fprintf_unfiltered (file, "{");
273 fprintf_unfiltered (file, "level=%d", fi->level);
274 fprintf_unfiltered (file, ",");
275 fprintf_unfiltered (file, "type=");
c1bf6f65
AC
276 if (fi->unwind != NULL)
277 fprint_frame_type (file, fi->unwind->type);
278 else
279 fprintf_unfiltered (file, "<unknown>");
7f78e237
AC
280 fprintf_unfiltered (file, ",");
281 fprintf_unfiltered (file, "unwind=");
282 if (fi->unwind != NULL)
283 gdb_print_host_address (fi->unwind, file);
284 else
285 fprintf_unfiltered (file, "<unknown>");
286 fprintf_unfiltered (file, ",");
287 fprintf_unfiltered (file, "pc=");
288 if (fi->next != NULL && fi->next->prev_pc.p)
5af949e3 289 fprintf_unfiltered (file, "%s", hex_string (fi->next->prev_pc.value));
7f78e237
AC
290 else
291 fprintf_unfiltered (file, "<unknown>");
292 fprintf_unfiltered (file, ",");
293 fprintf_unfiltered (file, "id=");
294 if (fi->this_id.p)
295 fprint_frame_id (file, fi->this_id.value);
296 else
297 fprintf_unfiltered (file, "<unknown>");
298 fprintf_unfiltered (file, ",");
299 fprintf_unfiltered (file, "func=");
300 if (fi->next != NULL && fi->next->prev_func.p)
5af949e3 301 fprintf_unfiltered (file, "%s", hex_string (fi->next->prev_func.addr));
7f78e237
AC
302 else
303 fprintf_unfiltered (file, "<unknown>");
304 fprintf_unfiltered (file, "}");
305}
306
edb3359d
DJ
307/* Given FRAME, return the enclosing normal frame for inlined
308 function frames. Otherwise return the original frame. */
309
310static struct frame_info *
311skip_inlined_frames (struct frame_info *frame)
312{
313 while (get_frame_type (frame) == INLINE_FRAME)
314 frame = get_prev_frame (frame);
315
316 return frame;
317}
318
7a424e99 319/* Return a frame uniq ID that can be used to, later, re-find the
101dcfbe
AC
320 frame. */
321
7a424e99
AC
322struct frame_id
323get_frame_id (struct frame_info *fi)
101dcfbe
AC
324{
325 if (fi == NULL)
b83e9eb7
JB
326 return null_frame_id;
327
d0a55772 328 if (!fi->this_id.p)
101dcfbe 329 {
7f78e237
AC
330 if (frame_debug)
331 fprintf_unfiltered (gdb_stdlog, "{ get_frame_id (fi=%d) ",
332 fi->level);
c50901fd
AC
333 /* Find the unwinder. */
334 if (fi->unwind == NULL)
9f9a8002 335 frame_unwind_find_by_frame (fi, &fi->prologue_cache);
06c77151 336 /* Find THIS frame's ID. */
005ca36a
JB
337 /* Default to outermost if no ID is found. */
338 fi->this_id.value = outer_frame_id;
669fac23 339 fi->unwind->this_id (fi, &fi->prologue_cache, &fi->this_id.value);
005ca36a 340 gdb_assert (frame_id_p (fi->this_id.value));
d0a55772 341 fi->this_id.p = 1;
7f78e237
AC
342 if (frame_debug)
343 {
344 fprintf_unfiltered (gdb_stdlog, "-> ");
345 fprint_frame_id (gdb_stdlog, fi->this_id.value);
346 fprintf_unfiltered (gdb_stdlog, " }\n");
347 }
101dcfbe 348 }
b83e9eb7
JB
349
350 frame_stash_add (fi);
351
18adea3f 352 return fi->this_id.value;
101dcfbe
AC
353}
354
edb3359d
DJ
355struct frame_id
356get_stack_frame_id (struct frame_info *next_frame)
357{
358 return get_frame_id (skip_inlined_frames (next_frame));
359}
360
5613d8d3 361struct frame_id
c7ce8faa 362frame_unwind_caller_id (struct frame_info *next_frame)
5613d8d3 363{
edb3359d
DJ
364 struct frame_info *this_frame;
365
366 /* Use get_prev_frame_1, and not get_prev_frame. The latter will truncate
5613d8d3
AC
367 the frame chain, leading to this function unintentionally
368 returning a null_frame_id (e.g., when a caller requests the frame
369 ID of "main()"s caller. */
edb3359d
DJ
370
371 next_frame = skip_inlined_frames (next_frame);
372 this_frame = get_prev_frame_1 (next_frame);
373 if (this_frame)
374 return get_frame_id (skip_inlined_frames (this_frame));
375 else
376 return null_frame_id;
5613d8d3
AC
377}
378
7a424e99 379const struct frame_id null_frame_id; /* All zeros. */
005ca36a 380const struct frame_id outer_frame_id = { 0, 0, 0, 0, 0, 1, 0 };
7a424e99
AC
381
382struct frame_id
48c66725
JJ
383frame_id_build_special (CORE_ADDR stack_addr, CORE_ADDR code_addr,
384 CORE_ADDR special_addr)
7a424e99 385{
12b0b6de 386 struct frame_id id = null_frame_id;
1c4d3f96 387
d0a55772 388 id.stack_addr = stack_addr;
12b0b6de 389 id.stack_addr_p = 1;
d0a55772 390 id.code_addr = code_addr;
12b0b6de 391 id.code_addr_p = 1;
48c66725 392 id.special_addr = special_addr;
12b0b6de 393 id.special_addr_p = 1;
7a424e99
AC
394 return id;
395}
396
48c66725
JJ
397struct frame_id
398frame_id_build (CORE_ADDR stack_addr, CORE_ADDR code_addr)
399{
12b0b6de 400 struct frame_id id = null_frame_id;
1c4d3f96 401
12b0b6de
UW
402 id.stack_addr = stack_addr;
403 id.stack_addr_p = 1;
404 id.code_addr = code_addr;
405 id.code_addr_p = 1;
406 return id;
407}
408
409struct frame_id
410frame_id_build_wild (CORE_ADDR stack_addr)
411{
412 struct frame_id id = null_frame_id;
1c4d3f96 413
12b0b6de
UW
414 id.stack_addr = stack_addr;
415 id.stack_addr_p = 1;
416 return id;
48c66725
JJ
417}
418
7a424e99
AC
419int
420frame_id_p (struct frame_id l)
421{
d0a55772 422 int p;
1c4d3f96 423
12b0b6de
UW
424 /* The frame is valid iff it has a valid stack address. */
425 p = l.stack_addr_p;
005ca36a
JB
426 /* outer_frame_id is also valid. */
427 if (!p && memcmp (&l, &outer_frame_id, sizeof (l)) == 0)
428 p = 1;
7f78e237
AC
429 if (frame_debug)
430 {
431 fprintf_unfiltered (gdb_stdlog, "{ frame_id_p (l=");
432 fprint_frame_id (gdb_stdlog, l);
433 fprintf_unfiltered (gdb_stdlog, ") -> %d }\n", p);
434 }
d0a55772 435 return p;
7a424e99
AC
436}
437
edb3359d
DJ
438int
439frame_id_inlined_p (struct frame_id l)
440{
441 if (!frame_id_p (l))
442 return 0;
443
444 return (l.inline_depth != 0);
445}
446
7a424e99
AC
447int
448frame_id_eq (struct frame_id l, struct frame_id r)
449{
d0a55772 450 int eq;
1c4d3f96 451
3e43a32a
MS
452 if (!l.stack_addr_p && l.special_addr_p
453 && !r.stack_addr_p && r.special_addr_p)
005ca36a
JB
454 /* The outermost frame marker is equal to itself. This is the
455 dodgy thing about outer_frame_id, since between execution steps
456 we might step into another function - from which we can't
457 unwind either. More thought required to get rid of
458 outer_frame_id. */
459 eq = 1;
460 else if (!l.stack_addr_p || !r.stack_addr_p)
12b0b6de
UW
461 /* Like a NaN, if either ID is invalid, the result is false.
462 Note that a frame ID is invalid iff it is the null frame ID. */
d0a55772
AC
463 eq = 0;
464 else if (l.stack_addr != r.stack_addr)
465 /* If .stack addresses are different, the frames are different. */
466 eq = 0;
edb3359d
DJ
467 else if (l.code_addr_p && r.code_addr_p && l.code_addr != r.code_addr)
468 /* An invalid code addr is a wild card. If .code addresses are
469 different, the frames are different. */
48c66725 470 eq = 0;
edb3359d
DJ
471 else if (l.special_addr_p && r.special_addr_p
472 && l.special_addr != r.special_addr)
473 /* An invalid special addr is a wild card (or unused). Otherwise
474 if special addresses are different, the frames are different. */
475 eq = 0;
476 else if (l.inline_depth != r.inline_depth)
477 /* If inline depths are different, the frames must be different. */
478 eq = 0;
479 else
48c66725 480 /* Frames are equal. */
d0a55772 481 eq = 1;
edb3359d 482
7f78e237
AC
483 if (frame_debug)
484 {
485 fprintf_unfiltered (gdb_stdlog, "{ frame_id_eq (l=");
486 fprint_frame_id (gdb_stdlog, l);
487 fprintf_unfiltered (gdb_stdlog, ",r=");
488 fprint_frame_id (gdb_stdlog, r);
489 fprintf_unfiltered (gdb_stdlog, ") -> %d }\n", eq);
490 }
d0a55772 491 return eq;
7a424e99
AC
492}
493
a45ae3ed
UW
494/* Safety net to check whether frame ID L should be inner to
495 frame ID R, according to their stack addresses.
496
497 This method cannot be used to compare arbitrary frames, as the
498 ranges of valid stack addresses may be discontiguous (e.g. due
499 to sigaltstack).
500
501 However, it can be used as safety net to discover invalid frame
0963b4bd 502 IDs in certain circumstances. Assuming that NEXT is the immediate
f06eadd9 503 inner frame to THIS and that NEXT and THIS are both NORMAL frames:
a45ae3ed 504
f06eadd9
JB
505 * The stack address of NEXT must be inner-than-or-equal to the stack
506 address of THIS.
a45ae3ed
UW
507
508 Therefore, if frame_id_inner (THIS, NEXT) holds, some unwind
509 error has occurred.
510
f06eadd9
JB
511 * If NEXT and THIS have different stack addresses, no other frame
512 in the frame chain may have a stack address in between.
a45ae3ed
UW
513
514 Therefore, if frame_id_inner (TEST, THIS) holds, but
515 frame_id_inner (TEST, NEXT) does not hold, TEST cannot refer
f06eadd9
JB
516 to a valid frame in the frame chain.
517
518 The sanity checks above cannot be performed when a SIGTRAMP frame
519 is involved, because signal handlers might be executed on a different
520 stack than the stack used by the routine that caused the signal
521 to be raised. This can happen for instance when a thread exceeds
0963b4bd 522 its maximum stack size. In this case, certain compilers implement
f06eadd9
JB
523 a stack overflow strategy that cause the handler to be run on a
524 different stack. */
a45ae3ed
UW
525
526static int
09a7aba8 527frame_id_inner (struct gdbarch *gdbarch, struct frame_id l, struct frame_id r)
7a424e99 528{
d0a55772 529 int inner;
1c4d3f96 530
12b0b6de 531 if (!l.stack_addr_p || !r.stack_addr_p)
d0a55772
AC
532 /* Like NaN, any operation involving an invalid ID always fails. */
533 inner = 0;
edb3359d
DJ
534 else if (l.inline_depth > r.inline_depth
535 && l.stack_addr == r.stack_addr
536 && l.code_addr_p == r.code_addr_p
537 && l.special_addr_p == r.special_addr_p
538 && l.special_addr == r.special_addr)
539 {
540 /* Same function, different inlined functions. */
541 struct block *lb, *rb;
542
543 gdb_assert (l.code_addr_p && r.code_addr_p);
544
545 lb = block_for_pc (l.code_addr);
546 rb = block_for_pc (r.code_addr);
547
548 if (lb == NULL || rb == NULL)
549 /* Something's gone wrong. */
550 inner = 0;
551 else
552 /* This will return true if LB and RB are the same block, or
553 if the block with the smaller depth lexically encloses the
554 block with the greater depth. */
555 inner = contained_in (lb, rb);
556 }
d0a55772
AC
557 else
558 /* Only return non-zero when strictly inner than. Note that, per
559 comment in "frame.h", there is some fuzz here. Frameless
560 functions are not strictly inner than (same .stack but
48c66725 561 different .code and/or .special address). */
09a7aba8 562 inner = gdbarch_inner_than (gdbarch, l.stack_addr, r.stack_addr);
7f78e237
AC
563 if (frame_debug)
564 {
565 fprintf_unfiltered (gdb_stdlog, "{ frame_id_inner (l=");
566 fprint_frame_id (gdb_stdlog, l);
567 fprintf_unfiltered (gdb_stdlog, ",r=");
568 fprint_frame_id (gdb_stdlog, r);
569 fprintf_unfiltered (gdb_stdlog, ") -> %d }\n", inner);
570 }
d0a55772 571 return inner;
7a424e99
AC
572}
573
101dcfbe
AC
574struct frame_info *
575frame_find_by_id (struct frame_id id)
576{
a45ae3ed 577 struct frame_info *frame, *prev_frame;
101dcfbe
AC
578
579 /* ZERO denotes the null frame, let the caller decide what to do
580 about it. Should it instead return get_current_frame()? */
7a424e99 581 if (!frame_id_p (id))
101dcfbe
AC
582 return NULL;
583
b83e9eb7
JB
584 /* Try using the frame stash first. Finding it there removes the need
585 to perform the search by looping over all frames, which can be very
586 CPU-intensive if the number of frames is very high (the loop is O(n)
587 and get_prev_frame performs a series of checks that are relatively
588 expensive). This optimization is particularly useful when this function
589 is called from another function (such as value_fetch_lazy, case
590 VALUE_LVAL (val) == lval_register) which already loops over all frames,
591 making the overall behavior O(n^2). */
592 frame = frame_stash_find (id);
593 if (frame)
594 return frame;
595
a45ae3ed 596 for (frame = get_current_frame (); ; frame = prev_frame)
101dcfbe 597 {
7a424e99 598 struct frame_id this = get_frame_id (frame);
bb9bcb69 599
7a424e99
AC
600 if (frame_id_eq (id, this))
601 /* An exact match. */
602 return frame;
a45ae3ed
UW
603
604 prev_frame = get_prev_frame (frame);
605 if (!prev_frame)
606 return NULL;
607
608 /* As a safety net to avoid unnecessary backtracing while trying
609 to find an invalid ID, we check for a common situation where
610 we can detect from comparing stack addresses that no other
611 frame in the current frame chain can have this ID. See the
612 comment at frame_id_inner for details. */
613 if (get_frame_type (frame) == NORMAL_FRAME
614 && !frame_id_inner (get_frame_arch (frame), id, this)
615 && frame_id_inner (get_frame_arch (prev_frame), id,
616 get_frame_id (prev_frame)))
101dcfbe 617 return NULL;
101dcfbe
AC
618 }
619 return NULL;
620}
621
edb3359d
DJ
622static CORE_ADDR
623frame_unwind_pc (struct frame_info *this_frame)
f18c5a73 624{
d1340264 625 if (!this_frame->prev_pc.p)
f18c5a73 626 {
12cc2063 627 CORE_ADDR pc;
bb9bcb69 628
36f15f55 629 if (gdbarch_unwind_pc_p (frame_unwind_arch (this_frame)))
12cc2063
AC
630 {
631 /* The right way. The `pure' way. The one true way. This
632 method depends solely on the register-unwind code to
633 determine the value of registers in THIS frame, and hence
634 the value of this frame's PC (resume address). A typical
635 implementation is no more than:
636
637 frame_unwind_register (this_frame, ISA_PC_REGNUM, buf);
af1342ab 638 return extract_unsigned_integer (buf, size of ISA_PC_REGNUM);
12cc2063
AC
639
640 Note: this method is very heavily dependent on a correct
641 register-unwind implementation, it pays to fix that
642 method first; this method is frame type agnostic, since
643 it only deals with register values, it works with any
644 frame. This is all in stark contrast to the old
645 FRAME_SAVED_PC which would try to directly handle all the
646 different ways that a PC could be unwound. */
36f15f55 647 pc = gdbarch_unwind_pc (frame_unwind_arch (this_frame), this_frame);
12cc2063 648 }
12cc2063 649 else
e2e0b3e5 650 internal_error (__FILE__, __LINE__, _("No unwind_pc method"));
d1340264
AC
651 this_frame->prev_pc.value = pc;
652 this_frame->prev_pc.p = 1;
7f78e237
AC
653 if (frame_debug)
654 fprintf_unfiltered (gdb_stdlog,
3e43a32a
MS
655 "{ frame_unwind_caller_pc "
656 "(this_frame=%d) -> %s }\n",
7f78e237 657 this_frame->level,
5af949e3 658 hex_string (this_frame->prev_pc.value));
f18c5a73 659 }
d1340264 660 return this_frame->prev_pc.value;
f18c5a73
AC
661}
662
edb3359d
DJ
663CORE_ADDR
664frame_unwind_caller_pc (struct frame_info *this_frame)
665{
666 return frame_unwind_pc (skip_inlined_frames (this_frame));
667}
668
be41e9f4 669CORE_ADDR
ef02daa9 670get_frame_func (struct frame_info *this_frame)
be41e9f4 671{
ef02daa9
DJ
672 struct frame_info *next_frame = this_frame->next;
673
674 if (!next_frame->prev_func.p)
be41e9f4 675 {
57bfe177
AC
676 /* Make certain that this, and not the adjacent, function is
677 found. */
ef02daa9
DJ
678 CORE_ADDR addr_in_block = get_frame_address_in_block (this_frame);
679 next_frame->prev_func.p = 1;
680 next_frame->prev_func.addr = get_pc_function_start (addr_in_block);
7f78e237
AC
681 if (frame_debug)
682 fprintf_unfiltered (gdb_stdlog,
5af949e3 683 "{ get_frame_func (this_frame=%d) -> %s }\n",
ef02daa9 684 this_frame->level,
5af949e3 685 hex_string (next_frame->prev_func.addr));
be41e9f4 686 }
ef02daa9 687 return next_frame->prev_func.addr;
be41e9f4
AC
688}
689
7a25a7c1 690static int
2d522557 691do_frame_register_read (void *src, int regnum, gdb_byte *buf)
7a25a7c1 692{
669fac23 693 return frame_register_read (src, regnum, buf);
7a25a7c1
AC
694}
695
a81dcb05
AC
696struct regcache *
697frame_save_as_regcache (struct frame_info *this_frame)
698{
d37346f0
DJ
699 struct address_space *aspace = get_frame_address_space (this_frame);
700 struct regcache *regcache = regcache_xmalloc (get_frame_arch (this_frame),
701 aspace);
a81dcb05 702 struct cleanup *cleanups = make_cleanup_regcache_xfree (regcache);
1c4d3f96 703
a81dcb05
AC
704 regcache_save (regcache, do_frame_register_read, this_frame);
705 discard_cleanups (cleanups);
706 return regcache;
707}
708
dbe9fe58 709void
7a25a7c1
AC
710frame_pop (struct frame_info *this_frame)
711{
348473d5
NF
712 struct frame_info *prev_frame;
713 struct regcache *scratch;
714 struct cleanup *cleanups;
715
b89667eb
DE
716 if (get_frame_type (this_frame) == DUMMY_FRAME)
717 {
718 /* Popping a dummy frame involves restoring more than just registers.
719 dummy_frame_pop does all the work. */
720 dummy_frame_pop (get_frame_id (this_frame));
721 return;
722 }
723
348473d5
NF
724 /* Ensure that we have a frame to pop to. */
725 prev_frame = get_prev_frame_1 (this_frame);
726
727 if (!prev_frame)
728 error (_("Cannot pop the initial frame."));
729
c1bf6f65
AC
730 /* Make a copy of all the register values unwound from this frame.
731 Save them in a scratch buffer so that there isn't a race between
594f7785 732 trying to extract the old values from the current regcache while
c1bf6f65 733 at the same time writing new values into that same cache. */
348473d5
NF
734 scratch = frame_save_as_regcache (prev_frame);
735 cleanups = make_cleanup_regcache_xfree (scratch);
c1bf6f65
AC
736
737 /* FIXME: cagney/2003-03-16: It should be possible to tell the
738 target's register cache that it is about to be hit with a burst
739 register transfer and that the sequence of register writes should
740 be batched. The pair target_prepare_to_store() and
741 target_store_registers() kind of suggest this functionality.
742 Unfortunately, they don't implement it. Their lack of a formal
743 definition can lead to targets writing back bogus values
744 (arguably a bug in the target code mind). */
745 /* Now copy those saved registers into the current regcache.
746 Here, regcache_cpy() calls regcache_restore(). */
594f7785 747 regcache_cpy (get_current_regcache (), scratch);
c1bf6f65 748 do_cleanups (cleanups);
7a25a7c1 749
7a25a7c1
AC
750 /* We've made right mess of GDB's local state, just discard
751 everything. */
35f196d9 752 reinit_frame_cache ();
dbe9fe58 753}
c689142b 754
4f460812
AC
755void
756frame_register_unwind (struct frame_info *frame, int regnum,
757 int *optimizedp, enum lval_type *lvalp,
10c42a71 758 CORE_ADDR *addrp, int *realnump, gdb_byte *bufferp)
4f460812 759{
669fac23 760 struct value *value;
7f78e237 761
4f460812
AC
762 /* Require all but BUFFERP to be valid. A NULL BUFFERP indicates
763 that the value proper does not need to be fetched. */
764 gdb_assert (optimizedp != NULL);
765 gdb_assert (lvalp != NULL);
766 gdb_assert (addrp != NULL);
767 gdb_assert (realnump != NULL);
768 /* gdb_assert (bufferp != NULL); */
769
669fac23 770 value = frame_unwind_register_value (frame, regnum);
4f460812 771
669fac23 772 gdb_assert (value != NULL);
c50901fd 773
669fac23
DJ
774 *optimizedp = value_optimized_out (value);
775 *lvalp = VALUE_LVAL (value);
42ae5230 776 *addrp = value_address (value);
669fac23 777 *realnump = VALUE_REGNUM (value);
6dc42492 778
21a176fb 779 if (bufferp && !*optimizedp)
669fac23
DJ
780 memcpy (bufferp, value_contents_all (value),
781 TYPE_LENGTH (value_type (value)));
782
783 /* Dispose of the new value. This prevents watchpoints from
784 trying to watch the saved frame pointer. */
785 release_value (value);
786 value_free (value);
4f460812
AC
787}
788
a216a322
AC
789void
790frame_register (struct frame_info *frame, int regnum,
791 int *optimizedp, enum lval_type *lvalp,
10c42a71 792 CORE_ADDR *addrp, int *realnump, gdb_byte *bufferp)
a216a322
AC
793{
794 /* Require all but BUFFERP to be valid. A NULL BUFFERP indicates
795 that the value proper does not need to be fetched. */
796 gdb_assert (optimizedp != NULL);
797 gdb_assert (lvalp != NULL);
798 gdb_assert (addrp != NULL);
799 gdb_assert (realnump != NULL);
800 /* gdb_assert (bufferp != NULL); */
801
a94dd1fd
AC
802 /* Obtain the register value by unwinding the register from the next
803 (more inner frame). */
804 gdb_assert (frame != NULL && frame->next != NULL);
805 frame_register_unwind (frame->next, regnum, optimizedp, lvalp, addrp,
806 realnump, bufferp);
a216a322
AC
807}
808
135c175f 809void
10c42a71 810frame_unwind_register (struct frame_info *frame, int regnum, gdb_byte *buf)
135c175f
AC
811{
812 int optimized;
813 CORE_ADDR addr;
814 int realnum;
815 enum lval_type lval;
1c4d3f96 816
135c175f
AC
817 frame_register_unwind (frame, regnum, &optimized, &lval, &addr,
818 &realnum, buf);
5b181d62
AC
819}
820
f0e7d0e8
AC
821void
822get_frame_register (struct frame_info *frame,
10c42a71 823 int regnum, gdb_byte *buf)
f0e7d0e8
AC
824{
825 frame_unwind_register (frame->next, regnum, buf);
826}
827
669fac23
DJ
828struct value *
829frame_unwind_register_value (struct frame_info *frame, int regnum)
830{
36f15f55 831 struct gdbarch *gdbarch;
669fac23
DJ
832 struct value *value;
833
834 gdb_assert (frame != NULL);
36f15f55 835 gdbarch = frame_unwind_arch (frame);
669fac23
DJ
836
837 if (frame_debug)
838 {
3e43a32a
MS
839 fprintf_unfiltered (gdb_stdlog,
840 "{ frame_unwind_register_value "
841 "(frame=%d,regnum=%d(%s),...) ",
669fac23 842 frame->level, regnum,
36f15f55 843 user_reg_map_regnum_to_name (gdbarch, regnum));
669fac23
DJ
844 }
845
846 /* Find the unwinder. */
847 if (frame->unwind == NULL)
9f9a8002 848 frame_unwind_find_by_frame (frame, &frame->prologue_cache);
669fac23
DJ
849
850 /* Ask this frame to unwind its register. */
851 value = frame->unwind->prev_register (frame, &frame->prologue_cache, regnum);
852
853 if (frame_debug)
854 {
855 fprintf_unfiltered (gdb_stdlog, "->");
856 if (value_optimized_out (value))
857 fprintf_unfiltered (gdb_stdlog, " optimized out");
858 else
859 {
860 if (VALUE_LVAL (value) == lval_register)
861 fprintf_unfiltered (gdb_stdlog, " register=%d",
862 VALUE_REGNUM (value));
863 else if (VALUE_LVAL (value) == lval_memory)
5af949e3
UW
864 fprintf_unfiltered (gdb_stdlog, " address=%s",
865 paddress (gdbarch,
866 value_address (value)));
669fac23
DJ
867 else
868 fprintf_unfiltered (gdb_stdlog, " computed");
869
870 if (value_lazy (value))
871 fprintf_unfiltered (gdb_stdlog, " lazy");
872 else
873 {
874 int i;
875 const gdb_byte *buf = value_contents (value);
876
877 fprintf_unfiltered (gdb_stdlog, " bytes=");
878 fprintf_unfiltered (gdb_stdlog, "[");
36f15f55 879 for (i = 0; i < register_size (gdbarch, regnum); i++)
669fac23
DJ
880 fprintf_unfiltered (gdb_stdlog, "%02x", buf[i]);
881 fprintf_unfiltered (gdb_stdlog, "]");
882 }
883 }
884
885 fprintf_unfiltered (gdb_stdlog, " }\n");
886 }
887
888 return value;
889}
890
891struct value *
892get_frame_register_value (struct frame_info *frame, int regnum)
893{
894 return frame_unwind_register_value (frame->next, regnum);
895}
896
f0e7d0e8
AC
897LONGEST
898frame_unwind_register_signed (struct frame_info *frame, int regnum)
899{
e17a4113
UW
900 struct gdbarch *gdbarch = frame_unwind_arch (frame);
901 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
902 int size = register_size (gdbarch, regnum);
10c42a71 903 gdb_byte buf[MAX_REGISTER_SIZE];
1c4d3f96 904
f0e7d0e8 905 frame_unwind_register (frame, regnum, buf);
e17a4113 906 return extract_signed_integer (buf, size, byte_order);
f0e7d0e8
AC
907}
908
909LONGEST
910get_frame_register_signed (struct frame_info *frame, int regnum)
911{
912 return frame_unwind_register_signed (frame->next, regnum);
913}
914
915ULONGEST
916frame_unwind_register_unsigned (struct frame_info *frame, int regnum)
917{
e17a4113
UW
918 struct gdbarch *gdbarch = frame_unwind_arch (frame);
919 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
920 int size = register_size (gdbarch, regnum);
10c42a71 921 gdb_byte buf[MAX_REGISTER_SIZE];
1c4d3f96 922
f0e7d0e8 923 frame_unwind_register (frame, regnum, buf);
e17a4113 924 return extract_unsigned_integer (buf, size, byte_order);
f0e7d0e8
AC
925}
926
927ULONGEST
928get_frame_register_unsigned (struct frame_info *frame, int regnum)
929{
930 return frame_unwind_register_unsigned (frame->next, regnum);
931}
932
ff2e87ac 933void
10c42a71
AC
934put_frame_register (struct frame_info *frame, int regnum,
935 const gdb_byte *buf)
ff2e87ac
AC
936{
937 struct gdbarch *gdbarch = get_frame_arch (frame);
938 int realnum;
939 int optim;
940 enum lval_type lval;
941 CORE_ADDR addr;
1c4d3f96 942
ff2e87ac
AC
943 frame_register (frame, regnum, &optim, &lval, &addr, &realnum, NULL);
944 if (optim)
8a3fe4f8 945 error (_("Attempt to assign to a value that was optimized out."));
ff2e87ac
AC
946 switch (lval)
947 {
948 case lval_memory:
949 {
950 /* FIXME: write_memory doesn't yet take constant buffers.
951 Arrrg! */
10c42a71 952 gdb_byte tmp[MAX_REGISTER_SIZE];
bb9bcb69 953
ff2e87ac
AC
954 memcpy (tmp, buf, register_size (gdbarch, regnum));
955 write_memory (addr, tmp, register_size (gdbarch, regnum));
956 break;
957 }
958 case lval_register:
594f7785 959 regcache_cooked_write (get_current_regcache (), realnum, buf);
ff2e87ac
AC
960 break;
961 default:
8a3fe4f8 962 error (_("Attempt to assign to an unmodifiable value."));
ff2e87ac
AC
963 }
964}
965
cda5a58a 966/* frame_register_read ()
d65fe839 967
cda5a58a 968 Find and return the value of REGNUM for the specified stack frame.
5bc602c7 969 The number of bytes copied is REGISTER_SIZE (REGNUM).
d65fe839 970
cda5a58a 971 Returns 0 if the register value could not be found. */
d65fe839 972
cda5a58a 973int
10c42a71
AC
974frame_register_read (struct frame_info *frame, int regnum,
975 gdb_byte *myaddr)
d65fe839 976{
a216a322
AC
977 int optimized;
978 enum lval_type lval;
979 CORE_ADDR addr;
980 int realnum;
1c4d3f96 981
a216a322 982 frame_register (frame, regnum, &optimized, &lval, &addr, &realnum, myaddr);
d65fe839 983
a216a322 984 return !optimized;
d65fe839 985}
e36180d7 986
00fa51f6
UW
987int
988get_frame_register_bytes (struct frame_info *frame, int regnum,
989 CORE_ADDR offset, int len, gdb_byte *myaddr)
990{
991 struct gdbarch *gdbarch = get_frame_arch (frame);
3f27f2a4
AS
992 int i;
993 int maxsize;
68e007ca 994 int numregs;
00fa51f6
UW
995
996 /* Skip registers wholly inside of OFFSET. */
997 while (offset >= register_size (gdbarch, regnum))
998 {
999 offset -= register_size (gdbarch, regnum);
1000 regnum++;
1001 }
1002
26fae1d6
AS
1003 /* Ensure that we will not read beyond the end of the register file.
1004 This can only ever happen if the debug information is bad. */
3f27f2a4 1005 maxsize = -offset;
68e007ca
AS
1006 numregs = gdbarch_num_regs (gdbarch) + gdbarch_num_pseudo_regs (gdbarch);
1007 for (i = regnum; i < numregs; i++)
3f27f2a4
AS
1008 {
1009 int thissize = register_size (gdbarch, i);
bb9bcb69 1010
3f27f2a4 1011 if (thissize == 0)
26fae1d6 1012 break; /* This register is not available on this architecture. */
3f27f2a4
AS
1013 maxsize += thissize;
1014 }
1015 if (len > maxsize)
1016 {
1017 warning (_("Bad debug information detected: "
1018 "Attempt to read %d bytes from registers."), len);
1019 return 0;
1020 }
1021
00fa51f6
UW
1022 /* Copy the data. */
1023 while (len > 0)
1024 {
1025 int curr_len = register_size (gdbarch, regnum) - offset;
bb9bcb69 1026
00fa51f6
UW
1027 if (curr_len > len)
1028 curr_len = len;
1029
1030 if (curr_len == register_size (gdbarch, regnum))
1031 {
1032 if (!frame_register_read (frame, regnum, myaddr))
1033 return 0;
1034 }
1035 else
1036 {
1037 gdb_byte buf[MAX_REGISTER_SIZE];
bb9bcb69 1038
00fa51f6
UW
1039 if (!frame_register_read (frame, regnum, buf))
1040 return 0;
1041 memcpy (myaddr, buf + offset, curr_len);
1042 }
1043
765f065a 1044 myaddr += curr_len;
00fa51f6
UW
1045 len -= curr_len;
1046 offset = 0;
1047 regnum++;
1048 }
1049
1050 return 1;
1051}
1052
1053void
1054put_frame_register_bytes (struct frame_info *frame, int regnum,
1055 CORE_ADDR offset, int len, const gdb_byte *myaddr)
1056{
1057 struct gdbarch *gdbarch = get_frame_arch (frame);
1058
1059 /* Skip registers wholly inside of OFFSET. */
1060 while (offset >= register_size (gdbarch, regnum))
1061 {
1062 offset -= register_size (gdbarch, regnum);
1063 regnum++;
1064 }
1065
1066 /* Copy the data. */
1067 while (len > 0)
1068 {
1069 int curr_len = register_size (gdbarch, regnum) - offset;
bb9bcb69 1070
00fa51f6
UW
1071 if (curr_len > len)
1072 curr_len = len;
1073
1074 if (curr_len == register_size (gdbarch, regnum))
1075 {
1076 put_frame_register (frame, regnum, myaddr);
1077 }
1078 else
1079 {
1080 gdb_byte buf[MAX_REGISTER_SIZE];
bb9bcb69 1081
00fa51f6
UW
1082 frame_register_read (frame, regnum, buf);
1083 memcpy (buf + offset, myaddr, curr_len);
1084 put_frame_register (frame, regnum, buf);
1085 }
1086
765f065a 1087 myaddr += curr_len;
00fa51f6
UW
1088 len -= curr_len;
1089 offset = 0;
1090 regnum++;
1091 }
1092}
e36180d7 1093
a94dd1fd
AC
1094/* Create a sentinel frame. */
1095
b9362cc7 1096static struct frame_info *
6c95b8df 1097create_sentinel_frame (struct program_space *pspace, struct regcache *regcache)
a94dd1fd
AC
1098{
1099 struct frame_info *frame = FRAME_OBSTACK_ZALLOC (struct frame_info);
1c4d3f96 1100
a94dd1fd 1101 frame->level = -1;
6c95b8df
PA
1102 frame->pspace = pspace;
1103 frame->aspace = get_regcache_aspace (regcache);
a94dd1fd
AC
1104 /* Explicitly initialize the sentinel frame's cache. Provide it
1105 with the underlying regcache. In the future additional
1106 information, such as the frame's thread will be added. */
6dc42492 1107 frame->prologue_cache = sentinel_frame_cache (regcache);
a94dd1fd 1108 /* For the moment there is only one sentinel frame implementation. */
39d7b0e2 1109 frame->unwind = &sentinel_frame_unwind;
a94dd1fd
AC
1110 /* Link this frame back to itself. The frame is self referential
1111 (the unwound PC is the same as the pc), so make it so. */
1112 frame->next = frame;
50bbdbd9
AC
1113 /* Make the sentinel frame's ID valid, but invalid. That way all
1114 comparisons with it should fail. */
d0a55772
AC
1115 frame->this_id.p = 1;
1116 frame->this_id.value = null_frame_id;
7f78e237
AC
1117 if (frame_debug)
1118 {
1119 fprintf_unfiltered (gdb_stdlog, "{ create_sentinel_frame (...) -> ");
1120 fprint_frame (gdb_stdlog, frame);
1121 fprintf_unfiltered (gdb_stdlog, " }\n");
1122 }
a94dd1fd
AC
1123 return frame;
1124}
1125
0963b4bd 1126/* Info about the innermost stack frame (contents of FP register). */
4c1e7e9d
AC
1127
1128static struct frame_info *current_frame;
1129
1130/* Cache for frame addresses already read by gdb. Valid only while
1131 inferior is stopped. Control variables for the frame cache should
1132 be local to this module. */
1133
1134static struct obstack frame_cache_obstack;
1135
1136void *
479ab5a0 1137frame_obstack_zalloc (unsigned long size)
4c1e7e9d 1138{
479ab5a0 1139 void *data = obstack_alloc (&frame_cache_obstack, size);
1c4d3f96 1140
479ab5a0
AC
1141 memset (data, 0, size);
1142 return data;
4c1e7e9d
AC
1143}
1144
a94dd1fd
AC
1145/* Return the innermost (currently executing) stack frame. This is
1146 split into two functions. The function unwind_to_current_frame()
1147 is wrapped in catch exceptions so that, even when the unwind of the
1148 sentinel frame fails, the function still returns a stack frame. */
1149
1150static int
1151unwind_to_current_frame (struct ui_out *ui_out, void *args)
1152{
1153 struct frame_info *frame = get_prev_frame (args);
1c4d3f96 1154
bbde78fa 1155 /* A sentinel frame can fail to unwind, e.g., because its PC value
a94dd1fd
AC
1156 lands in somewhere like start. */
1157 if (frame == NULL)
1158 return 1;
1159 current_frame = frame;
1160 return 0;
1161}
4c1e7e9d
AC
1162
1163struct frame_info *
1164get_current_frame (void)
1165{
0a1e1ca1
AC
1166 /* First check, and report, the lack of registers. Having GDB
1167 report "No stack!" or "No memory" when the target doesn't even
1168 have registers is very confusing. Besides, "printcmd.exp"
1169 explicitly checks that ``print $pc'' with no registers prints "No
1170 registers". */
a94dd1fd 1171 if (!target_has_registers)
8a3fe4f8 1172 error (_("No registers."));
0a1e1ca1 1173 if (!target_has_stack)
8a3fe4f8 1174 error (_("No stack."));
a94dd1fd 1175 if (!target_has_memory)
8a3fe4f8 1176 error (_("No memory."));
2ce6d6bf
SS
1177 /* Traceframes are effectively a substitute for the live inferior. */
1178 if (get_traceframe_number () < 0)
1179 {
1180 if (ptid_equal (inferior_ptid, null_ptid))
1181 error (_("No selected thread."));
1182 if (is_exited (inferior_ptid))
1183 error (_("Invalid selected thread."));
1184 if (is_executing (inferior_ptid))
1185 error (_("Target is executing."));
1186 }
8ea051c5 1187
4c1e7e9d
AC
1188 if (current_frame == NULL)
1189 {
a94dd1fd 1190 struct frame_info *sentinel_frame =
6c95b8df 1191 create_sentinel_frame (current_program_space, get_current_regcache ());
a94dd1fd 1192 if (catch_exceptions (uiout, unwind_to_current_frame, sentinel_frame,
1c3c7ee7 1193 RETURN_MASK_ERROR) != 0)
a94dd1fd
AC
1194 {
1195 /* Oops! Fake a current frame? Is this useful? It has a PC
1196 of zero, for instance. */
1197 current_frame = sentinel_frame;
1198 }
4c1e7e9d
AC
1199 }
1200 return current_frame;
1201}
1202
6e7f8b9c
AC
1203/* The "selected" stack frame is used by default for local and arg
1204 access. May be zero, for no selected frame. */
1205
206415a3 1206static struct frame_info *selected_frame;
6e7f8b9c 1207
9d49bdc2 1208int
8ea051c5
PA
1209has_stack_frames (void)
1210{
1211 if (!target_has_registers || !target_has_stack || !target_has_memory)
1212 return 0;
1213
d729566a
PA
1214 /* No current inferior, no frame. */
1215 if (ptid_equal (inferior_ptid, null_ptid))
1216 return 0;
1217
1218 /* Don't try to read from a dead thread. */
1219 if (is_exited (inferior_ptid))
1220 return 0;
1221
1222 /* ... or from a spinning thread. */
8ea051c5
PA
1223 if (is_executing (inferior_ptid))
1224 return 0;
1225
1226 return 1;
1227}
1228
bbde78fa 1229/* Return the selected frame. Always non-NULL (unless there isn't an
6e7f8b9c
AC
1230 inferior sufficient for creating a frame) in which case an error is
1231 thrown. */
1232
1233struct frame_info *
b04f3ab4 1234get_selected_frame (const char *message)
6e7f8b9c 1235{
206415a3 1236 if (selected_frame == NULL)
b04f3ab4 1237 {
8ea051c5 1238 if (message != NULL && !has_stack_frames ())
8a3fe4f8 1239 error (("%s"), message);
b04f3ab4
AC
1240 /* Hey! Don't trust this. It should really be re-finding the
1241 last selected frame of the currently selected thread. This,
1242 though, is better than nothing. */
1243 select_frame (get_current_frame ());
1244 }
6e7f8b9c 1245 /* There is always a frame. */
206415a3
DJ
1246 gdb_assert (selected_frame != NULL);
1247 return selected_frame;
6e7f8b9c
AC
1248}
1249
bbde78fa 1250/* This is a variant of get_selected_frame() which can be called when
7dd88986 1251 the inferior does not have a frame; in that case it will return
bbde78fa 1252 NULL instead of calling error(). */
7dd88986
DJ
1253
1254struct frame_info *
1255deprecated_safe_get_selected_frame (void)
1256{
8ea051c5 1257 if (!has_stack_frames ())
7dd88986 1258 return NULL;
b04f3ab4 1259 return get_selected_frame (NULL);
7dd88986
DJ
1260}
1261
6e7f8b9c
AC
1262/* Select frame FI (or NULL - to invalidate the current frame). */
1263
1264void
1265select_frame (struct frame_info *fi)
1266{
52f0bd74 1267 struct symtab *s;
6e7f8b9c 1268
206415a3 1269 selected_frame = fi;
bbde78fa 1270 /* NOTE: cagney/2002-05-04: FI can be NULL. This occurs when the
6e7f8b9c 1271 frame is being invalidated. */
9a4105ab
AC
1272 if (deprecated_selected_frame_level_changed_hook)
1273 deprecated_selected_frame_level_changed_hook (frame_relative_level (fi));
6e7f8b9c
AC
1274
1275 /* FIXME: kseitz/2002-08-28: It would be nice to call
bbde78fa 1276 selected_frame_level_changed_event() right here, but due to limitations
6e7f8b9c 1277 in the current interfaces, we would end up flooding UIs with events
bbde78fa 1278 because select_frame() is used extensively internally.
6e7f8b9c
AC
1279
1280 Once we have frame-parameterized frame (and frame-related) commands,
1281 the event notification can be moved here, since this function will only
0963b4bd 1282 be called when the user's selected frame is being changed. */
6e7f8b9c
AC
1283
1284 /* Ensure that symbols for this frame are read in. Also, determine the
1285 source language of this frame, and switch to it if desired. */
1286 if (fi)
1287 {
7ae4c3a5 1288 /* We retrieve the frame's symtab by using the frame PC. However
bbde78fa 1289 we cannot use the frame PC as-is, because it usually points to
7ae4c3a5
JB
1290 the instruction following the "call", which is sometimes the
1291 first instruction of another function. So we rely on
1292 get_frame_address_in_block() which provides us with a PC which
1293 is guaranteed to be inside the frame's code block. */
1294 s = find_pc_symtab (get_frame_address_in_block (fi));
6e7f8b9c
AC
1295 if (s
1296 && s->language != current_language->la_language
1297 && s->language != language_unknown
1298 && language_mode == language_mode_auto)
1299 {
1300 set_language (s->language);
1301 }
1302 }
1303}
c689142b 1304
4c1e7e9d
AC
1305/* Create an arbitrary (i.e. address specified by user) or innermost frame.
1306 Always returns a non-NULL value. */
1307
1308struct frame_info *
1309create_new_frame (CORE_ADDR addr, CORE_ADDR pc)
1310{
1311 struct frame_info *fi;
4c1e7e9d 1312
7f78e237
AC
1313 if (frame_debug)
1314 {
1315 fprintf_unfiltered (gdb_stdlog,
5af949e3
UW
1316 "{ create_new_frame (addr=%s, pc=%s) ",
1317 hex_string (addr), hex_string (pc));
7f78e237
AC
1318 }
1319
35d5d4ee 1320 fi = FRAME_OBSTACK_ZALLOC (struct frame_info);
4c1e7e9d 1321
3e43a32a
MS
1322 fi->next = create_sentinel_frame (current_program_space,
1323 get_current_regcache ());
7df05f2b 1324
1e275f79
PA
1325 /* Set/update this frame's cached PC value, found in the next frame.
1326 Do this before looking for this frame's unwinder. A sniffer is
1327 very likely to read this, and the corresponding unwinder is
1328 entitled to rely that the PC doesn't magically change. */
1329 fi->next->prev_pc.value = pc;
1330 fi->next->prev_pc.p = 1;
1331
6c95b8df
PA
1332 /* We currently assume that frame chain's can't cross spaces. */
1333 fi->pspace = fi->next->pspace;
1334 fi->aspace = fi->next->aspace;
1335
7df05f2b
AC
1336 /* Select/initialize both the unwind function and the frame's type
1337 based on the PC. */
9f9a8002 1338 frame_unwind_find_by_frame (fi, &fi->prologue_cache);
7df05f2b 1339
18adea3f 1340 fi->this_id.p = 1;
1e275f79 1341 fi->this_id.value = frame_id_build (addr, pc);
4c1e7e9d 1342
7f78e237
AC
1343 if (frame_debug)
1344 {
1345 fprintf_unfiltered (gdb_stdlog, "-> ");
1346 fprint_frame (gdb_stdlog, fi);
1347 fprintf_unfiltered (gdb_stdlog, " }\n");
1348 }
1349
4c1e7e9d
AC
1350 return fi;
1351}
1352
03febf99
AC
1353/* Return the frame that THIS_FRAME calls (NULL if THIS_FRAME is the
1354 innermost frame). Be careful to not fall off the bottom of the
1355 frame chain and onto the sentinel frame. */
4c1e7e9d
AC
1356
1357struct frame_info *
03febf99 1358get_next_frame (struct frame_info *this_frame)
4c1e7e9d 1359{
03febf99
AC
1360 if (this_frame->level > 0)
1361 return this_frame->next;
a94dd1fd
AC
1362 else
1363 return NULL;
4c1e7e9d
AC
1364}
1365
f4c5303c
OF
1366/* Observer for the target_changed event. */
1367
2c0b251b 1368static void
f4c5303c
OF
1369frame_observer_target_changed (struct target_ops *target)
1370{
35f196d9 1371 reinit_frame_cache ();
f4c5303c
OF
1372}
1373
4c1e7e9d
AC
1374/* Flush the entire frame cache. */
1375
1376void
35f196d9 1377reinit_frame_cache (void)
4c1e7e9d 1378{
272dfcfd
AS
1379 struct frame_info *fi;
1380
1381 /* Tear down all frame caches. */
1382 for (fi = current_frame; fi != NULL; fi = fi->prev)
1383 {
1384 if (fi->prologue_cache && fi->unwind->dealloc_cache)
1385 fi->unwind->dealloc_cache (fi, fi->prologue_cache);
1386 if (fi->base_cache && fi->base->unwind->dealloc_cache)
1387 fi->base->unwind->dealloc_cache (fi, fi->base_cache);
1388 }
1389
0963b4bd 1390 /* Since we can't really be sure what the first object allocated was. */
4c1e7e9d
AC
1391 obstack_free (&frame_cache_obstack, 0);
1392 obstack_init (&frame_cache_obstack);
1393
0d6ba1b1
DJ
1394 if (current_frame != NULL)
1395 annotate_frames_invalid ();
1396
4c1e7e9d
AC
1397 current_frame = NULL; /* Invalidate cache */
1398 select_frame (NULL);
b83e9eb7 1399 frame_stash_invalidate ();
7f78e237 1400 if (frame_debug)
35f196d9 1401 fprintf_unfiltered (gdb_stdlog, "{ reinit_frame_cache () }\n");
4c1e7e9d
AC
1402}
1403
e48af409
DJ
1404/* Find where a register is saved (in memory or another register).
1405 The result of frame_register_unwind is just where it is saved
5efde112 1406 relative to this particular frame. */
e48af409
DJ
1407
1408static void
1409frame_register_unwind_location (struct frame_info *this_frame, int regnum,
1410 int *optimizedp, enum lval_type *lvalp,
1411 CORE_ADDR *addrp, int *realnump)
1412{
1413 gdb_assert (this_frame == NULL || this_frame->level >= 0);
1414
1415 while (this_frame != NULL)
1416 {
1417 frame_register_unwind (this_frame, regnum, optimizedp, lvalp,
1418 addrp, realnump, NULL);
1419
1420 if (*optimizedp)
1421 break;
1422
1423 if (*lvalp != lval_register)
1424 break;
1425
1426 regnum = *realnump;
1427 this_frame = get_next_frame (this_frame);
1428 }
1429}
1430
5613d8d3
AC
1431/* Return a "struct frame_info" corresponding to the frame that called
1432 THIS_FRAME. Returns NULL if there is no such frame.
5bf00f29 1433
5613d8d3
AC
1434 Unlike get_prev_frame, this function always tries to unwind the
1435 frame. */
eb4f72c5 1436
5613d8d3
AC
1437static struct frame_info *
1438get_prev_frame_1 (struct frame_info *this_frame)
eb4f72c5 1439{
756e95f1 1440 struct frame_id this_id;
b1bd0044 1441 struct gdbarch *gdbarch;
eb4f72c5 1442
5613d8d3 1443 gdb_assert (this_frame != NULL);
b1bd0044 1444 gdbarch = get_frame_arch (this_frame);
5613d8d3 1445
7f78e237
AC
1446 if (frame_debug)
1447 {
5613d8d3 1448 fprintf_unfiltered (gdb_stdlog, "{ get_prev_frame_1 (this_frame=");
7f78e237
AC
1449 if (this_frame != NULL)
1450 fprintf_unfiltered (gdb_stdlog, "%d", this_frame->level);
1451 else
1452 fprintf_unfiltered (gdb_stdlog, "<NULL>");
1453 fprintf_unfiltered (gdb_stdlog, ") ");
1454 }
1455
5613d8d3
AC
1456 /* Only try to do the unwind once. */
1457 if (this_frame->prev_p)
1458 {
1459 if (frame_debug)
1460 {
1461 fprintf_unfiltered (gdb_stdlog, "-> ");
1462 fprint_frame (gdb_stdlog, this_frame->prev);
1463 fprintf_unfiltered (gdb_stdlog, " // cached \n");
1464 }
1465 return this_frame->prev;
1466 }
8fa75a5d 1467
0d254d6f
DJ
1468 /* If the frame unwinder hasn't been selected yet, we must do so
1469 before setting prev_p; otherwise the check for misbehaved
1470 sniffers will think that this frame's sniffer tried to unwind
1471 further (see frame_cleanup_after_sniffer). */
1472 if (this_frame->unwind == NULL)
9f9a8002 1473 frame_unwind_find_by_frame (this_frame, &this_frame->prologue_cache);
8fa75a5d 1474
5613d8d3 1475 this_frame->prev_p = 1;
55feb689 1476 this_frame->stop_reason = UNWIND_NO_REASON;
5613d8d3 1477
edb3359d
DJ
1478 /* If we are unwinding from an inline frame, all of the below tests
1479 were already performed when we unwound from the next non-inline
1480 frame. We must skip them, since we can not get THIS_FRAME's ID
1481 until we have unwound all the way down to the previous non-inline
1482 frame. */
1483 if (get_frame_type (this_frame) == INLINE_FRAME)
1484 return get_prev_frame_raw (this_frame);
1485
5613d8d3
AC
1486 /* Check that this frame's ID was valid. If it wasn't, don't try to
1487 unwind to the prev frame. Be careful to not apply this test to
1488 the sentinel frame. */
0d254d6f 1489 this_id = get_frame_id (this_frame);
005ca36a 1490 if (this_frame->level >= 0 && frame_id_eq (this_id, outer_frame_id))
5613d8d3
AC
1491 {
1492 if (frame_debug)
1493 {
1494 fprintf_unfiltered (gdb_stdlog, "-> ");
1495 fprint_frame (gdb_stdlog, NULL);
1496 fprintf_unfiltered (gdb_stdlog, " // this ID is NULL }\n");
1497 }
55feb689 1498 this_frame->stop_reason = UNWIND_NULL_ID;
5613d8d3
AC
1499 return NULL;
1500 }
1501
1502 /* Check that this frame's ID isn't inner to (younger, below, next)
1503 the next frame. This happens when a frame unwind goes backwards.
f06eadd9
JB
1504 This check is valid only if this frame and the next frame are NORMAL.
1505 See the comment at frame_id_inner for details. */
1506 if (get_frame_type (this_frame) == NORMAL_FRAME
1507 && this_frame->next->unwind->type == NORMAL_FRAME
a45ae3ed 1508 && frame_id_inner (get_frame_arch (this_frame->next), this_id,
09a7aba8 1509 get_frame_id (this_frame->next)))
55feb689 1510 {
ebedcab5
JK
1511 CORE_ADDR this_pc_in_block;
1512 struct minimal_symbol *morestack_msym;
1513 const char *morestack_name = NULL;
1514
1515 /* gcc -fsplit-stack __morestack can continue the stack anywhere. */
1516 this_pc_in_block = get_frame_address_in_block (this_frame);
1517 morestack_msym = lookup_minimal_symbol_by_pc (this_pc_in_block);
1518 if (morestack_msym)
1519 morestack_name = SYMBOL_LINKAGE_NAME (morestack_msym);
1520 if (!morestack_name || strcmp (morestack_name, "__morestack") != 0)
55feb689 1521 {
ebedcab5
JK
1522 if (frame_debug)
1523 {
1524 fprintf_unfiltered (gdb_stdlog, "-> ");
1525 fprint_frame (gdb_stdlog, NULL);
3e43a32a
MS
1526 fprintf_unfiltered (gdb_stdlog,
1527 " // this frame ID is inner }\n");
ebedcab5
JK
1528 }
1529 this_frame->stop_reason = UNWIND_INNER_ID;
1530 return NULL;
55feb689 1531 }
55feb689 1532 }
5613d8d3
AC
1533
1534 /* Check that this and the next frame are not identical. If they
1535 are, there is most likely a stack cycle. As with the inner-than
1536 test above, avoid comparing the inner-most and sentinel frames. */
1537 if (this_frame->level > 0
756e95f1 1538 && frame_id_eq (this_id, get_frame_id (this_frame->next)))
55feb689
DJ
1539 {
1540 if (frame_debug)
1541 {
1542 fprintf_unfiltered (gdb_stdlog, "-> ");
1543 fprint_frame (gdb_stdlog, NULL);
1544 fprintf_unfiltered (gdb_stdlog, " // this frame has same ID }\n");
1545 }
1546 this_frame->stop_reason = UNWIND_SAME_ID;
1547 return NULL;
1548 }
5613d8d3 1549
e48af409
DJ
1550 /* Check that this and the next frame do not unwind the PC register
1551 to the same memory location. If they do, then even though they
1552 have different frame IDs, the new frame will be bogus; two
1553 functions can't share a register save slot for the PC. This can
1554 happen when the prologue analyzer finds a stack adjustment, but
d57df5e4
DJ
1555 no PC save.
1556
1557 This check does assume that the "PC register" is roughly a
1558 traditional PC, even if the gdbarch_unwind_pc method adjusts
1559 it (we do not rely on the value, only on the unwound PC being
1560 dependent on this value). A potential improvement would be
1561 to have the frame prev_pc method and the gdbarch unwind_pc
1562 method set the same lval and location information as
1563 frame_register_unwind. */
e48af409 1564 if (this_frame->level > 0
b1bd0044 1565 && gdbarch_pc_regnum (gdbarch) >= 0
e48af409 1566 && get_frame_type (this_frame) == NORMAL_FRAME
edb3359d
DJ
1567 && (get_frame_type (this_frame->next) == NORMAL_FRAME
1568 || get_frame_type (this_frame->next) == INLINE_FRAME))
e48af409 1569 {
32276632 1570 int optimized, realnum, nrealnum;
e48af409
DJ
1571 enum lval_type lval, nlval;
1572 CORE_ADDR addr, naddr;
1573
3e8c568d 1574 frame_register_unwind_location (this_frame,
b1bd0044 1575 gdbarch_pc_regnum (gdbarch),
3e8c568d
UW
1576 &optimized, &lval, &addr, &realnum);
1577 frame_register_unwind_location (get_next_frame (this_frame),
b1bd0044 1578 gdbarch_pc_regnum (gdbarch),
32276632 1579 &optimized, &nlval, &naddr, &nrealnum);
e48af409 1580
32276632
DJ
1581 if ((lval == lval_memory && lval == nlval && addr == naddr)
1582 || (lval == lval_register && lval == nlval && realnum == nrealnum))
e48af409
DJ
1583 {
1584 if (frame_debug)
1585 {
1586 fprintf_unfiltered (gdb_stdlog, "-> ");
1587 fprint_frame (gdb_stdlog, NULL);
1588 fprintf_unfiltered (gdb_stdlog, " // no saved PC }\n");
1589 }
1590
1591 this_frame->stop_reason = UNWIND_NO_SAVED_PC;
1592 this_frame->prev = NULL;
1593 return NULL;
1594 }
1595 }
1596
edb3359d
DJ
1597 return get_prev_frame_raw (this_frame);
1598}
1599
1600/* Construct a new "struct frame_info" and link it previous to
1601 this_frame. */
1602
1603static struct frame_info *
1604get_prev_frame_raw (struct frame_info *this_frame)
1605{
1606 struct frame_info *prev_frame;
1607
5613d8d3
AC
1608 /* Allocate the new frame but do not wire it in to the frame chain.
1609 Some (bad) code in INIT_FRAME_EXTRA_INFO tries to look along
1610 frame->next to pull some fancy tricks (of course such code is, by
1611 definition, recursive). Try to prevent it.
1612
1613 There is no reason to worry about memory leaks, should the
1614 remainder of the function fail. The allocated memory will be
1615 quickly reclaimed when the frame cache is flushed, and the `we've
1616 been here before' check above will stop repeated memory
1617 allocation calls. */
1618 prev_frame = FRAME_OBSTACK_ZALLOC (struct frame_info);
1619 prev_frame->level = this_frame->level + 1;
1620
6c95b8df
PA
1621 /* For now, assume we don't have frame chains crossing address
1622 spaces. */
1623 prev_frame->pspace = this_frame->pspace;
1624 prev_frame->aspace = this_frame->aspace;
1625
5613d8d3
AC
1626 /* Don't yet compute ->unwind (and hence ->type). It is computed
1627 on-demand in get_frame_type, frame_register_unwind, and
1628 get_frame_id. */
1629
1630 /* Don't yet compute the frame's ID. It is computed on-demand by
1631 get_frame_id(). */
1632
1633 /* The unwound frame ID is validate at the start of this function,
1634 as part of the logic to decide if that frame should be further
1635 unwound, and not here while the prev frame is being created.
1636 Doing this makes it possible for the user to examine a frame that
1637 has an invalid frame ID.
1638
1639 Some very old VAX code noted: [...] For the sake of argument,
1640 suppose that the stack is somewhat trashed (which is one reason
1641 that "info frame" exists). So, return 0 (indicating we don't
1642 know the address of the arglist) if we don't know what frame this
1643 frame calls. */
1644
1645 /* Link it in. */
1646 this_frame->prev = prev_frame;
1647 prev_frame->next = this_frame;
1648
1649 if (frame_debug)
1650 {
1651 fprintf_unfiltered (gdb_stdlog, "-> ");
1652 fprint_frame (gdb_stdlog, prev_frame);
1653 fprintf_unfiltered (gdb_stdlog, " }\n");
1654 }
1655
1656 return prev_frame;
1657}
1658
1659/* Debug routine to print a NULL frame being returned. */
1660
1661static void
d2bf72c0 1662frame_debug_got_null_frame (struct frame_info *this_frame,
5613d8d3
AC
1663 const char *reason)
1664{
1665 if (frame_debug)
1666 {
1667 fprintf_unfiltered (gdb_stdlog, "{ get_prev_frame (this_frame=");
1668 if (this_frame != NULL)
1669 fprintf_unfiltered (gdb_stdlog, "%d", this_frame->level);
1670 else
1671 fprintf_unfiltered (gdb_stdlog, "<NULL>");
1672 fprintf_unfiltered (gdb_stdlog, ") -> // %s}\n", reason);
1673 }
1674}
1675
c8cd9f6c
AC
1676/* Is this (non-sentinel) frame in the "main"() function? */
1677
1678static int
1679inside_main_func (struct frame_info *this_frame)
1680{
1681 struct minimal_symbol *msymbol;
1682 CORE_ADDR maddr;
1683
1684 if (symfile_objfile == 0)
1685 return 0;
1686 msymbol = lookup_minimal_symbol (main_name (), NULL, symfile_objfile);
1687 if (msymbol == NULL)
1688 return 0;
1689 /* Make certain that the code, and not descriptor, address is
1690 returned. */
b1bd0044 1691 maddr = gdbarch_convert_from_func_ptr_addr (get_frame_arch (this_frame),
c8cd9f6c
AC
1692 SYMBOL_VALUE_ADDRESS (msymbol),
1693 &current_target);
1694 return maddr == get_frame_func (this_frame);
1695}
1696
2315ffec
RC
1697/* Test whether THIS_FRAME is inside the process entry point function. */
1698
1699static int
1700inside_entry_func (struct frame_info *this_frame)
1701{
abd0a5fa
JK
1702 CORE_ADDR entry_point;
1703
1704 if (!entry_point_address_query (&entry_point))
1705 return 0;
1706
1707 return get_frame_func (this_frame) == entry_point;
2315ffec
RC
1708}
1709
5613d8d3
AC
1710/* Return a structure containing various interesting information about
1711 the frame that called THIS_FRAME. Returns NULL if there is entier
1712 no such frame or the frame fails any of a set of target-independent
1713 condition that should terminate the frame chain (e.g., as unwinding
1714 past main()).
1715
1716 This function should not contain target-dependent tests, such as
1717 checking whether the program-counter is zero. */
1718
1719struct frame_info *
1720get_prev_frame (struct frame_info *this_frame)
1721{
eb4f72c5
AC
1722 /* There is always a frame. If this assertion fails, suspect that
1723 something should be calling get_selected_frame() or
1724 get_current_frame(). */
03febf99 1725 gdb_assert (this_frame != NULL);
eb4f72c5 1726
cc9bed83
RC
1727 /* tausq/2004-12-07: Dummy frames are skipped because it doesn't make much
1728 sense to stop unwinding at a dummy frame. One place where a dummy
1729 frame may have an address "inside_main_func" is on HPUX. On HPUX, the
1730 pcsqh register (space register for the instruction at the head of the
1731 instruction queue) cannot be written directly; the only way to set it
1732 is to branch to code that is in the target space. In order to implement
1733 frame dummies on HPUX, the called function is made to jump back to where
1734 the inferior was when the user function was called. If gdb was inside
1735 the main function when we created the dummy frame, the dummy frame will
1736 point inside the main function. */
03febf99 1737 if (this_frame->level >= 0
edb3359d 1738 && get_frame_type (this_frame) == NORMAL_FRAME
25d29d70 1739 && !backtrace_past_main
c8cd9f6c
AC
1740 && inside_main_func (this_frame))
1741 /* Don't unwind past main(). Note, this is done _before_ the
1742 frame has been marked as previously unwound. That way if the
1743 user later decides to enable unwinds past main(), that will
1744 automatically happen. */
ac2bd0a9 1745 {
d2bf72c0 1746 frame_debug_got_null_frame (this_frame, "inside main func");
ac2bd0a9
AC
1747 return NULL;
1748 }
eb4f72c5 1749
4a5e53e8
DJ
1750 /* If the user's backtrace limit has been exceeded, stop. We must
1751 add two to the current level; one of those accounts for backtrace_limit
1752 being 1-based and the level being 0-based, and the other accounts for
1753 the level of the new frame instead of the level of the current
1754 frame. */
1755 if (this_frame->level + 2 > backtrace_limit)
25d29d70 1756 {
d2bf72c0 1757 frame_debug_got_null_frame (this_frame, "backtrace limit exceeded");
4a5e53e8 1758 return NULL;
25d29d70
AC
1759 }
1760
0714963c
AC
1761 /* If we're already inside the entry function for the main objfile,
1762 then it isn't valid. Don't apply this test to a dummy frame -
bbde78fa 1763 dummy frame PCs typically land in the entry func. Don't apply
0714963c
AC
1764 this test to the sentinel frame. Sentinel frames should always
1765 be allowed to unwind. */
2f72f850
AC
1766 /* NOTE: cagney/2003-07-07: Fixed a bug in inside_main_func() -
1767 wasn't checking for "main" in the minimal symbols. With that
1768 fixed asm-source tests now stop in "main" instead of halting the
bbde78fa 1769 backtrace in weird and wonderful ways somewhere inside the entry
2f72f850
AC
1770 file. Suspect that tests for inside the entry file/func were
1771 added to work around that (now fixed) case. */
0714963c
AC
1772 /* NOTE: cagney/2003-07-15: danielj (if I'm reading it right)
1773 suggested having the inside_entry_func test use the
bbde78fa
JM
1774 inside_main_func() msymbol trick (along with entry_point_address()
1775 I guess) to determine the address range of the start function.
0714963c
AC
1776 That should provide a far better stopper than the current
1777 heuristics. */
2315ffec
RC
1778 /* NOTE: tausq/2004-10-09: this is needed if, for example, the compiler
1779 applied tail-call optimizations to main so that a function called
1780 from main returns directly to the caller of main. Since we don't
1781 stop at main, we should at least stop at the entry point of the
1782 application. */
edb3359d
DJ
1783 if (this_frame->level >= 0
1784 && get_frame_type (this_frame) == NORMAL_FRAME
1785 && !backtrace_past_entry
6e4c6c91 1786 && inside_entry_func (this_frame))
0714963c 1787 {
d2bf72c0 1788 frame_debug_got_null_frame (this_frame, "inside entry func");
0714963c
AC
1789 return NULL;
1790 }
1791
39ee2ff0
AC
1792 /* Assume that the only way to get a zero PC is through something
1793 like a SIGSEGV or a dummy frame, and hence that NORMAL frames
1794 will never unwind a zero PC. */
1795 if (this_frame->level > 0
edb3359d
DJ
1796 && (get_frame_type (this_frame) == NORMAL_FRAME
1797 || get_frame_type (this_frame) == INLINE_FRAME)
39ee2ff0
AC
1798 && get_frame_type (get_next_frame (this_frame)) == NORMAL_FRAME
1799 && get_frame_pc (this_frame) == 0)
1800 {
d2bf72c0 1801 frame_debug_got_null_frame (this_frame, "zero PC");
39ee2ff0
AC
1802 return NULL;
1803 }
1804
5613d8d3 1805 return get_prev_frame_1 (this_frame);
eb4f72c5
AC
1806}
1807
4c1e7e9d
AC
1808CORE_ADDR
1809get_frame_pc (struct frame_info *frame)
1810{
d1340264 1811 gdb_assert (frame->next != NULL);
edb3359d 1812 return frame_unwind_pc (frame->next);
4c1e7e9d
AC
1813}
1814
ad1193e7 1815/* Return an address that falls within THIS_FRAME's code block. */
8edd5d01
AC
1816
1817CORE_ADDR
ad1193e7 1818get_frame_address_in_block (struct frame_info *this_frame)
8edd5d01
AC
1819{
1820 /* A draft address. */
ad1193e7 1821 CORE_ADDR pc = get_frame_pc (this_frame);
8edd5d01 1822
ad1193e7
DJ
1823 struct frame_info *next_frame = this_frame->next;
1824
1825 /* Calling get_frame_pc returns the resume address for THIS_FRAME.
1826 Normally the resume address is inside the body of the function
1827 associated with THIS_FRAME, but there is a special case: when
1828 calling a function which the compiler knows will never return
1829 (for instance abort), the call may be the very last instruction
1830 in the calling function. The resume address will point after the
1831 call and may be at the beginning of a different function
1832 entirely.
1833
1834 If THIS_FRAME is a signal frame or dummy frame, then we should
1835 not adjust the unwound PC. For a dummy frame, GDB pushed the
1836 resume address manually onto the stack. For a signal frame, the
1837 OS may have pushed the resume address manually and invoked the
1838 handler (e.g. GNU/Linux), or invoked the trampoline which called
1839 the signal handler - but in either case the signal handler is
1840 expected to return to the trampoline. So in both of these
1841 cases we know that the resume address is executable and
1842 related. So we only need to adjust the PC if THIS_FRAME
1843 is a normal function.
1844
1845 If the program has been interrupted while THIS_FRAME is current,
1846 then clearly the resume address is inside the associated
1847 function. There are three kinds of interruption: debugger stop
1848 (next frame will be SENTINEL_FRAME), operating system
1849 signal or exception (next frame will be SIGTRAMP_FRAME),
1850 or debugger-induced function call (next frame will be
1851 DUMMY_FRAME). So we only need to adjust the PC if
1852 NEXT_FRAME is a normal function.
1853
1854 We check the type of NEXT_FRAME first, since it is already
1855 known; frame type is determined by the unwinder, and since
1856 we have THIS_FRAME we've already selected an unwinder for
edb3359d
DJ
1857 NEXT_FRAME.
1858
1859 If the next frame is inlined, we need to keep going until we find
1860 the real function - for instance, if a signal handler is invoked
1861 while in an inlined function, then the code address of the
1862 "calling" normal function should not be adjusted either. */
1863
1864 while (get_frame_type (next_frame) == INLINE_FRAME)
1865 next_frame = next_frame->next;
1866
ad1193e7 1867 if (get_frame_type (next_frame) == NORMAL_FRAME
edb3359d
DJ
1868 && (get_frame_type (this_frame) == NORMAL_FRAME
1869 || get_frame_type (this_frame) == INLINE_FRAME))
ad1193e7
DJ
1870 return pc - 1;
1871
1872 return pc;
8edd5d01
AC
1873}
1874
edb3359d
DJ
1875void
1876find_frame_sal (struct frame_info *frame, struct symtab_and_line *sal)
1058bca7 1877{
edb3359d
DJ
1878 struct frame_info *next_frame;
1879 int notcurrent;
1880
1881 /* If the next frame represents an inlined function call, this frame's
1882 sal is the "call site" of that inlined function, which can not
1883 be inferred from get_frame_pc. */
1884 next_frame = get_next_frame (frame);
1885 if (frame_inlined_callees (frame) > 0)
1886 {
1887 struct symbol *sym;
1888
1889 if (next_frame)
1890 sym = get_frame_function (next_frame);
1891 else
1892 sym = inline_skipped_symbol (inferior_ptid);
1893
1894 init_sal (sal);
1895 if (SYMBOL_LINE (sym) != 0)
1896 {
1897 sal->symtab = SYMBOL_SYMTAB (sym);
1898 sal->line = SYMBOL_LINE (sym);
1899 }
1900 else
1901 /* If the symbol does not have a location, we don't know where
1902 the call site is. Do not pretend to. This is jarring, but
1903 we can't do much better. */
1904 sal->pc = get_frame_pc (frame);
1905
1906 return;
1907 }
1908
1058bca7
AC
1909 /* If FRAME is not the innermost frame, that normally means that
1910 FRAME->pc points at the return instruction (which is *after* the
1911 call instruction), and we want to get the line containing the
1912 call (because the call is where the user thinks the program is).
1913 However, if the next frame is either a SIGTRAMP_FRAME or a
1914 DUMMY_FRAME, then the next frame will contain a saved interrupt
1915 PC and such a PC indicates the current (rather than next)
1916 instruction/line, consequently, for such cases, want to get the
1917 line containing fi->pc. */
edb3359d
DJ
1918 notcurrent = (get_frame_pc (frame) != get_frame_address_in_block (frame));
1919 (*sal) = find_pc_line (get_frame_pc (frame), notcurrent);
1058bca7
AC
1920}
1921
c193f6ac
AC
1922/* Per "frame.h", return the ``address'' of the frame. Code should
1923 really be using get_frame_id(). */
1924CORE_ADDR
1925get_frame_base (struct frame_info *fi)
1926{
d0a55772 1927 return get_frame_id (fi).stack_addr;
c193f6ac
AC
1928}
1929
da62e633
AC
1930/* High-level offsets into the frame. Used by the debug info. */
1931
1932CORE_ADDR
1933get_frame_base_address (struct frame_info *fi)
1934{
7df05f2b 1935 if (get_frame_type (fi) != NORMAL_FRAME)
da62e633
AC
1936 return 0;
1937 if (fi->base == NULL)
86c31399 1938 fi->base = frame_base_find_by_frame (fi);
da62e633
AC
1939 /* Sneaky: If the low-level unwind and high-level base code share a
1940 common unwinder, let them share the prologue cache. */
1941 if (fi->base->unwind == fi->unwind)
669fac23
DJ
1942 return fi->base->this_base (fi, &fi->prologue_cache);
1943 return fi->base->this_base (fi, &fi->base_cache);
da62e633
AC
1944}
1945
1946CORE_ADDR
1947get_frame_locals_address (struct frame_info *fi)
1948{
7df05f2b 1949 if (get_frame_type (fi) != NORMAL_FRAME)
da62e633
AC
1950 return 0;
1951 /* If there isn't a frame address method, find it. */
1952 if (fi->base == NULL)
86c31399 1953 fi->base = frame_base_find_by_frame (fi);
da62e633
AC
1954 /* Sneaky: If the low-level unwind and high-level base code share a
1955 common unwinder, let them share the prologue cache. */
1956 if (fi->base->unwind == fi->unwind)
669fac23
DJ
1957 return fi->base->this_locals (fi, &fi->prologue_cache);
1958 return fi->base->this_locals (fi, &fi->base_cache);
da62e633
AC
1959}
1960
1961CORE_ADDR
1962get_frame_args_address (struct frame_info *fi)
1963{
7df05f2b 1964 if (get_frame_type (fi) != NORMAL_FRAME)
da62e633
AC
1965 return 0;
1966 /* If there isn't a frame address method, find it. */
1967 if (fi->base == NULL)
86c31399 1968 fi->base = frame_base_find_by_frame (fi);
da62e633
AC
1969 /* Sneaky: If the low-level unwind and high-level base code share a
1970 common unwinder, let them share the prologue cache. */
1971 if (fi->base->unwind == fi->unwind)
669fac23
DJ
1972 return fi->base->this_args (fi, &fi->prologue_cache);
1973 return fi->base->this_args (fi, &fi->base_cache);
da62e633
AC
1974}
1975
e7802207
TT
1976/* Return true if the frame unwinder for frame FI is UNWINDER; false
1977 otherwise. */
1978
1979int
1980frame_unwinder_is (struct frame_info *fi, const struct frame_unwind *unwinder)
1981{
1982 if (fi->unwind == NULL)
9f9a8002 1983 frame_unwind_find_by_frame (fi, &fi->prologue_cache);
e7802207
TT
1984 return fi->unwind == unwinder;
1985}
1986
85cf597a
AC
1987/* Level of the selected frame: 0 for innermost, 1 for its caller, ...
1988 or -1 for a NULL frame. */
1989
1990int
1991frame_relative_level (struct frame_info *fi)
1992{
1993 if (fi == NULL)
1994 return -1;
1995 else
1996 return fi->level;
1997}
1998
5a203e44
AC
1999enum frame_type
2000get_frame_type (struct frame_info *frame)
2001{
c1bf6f65
AC
2002 if (frame->unwind == NULL)
2003 /* Initialize the frame's unwinder because that's what
2004 provides the frame's type. */
9f9a8002 2005 frame_unwind_find_by_frame (frame, &frame->prologue_cache);
c1bf6f65 2006 return frame->unwind->type;
5a203e44
AC
2007}
2008
6c95b8df
PA
2009struct program_space *
2010get_frame_program_space (struct frame_info *frame)
2011{
2012 return frame->pspace;
2013}
2014
2015struct program_space *
2016frame_unwind_program_space (struct frame_info *this_frame)
2017{
2018 gdb_assert (this_frame);
2019
2020 /* This is really a placeholder to keep the API consistent --- we
2021 assume for now that we don't have frame chains crossing
2022 spaces. */
2023 return this_frame->pspace;
2024}
2025
2026struct address_space *
2027get_frame_address_space (struct frame_info *frame)
2028{
2029 return frame->aspace;
2030}
2031
ae1e7417
AC
2032/* Memory access methods. */
2033
2034void
10c42a71
AC
2035get_frame_memory (struct frame_info *this_frame, CORE_ADDR addr,
2036 gdb_byte *buf, int len)
ae1e7417
AC
2037{
2038 read_memory (addr, buf, len);
2039}
2040
2041LONGEST
2042get_frame_memory_signed (struct frame_info *this_frame, CORE_ADDR addr,
2043 int len)
2044{
e17a4113
UW
2045 struct gdbarch *gdbarch = get_frame_arch (this_frame);
2046 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1c4d3f96 2047
e17a4113 2048 return read_memory_integer (addr, len, byte_order);
ae1e7417
AC
2049}
2050
2051ULONGEST
2052get_frame_memory_unsigned (struct frame_info *this_frame, CORE_ADDR addr,
2053 int len)
2054{
e17a4113
UW
2055 struct gdbarch *gdbarch = get_frame_arch (this_frame);
2056 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1c4d3f96 2057
e17a4113 2058 return read_memory_unsigned_integer (addr, len, byte_order);
ae1e7417
AC
2059}
2060
304396fb
AC
2061int
2062safe_frame_unwind_memory (struct frame_info *this_frame,
10c42a71 2063 CORE_ADDR addr, gdb_byte *buf, int len)
304396fb 2064{
8defab1a
DJ
2065 /* NOTE: target_read_memory returns zero on success! */
2066 return !target_read_memory (addr, buf, len);
304396fb
AC
2067}
2068
36f15f55 2069/* Architecture methods. */
ae1e7417
AC
2070
2071struct gdbarch *
2072get_frame_arch (struct frame_info *this_frame)
2073{
36f15f55
UW
2074 return frame_unwind_arch (this_frame->next);
2075}
2076
2077struct gdbarch *
2078frame_unwind_arch (struct frame_info *next_frame)
2079{
2080 if (!next_frame->prev_arch.p)
2081 {
2082 struct gdbarch *arch;
0701b271 2083
36f15f55 2084 if (next_frame->unwind == NULL)
9f9a8002 2085 frame_unwind_find_by_frame (next_frame, &next_frame->prologue_cache);
36f15f55
UW
2086
2087 if (next_frame->unwind->prev_arch != NULL)
2088 arch = next_frame->unwind->prev_arch (next_frame,
2089 &next_frame->prologue_cache);
2090 else
2091 arch = get_frame_arch (next_frame);
2092
2093 next_frame->prev_arch.arch = arch;
2094 next_frame->prev_arch.p = 1;
2095 if (frame_debug)
2096 fprintf_unfiltered (gdb_stdlog,
2097 "{ frame_unwind_arch (next_frame=%d) -> %s }\n",
2098 next_frame->level,
2099 gdbarch_bfd_arch_info (arch)->printable_name);
2100 }
2101
2102 return next_frame->prev_arch.arch;
2103}
2104
2105struct gdbarch *
2106frame_unwind_caller_arch (struct frame_info *next_frame)
2107{
2108 return frame_unwind_arch (skip_inlined_frames (next_frame));
ae1e7417
AC
2109}
2110
a9e5fdc2
AC
2111/* Stack pointer methods. */
2112
2113CORE_ADDR
2114get_frame_sp (struct frame_info *this_frame)
2115{
d56907c1 2116 struct gdbarch *gdbarch = get_frame_arch (this_frame);
1c4d3f96 2117
bbde78fa 2118 /* Normality - an architecture that provides a way of obtaining any
a9e5fdc2 2119 frame inner-most address. */
b1bd0044 2120 if (gdbarch_unwind_sp_p (gdbarch))
d56907c1
DJ
2121 /* NOTE drow/2008-06-28: gdbarch_unwind_sp could be converted to
2122 operate on THIS_FRAME now. */
2123 return gdbarch_unwind_sp (gdbarch, this_frame->next);
a9e5fdc2 2124 /* Now things are really are grim. Hope that the value returned by
3e8c568d 2125 the gdbarch_sp_regnum register is meaningful. */
b1bd0044 2126 if (gdbarch_sp_regnum (gdbarch) >= 0)
d56907c1
DJ
2127 return get_frame_register_unsigned (this_frame,
2128 gdbarch_sp_regnum (gdbarch));
e2e0b3e5 2129 internal_error (__FILE__, __LINE__, _("Missing unwind SP method"));
a9e5fdc2
AC
2130}
2131
55feb689
DJ
2132/* Return the reason why we can't unwind past FRAME. */
2133
2134enum unwind_stop_reason
2135get_frame_unwind_stop_reason (struct frame_info *frame)
2136{
2137 /* If we haven't tried to unwind past this point yet, then assume
2138 that unwinding would succeed. */
2139 if (frame->prev_p == 0)
2140 return UNWIND_NO_REASON;
2141
2142 /* Otherwise, we set a reason when we succeeded (or failed) to
2143 unwind. */
2144 return frame->stop_reason;
2145}
2146
2147/* Return a string explaining REASON. */
2148
2149const char *
2150frame_stop_reason_string (enum unwind_stop_reason reason)
2151{
2152 switch (reason)
2153 {
2154 case UNWIND_NULL_ID:
2155 return _("unwinder did not report frame ID");
2156
2157 case UNWIND_INNER_ID:
2158 return _("previous frame inner to this frame (corrupt stack?)");
2159
2160 case UNWIND_SAME_ID:
2161 return _("previous frame identical to this frame (corrupt stack?)");
2162
e48af409
DJ
2163 case UNWIND_NO_SAVED_PC:
2164 return _("frame did not save the PC");
2165
55feb689
DJ
2166 case UNWIND_NO_REASON:
2167 case UNWIND_FIRST_ERROR:
2168 default:
2169 internal_error (__FILE__, __LINE__,
2170 "Invalid frame stop reason");
2171 }
2172}
2173
669fac23
DJ
2174/* Clean up after a failed (wrong unwinder) attempt to unwind past
2175 FRAME. */
2176
2177static void
2178frame_cleanup_after_sniffer (void *arg)
2179{
2180 struct frame_info *frame = arg;
2181
2182 /* The sniffer should not allocate a prologue cache if it did not
2183 match this frame. */
2184 gdb_assert (frame->prologue_cache == NULL);
2185
2186 /* No sniffer should extend the frame chain; sniff based on what is
2187 already certain. */
2188 gdb_assert (!frame->prev_p);
2189
2190 /* The sniffer should not check the frame's ID; that's circular. */
2191 gdb_assert (!frame->this_id.p);
2192
2193 /* Clear cached fields dependent on the unwinder.
2194
2195 The previous PC is independent of the unwinder, but the previous
ad1193e7 2196 function is not (see get_frame_address_in_block). */
669fac23
DJ
2197 frame->prev_func.p = 0;
2198 frame->prev_func.addr = 0;
2199
2200 /* Discard the unwinder last, so that we can easily find it if an assertion
2201 in this function triggers. */
2202 frame->unwind = NULL;
2203}
2204
2205/* Set FRAME's unwinder temporarily, so that we can call a sniffer.
2206 Return a cleanup which should be called if unwinding fails, and
2207 discarded if it succeeds. */
2208
2209struct cleanup *
2210frame_prepare_for_sniffer (struct frame_info *frame,
2211 const struct frame_unwind *unwind)
2212{
2213 gdb_assert (frame->unwind == NULL);
2214 frame->unwind = unwind;
2215 return make_cleanup (frame_cleanup_after_sniffer, frame);
2216}
2217
b9362cc7
AC
2218extern initialize_file_ftype _initialize_frame; /* -Wmissing-prototypes */
2219
25d29d70
AC
2220static struct cmd_list_element *set_backtrace_cmdlist;
2221static struct cmd_list_element *show_backtrace_cmdlist;
2222
2223static void
2224set_backtrace_cmd (char *args, int from_tty)
2225{
2226 help_list (set_backtrace_cmdlist, "set backtrace ", -1, gdb_stdout);
2227}
2228
2229static void
2230show_backtrace_cmd (char *args, int from_tty)
2231{
2232 cmd_show_list (show_backtrace_cmdlist, from_tty, "");
2233}
2234
4c1e7e9d
AC
2235void
2236_initialize_frame (void)
2237{
2238 obstack_init (&frame_cache_obstack);
eb4f72c5 2239
f4c5303c
OF
2240 observer_attach_target_changed (frame_observer_target_changed);
2241
1bedd215 2242 add_prefix_cmd ("backtrace", class_maintenance, set_backtrace_cmd, _("\
25d29d70 2243Set backtrace specific variables.\n\
1bedd215 2244Configure backtrace variables such as the backtrace limit"),
25d29d70
AC
2245 &set_backtrace_cmdlist, "set backtrace ",
2246 0/*allow-unknown*/, &setlist);
1bedd215 2247 add_prefix_cmd ("backtrace", class_maintenance, show_backtrace_cmd, _("\
25d29d70 2248Show backtrace specific variables\n\
1bedd215 2249Show backtrace variables such as the backtrace limit"),
25d29d70
AC
2250 &show_backtrace_cmdlist, "show backtrace ",
2251 0/*allow-unknown*/, &showlist);
2252
2253 add_setshow_boolean_cmd ("past-main", class_obscure,
7915a72c
AC
2254 &backtrace_past_main, _("\
2255Set whether backtraces should continue past \"main\"."), _("\
2256Show whether backtraces should continue past \"main\"."), _("\
eb4f72c5
AC
2257Normally the caller of \"main\" is not of interest, so GDB will terminate\n\
2258the backtrace at \"main\". Set this variable if you need to see the rest\n\
7915a72c 2259of the stack trace."),
2c5b56ce 2260 NULL,
920d2a44 2261 show_backtrace_past_main,
2c5b56ce 2262 &set_backtrace_cmdlist,
25d29d70
AC
2263 &show_backtrace_cmdlist);
2264
2315ffec 2265 add_setshow_boolean_cmd ("past-entry", class_obscure,
7915a72c
AC
2266 &backtrace_past_entry, _("\
2267Set whether backtraces should continue past the entry point of a program."),
2268 _("\
2269Show whether backtraces should continue past the entry point of a program."),
2270 _("\
2315ffec 2271Normally there are no callers beyond the entry point of a program, so GDB\n\
cce7e648 2272will terminate the backtrace there. Set this variable if you need to see\n\
7915a72c 2273the rest of the stack trace."),
2c5b56ce 2274 NULL,
920d2a44 2275 show_backtrace_past_entry,
2c5b56ce 2276 &set_backtrace_cmdlist,
2315ffec
RC
2277 &show_backtrace_cmdlist);
2278
4a5e53e8
DJ
2279 add_setshow_integer_cmd ("limit", class_obscure,
2280 &backtrace_limit, _("\
7915a72c
AC
2281Set an upper bound on the number of backtrace levels."), _("\
2282Show the upper bound on the number of backtrace levels."), _("\
fec74868 2283No more than the specified number of frames can be displayed or examined.\n\
7915a72c 2284Zero is unlimited."),
4a5e53e8
DJ
2285 NULL,
2286 show_backtrace_limit,
2287 &set_backtrace_cmdlist,
2288 &show_backtrace_cmdlist);
ac2bd0a9 2289
0963b4bd 2290 /* Debug this files internals. */
85c07804
AC
2291 add_setshow_zinteger_cmd ("frame", class_maintenance, &frame_debug, _("\
2292Set frame debugging."), _("\
2293Show frame debugging."), _("\
2294When non-zero, frame specific internal debugging is enabled."),
2295 NULL,
920d2a44 2296 show_frame_debug,
85c07804 2297 &setdebuglist, &showdebuglist);
4c1e7e9d 2298}
This page took 1.217164 seconds and 4 git commands to generate.