2003-01-27 Andrew Cagney <ac131313@redhat.com>
[deliverable/binutils-gdb.git] / gdb / frame.c
CommitLineData
4f460812 1/* Cache and manage frames for GDB, the GNU debugger.
96cb11df
AC
2
3 Copyright 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000,
51603483 4 2001, 2002, 2003 Free Software Foundation, Inc.
d65fe839
AC
5
6 This file is part of GDB.
7
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.
12
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.
17
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. */
22
23#include "defs.h"
24#include "frame.h"
25#include "target.h"
26#include "value.h"
39f77062 27#include "inferior.h" /* for inferior_ptid */
4e052eda 28#include "regcache.h"
4f460812 29#include "gdb_assert.h"
e36180d7
AC
30#include "gdb_string.h"
31#include "builtin-regs.h"
4c1e7e9d
AC
32#include "gdb_obstack.h"
33#include "dummy-frame.h"
a94dd1fd 34#include "sentinel-frame.h"
4c1e7e9d
AC
35#include "gdbcore.h"
36#include "annotate.h"
6e7f8b9c 37#include "language.h"
494cca16 38#include "frame-unwind.h"
eb4f72c5
AC
39#include "command.h"
40#include "gdbcmd.h"
41
42/* Flag to indicate whether backtraces should stop at main. */
43
44static int backtrace_below_main;
d65fe839 45
7a424e99 46/* Return a frame uniq ID that can be used to, later, re-find the
101dcfbe
AC
47 frame. */
48
7a424e99
AC
49struct frame_id
50get_frame_id (struct frame_info *fi)
101dcfbe
AC
51{
52 if (fi == NULL)
53 {
7a424e99 54 return null_frame_id;
101dcfbe
AC
55 }
56 else
57 {
7a424e99
AC
58 struct frame_id id;
59 id.base = fi->frame;
60 id.pc = fi->pc;
61 return id;
101dcfbe
AC
62 }
63}
64
7a424e99
AC
65const struct frame_id null_frame_id; /* All zeros. */
66
67struct frame_id
68frame_id_build (CORE_ADDR base, CORE_ADDR func_or_pc)
69{
70 struct frame_id id;
71 id.base = base;
72 id.pc = func_or_pc;
73 return id;
74}
75
76int
77frame_id_p (struct frame_id l)
78{
79 /* The .func can be NULL but the .base cannot. */
80 return (l.base != 0);
81}
82
83int
84frame_id_eq (struct frame_id l, struct frame_id r)
85{
86 /* If .base is different, the frames are different. */
87 if (l.base != r.base)
88 return 0;
89 /* Add a test to check that the frame ID's are for the same function
90 here. */
91 return 1;
92}
93
94int
95frame_id_inner (struct frame_id l, struct frame_id r)
96{
97 /* Only return non-zero when strictly inner than. Note that, per
98 comment in "frame.h", there is some fuzz here. Frameless
99 functions are not strictly inner than (same .base but different
100 .func). */
101 return INNER_THAN (l.base, r.base);
102}
103
101dcfbe
AC
104struct frame_info *
105frame_find_by_id (struct frame_id id)
106{
107 struct frame_info *frame;
108
109 /* ZERO denotes the null frame, let the caller decide what to do
110 about it. Should it instead return get_current_frame()? */
7a424e99 111 if (!frame_id_p (id))
101dcfbe
AC
112 return NULL;
113
114 for (frame = get_current_frame ();
115 frame != NULL;
116 frame = get_prev_frame (frame))
117 {
7a424e99
AC
118 struct frame_id this = get_frame_id (frame);
119 if (frame_id_eq (id, this))
120 /* An exact match. */
121 return frame;
122 if (frame_id_inner (id, this))
123 /* Gone to far. */
101dcfbe 124 return NULL;
7a424e99
AC
125 /* Either, we're not yet gone far enough out along the frame
126 chain (inner(this,id), or we're comparing frameless functions
127 (same .base, different .func, no test available). Struggle
128 on until we've definitly gone to far. */
101dcfbe
AC
129 }
130 return NULL;
131}
132
f18c5a73
AC
133CORE_ADDR
134frame_pc_unwind (struct frame_info *frame)
135{
136 if (!frame->pc_unwind_cache_p)
137 {
494cca16 138 frame->pc_unwind_cache = frame->unwind->pc (frame, &frame->unwind_cache);
f18c5a73
AC
139 frame->pc_unwind_cache_p = 1;
140 }
141 return frame->pc_unwind_cache;
142}
143
c689142b
AC
144struct frame_id
145frame_id_unwind (struct frame_info *frame)
146{
147 if (!frame->id_unwind_cache_p)
148 {
494cca16 149 frame->unwind->id (frame, &frame->unwind_cache, &frame->id_unwind_cache);
c689142b
AC
150 frame->id_unwind_cache_p = 1;
151 }
152 return frame->id_unwind_cache;
153}
154
dbe9fe58
AC
155void
156frame_pop (struct frame_info *frame)
157{
158 /* FIXME: cagney/2003-01-18: There is probably a chicken-egg problem
159 with passing in current_regcache. The pop function needs to be
160 written carefully so as to not overwrite registers whose [old]
161 values are needed to restore other registers. Instead, this code
162 should pass in a scratch cache and, as a second step, restore the
163 registers using that. */
164 frame->unwind->pop (frame, &frame->unwind_cache, current_regcache);
165 flush_cached_frames ();
166}
c689142b 167
4f460812
AC
168void
169frame_register_unwind (struct frame_info *frame, int regnum,
170 int *optimizedp, enum lval_type *lvalp,
171 CORE_ADDR *addrp, int *realnump, void *bufferp)
172{
173 struct frame_unwind_cache *cache;
174
175 /* Require all but BUFFERP to be valid. A NULL BUFFERP indicates
176 that the value proper does not need to be fetched. */
177 gdb_assert (optimizedp != NULL);
178 gdb_assert (lvalp != NULL);
179 gdb_assert (addrp != NULL);
180 gdb_assert (realnump != NULL);
181 /* gdb_assert (bufferp != NULL); */
182
a94dd1fd
AC
183 /* NOTE: cagney/2002-11-27: A program trying to unwind a NULL frame
184 is broken. There is always a frame. If there, for some reason,
185 isn't, there is some pretty busted code as it should have
186 detected the problem before calling here. */
187 gdb_assert (frame != NULL);
4f460812
AC
188
189 /* Ask this frame to unwind its register. */
494cca16
AC
190 frame->unwind->reg (frame, &frame->unwind_cache, regnum,
191 optimizedp, lvalp, addrp, realnump, bufferp);
4f460812
AC
192}
193
a216a322
AC
194void
195frame_register (struct frame_info *frame, int regnum,
196 int *optimizedp, enum lval_type *lvalp,
197 CORE_ADDR *addrp, int *realnump, void *bufferp)
198{
199 /* Require all but BUFFERP to be valid. A NULL BUFFERP indicates
200 that the value proper does not need to be fetched. */
201 gdb_assert (optimizedp != NULL);
202 gdb_assert (lvalp != NULL);
203 gdb_assert (addrp != NULL);
204 gdb_assert (realnump != NULL);
205 /* gdb_assert (bufferp != NULL); */
206
207 /* Ulgh! Old code that, for lval_register, sets ADDRP to the offset
208 of the register in the register cache. It should instead return
209 the REGNUM corresponding to that register. Translate the . */
210 if (GET_SAVED_REGISTER_P ())
211 {
212 GET_SAVED_REGISTER (bufferp, optimizedp, addrp, frame, regnum, lvalp);
213 /* Compute the REALNUM if the caller wants it. */
214 if (*lvalp == lval_register)
215 {
216 int regnum;
217 for (regnum = 0; regnum < NUM_REGS + NUM_PSEUDO_REGS; regnum++)
218 {
219 if (*addrp == register_offset_hack (current_gdbarch, regnum))
220 {
221 *realnump = regnum;
222 return;
223 }
224 }
225 internal_error (__FILE__, __LINE__,
226 "Failed to compute the register number corresponding"
227 " to 0x%s", paddr_d (*addrp));
228 }
229 *realnump = -1;
230 return;
231 }
232
a94dd1fd
AC
233 /* Obtain the register value by unwinding the register from the next
234 (more inner frame). */
235 gdb_assert (frame != NULL && frame->next != NULL);
236 frame_register_unwind (frame->next, regnum, optimizedp, lvalp, addrp,
237 realnump, bufferp);
a216a322
AC
238}
239
135c175f
AC
240void
241frame_unwind_signed_register (struct frame_info *frame, int regnum,
242 LONGEST *val)
243{
244 int optimized;
245 CORE_ADDR addr;
246 int realnum;
247 enum lval_type lval;
248 void *buf = alloca (MAX_REGISTER_RAW_SIZE);
249 frame_register_unwind (frame, regnum, &optimized, &lval, &addr,
250 &realnum, buf);
251 (*val) = extract_signed_integer (buf, REGISTER_VIRTUAL_SIZE (regnum));
252}
253
254void
255frame_unwind_unsigned_register (struct frame_info *frame, int regnum,
256 ULONGEST *val)
257{
258 int optimized;
259 CORE_ADDR addr;
260 int realnum;
261 enum lval_type lval;
262 void *buf = alloca (MAX_REGISTER_RAW_SIZE);
263 frame_register_unwind (frame, regnum, &optimized, &lval, &addr,
264 &realnum, buf);
265 (*val) = extract_unsigned_integer (buf, REGISTER_VIRTUAL_SIZE (regnum));
266}
4f460812 267
f908a0eb
AC
268void
269frame_read_unsigned_register (struct frame_info *frame, int regnum,
270 ULONGEST *val)
271{
272 /* NOTE: cagney/2002-10-31: There is a bit of dogma here - there is
273 always a frame. Both this, and the equivalent
274 frame_read_signed_register() function, can only be called with a
275 valid frame. If, for some reason, this function is called
276 without a frame then the problem isn't here, but rather in the
277 caller. It should of first created a frame and then passed that
278 in. */
279 /* NOTE: cagney/2002-10-31: As a side bar, keep in mind that the
280 ``current_frame'' should not be treated as a special case. While
281 ``get_next_frame (current_frame) == NULL'' currently holds, it
282 should, as far as possible, not be relied upon. In the future,
283 ``get_next_frame (current_frame)'' may instead simply return a
284 normal frame object that simply always gets register values from
285 the register cache. Consequently, frame code should try to avoid
286 tests like ``if get_next_frame() == NULL'' and instead just rely
287 on recursive frame calls (like the below code) when manipulating
288 a frame chain. */
a94dd1fd
AC
289 gdb_assert (frame != NULL && frame->next != NULL);
290 frame_unwind_unsigned_register (frame->next, regnum, val);
f908a0eb
AC
291}
292
293void
294frame_read_signed_register (struct frame_info *frame, int regnum,
295 LONGEST *val)
296{
a94dd1fd
AC
297 /* See note above in frame_read_unsigned_register(). */
298 gdb_assert (frame != NULL && frame->next != NULL);
299 frame_unwind_signed_register (frame->next, regnum, val);
f908a0eb
AC
300}
301
18cde8d5 302static void
4f460812
AC
303generic_unwind_get_saved_register (char *raw_buffer,
304 int *optimizedp,
305 CORE_ADDR *addrp,
306 struct frame_info *frame,
307 int regnum,
308 enum lval_type *lvalp)
309{
310 int optimizedx;
311 CORE_ADDR addrx;
312 int realnumx;
313 enum lval_type lvalx;
314
315 if (!target_has_registers)
316 error ("No registers.");
317
318 /* Keep things simple, ensure that all the pointers (except valuep)
319 are non NULL. */
320 if (optimizedp == NULL)
321 optimizedp = &optimizedx;
322 if (lvalp == NULL)
323 lvalp = &lvalx;
324 if (addrp == NULL)
325 addrp = &addrx;
326
a94dd1fd
AC
327 gdb_assert (frame != NULL && frame->next != NULL);
328 frame_register_unwind (frame->next, regnum, optimizedp, lvalp, addrp,
329 &realnumx, raw_buffer);
4f460812
AC
330}
331
d65fe839
AC
332void
333get_saved_register (char *raw_buffer,
334 int *optimized,
335 CORE_ADDR *addrp,
336 struct frame_info *frame,
337 int regnum,
338 enum lval_type *lval)
339{
a216a322
AC
340 if (GET_SAVED_REGISTER_P ())
341 {
342 GET_SAVED_REGISTER (raw_buffer, optimized, addrp, frame, regnum, lval);
343 return;
344 }
345 generic_unwind_get_saved_register (raw_buffer, optimized, addrp, frame,
346 regnum, lval);
d65fe839
AC
347}
348
cda5a58a 349/* frame_register_read ()
d65fe839 350
cda5a58a 351 Find and return the value of REGNUM for the specified stack frame.
d65fe839
AC
352 The number of bytes copied is REGISTER_RAW_SIZE (REGNUM).
353
cda5a58a 354 Returns 0 if the register value could not be found. */
d65fe839 355
cda5a58a
AC
356int
357frame_register_read (struct frame_info *frame, int regnum, void *myaddr)
d65fe839 358{
a216a322
AC
359 int optimized;
360 enum lval_type lval;
361 CORE_ADDR addr;
362 int realnum;
363 frame_register (frame, regnum, &optimized, &lval, &addr, &realnum, myaddr);
d65fe839 364
c97dcfc7
AC
365 /* FIXME: cagney/2002-05-15: This test, is just bogus.
366
367 It indicates that the target failed to supply a value for a
368 register because it was "not available" at this time. Problem
369 is, the target still has the register and so get saved_register()
370 may be returning a value saved on the stack. */
371
d65fe839 372 if (register_cached (regnum) < 0)
cda5a58a 373 return 0; /* register value not available */
d65fe839 374
a216a322 375 return !optimized;
d65fe839 376}
e36180d7
AC
377
378
379/* Map between a frame register number and its name. A frame register
380 space is a superset of the cooked register space --- it also
381 includes builtin registers. */
382
383int
384frame_map_name_to_regnum (const char *name, int len)
385{
386 int i;
387
388 /* Search register name space. */
389 for (i = 0; i < NUM_REGS + NUM_PSEUDO_REGS; i++)
390 if (REGISTER_NAME (i) && len == strlen (REGISTER_NAME (i))
391 && strncmp (name, REGISTER_NAME (i), len) == 0)
392 {
393 return i;
394 }
395
396 /* Try builtin registers. */
397 i = builtin_reg_map_name_to_regnum (name, len);
398 if (i >= 0)
399 {
400 /* A builtin register doesn't fall into the architecture's
401 register range. */
402 gdb_assert (i >= NUM_REGS + NUM_PSEUDO_REGS);
403 return i;
404 }
405
406 return -1;
407}
408
409const char *
410frame_map_regnum_to_name (int regnum)
411{
412 if (regnum < 0)
413 return NULL;
414 if (regnum < NUM_REGS + NUM_PSEUDO_REGS)
415 return REGISTER_NAME (regnum);
416 return builtin_reg_map_regnum_to_name (regnum);
417}
4c1e7e9d 418
a94dd1fd
AC
419/* Create a sentinel frame. */
420
421struct frame_info *
422create_sentinel_frame (struct regcache *regcache)
423{
424 struct frame_info *frame = FRAME_OBSTACK_ZALLOC (struct frame_info);
425 frame->type = NORMAL_FRAME;
426 frame->level = -1;
427 /* Explicitly initialize the sentinel frame's cache. Provide it
428 with the underlying regcache. In the future additional
429 information, such as the frame's thread will be added. */
430 frame->unwind_cache = sentinel_frame_cache (regcache);
431 /* For the moment there is only one sentinel frame implementation. */
432 frame->unwind = sentinel_frame_unwind;
433 /* Link this frame back to itself. The frame is self referential
434 (the unwound PC is the same as the pc), so make it so. */
435 frame->next = frame;
436 /* Always unwind the PC as part of creating this frame. This
437 ensures that the frame's PC points at something valid. */
438 /* FIXME: cagney/2003-01-10: Problem here. Unwinding a sentinel
439 frame's PC may require information such as the frame's thread's
440 stop reason. Is it possible to get to that? */
441 frame->pc = frame_pc_unwind (frame);
442 return frame;
443}
444
4c1e7e9d
AC
445/* Info about the innermost stack frame (contents of FP register) */
446
447static struct frame_info *current_frame;
448
449/* Cache for frame addresses already read by gdb. Valid only while
450 inferior is stopped. Control variables for the frame cache should
451 be local to this module. */
452
453static struct obstack frame_cache_obstack;
454
455void *
479ab5a0 456frame_obstack_zalloc (unsigned long size)
4c1e7e9d 457{
479ab5a0
AC
458 void *data = obstack_alloc (&frame_cache_obstack, size);
459 memset (data, 0, size);
460 return data;
4c1e7e9d
AC
461}
462
6baff1d2 463CORE_ADDR *
4c1e7e9d
AC
464frame_saved_regs_zalloc (struct frame_info *fi)
465{
466 fi->saved_regs = (CORE_ADDR *)
479ab5a0 467 frame_obstack_zalloc (SIZEOF_FRAME_SAVED_REGS);
6baff1d2 468 return fi->saved_regs;
4c1e7e9d
AC
469}
470
6baff1d2
AC
471CORE_ADDR *
472get_frame_saved_regs (struct frame_info *fi)
473{
474 return fi->saved_regs;
475}
4c1e7e9d 476
a94dd1fd
AC
477/* Return the innermost (currently executing) stack frame. This is
478 split into two functions. The function unwind_to_current_frame()
479 is wrapped in catch exceptions so that, even when the unwind of the
480 sentinel frame fails, the function still returns a stack frame. */
481
482static int
483unwind_to_current_frame (struct ui_out *ui_out, void *args)
484{
485 struct frame_info *frame = get_prev_frame (args);
486 /* A sentinel frame can fail to unwind, eg, because it's PC value
487 lands in somewhere like start. */
488 if (frame == NULL)
489 return 1;
490 current_frame = frame;
491 return 0;
492}
4c1e7e9d
AC
493
494struct frame_info *
495get_current_frame (void)
496{
a94dd1fd
AC
497 if (!target_has_stack)
498 error ("No stack.");
499 if (!target_has_registers)
500 error ("No registers.");
501 if (!target_has_memory)
502 error ("No memory.");
4c1e7e9d
AC
503 if (current_frame == NULL)
504 {
a94dd1fd
AC
505 struct frame_info *sentinel_frame =
506 create_sentinel_frame (current_regcache);
507 if (catch_exceptions (uiout, unwind_to_current_frame, sentinel_frame,
508 NULL, RETURN_MASK_ERROR) != 0)
509 {
510 /* Oops! Fake a current frame? Is this useful? It has a PC
511 of zero, for instance. */
512 current_frame = sentinel_frame;
513 }
4c1e7e9d
AC
514 }
515 return current_frame;
516}
517
6e7f8b9c
AC
518/* The "selected" stack frame is used by default for local and arg
519 access. May be zero, for no selected frame. */
520
521struct frame_info *deprecated_selected_frame;
522
523/* Return the selected frame. Always non-null (unless there isn't an
524 inferior sufficient for creating a frame) in which case an error is
525 thrown. */
526
527struct frame_info *
528get_selected_frame (void)
529{
530 if (deprecated_selected_frame == NULL)
531 /* Hey! Don't trust this. It should really be re-finding the
532 last selected frame of the currently selected thread. This,
533 though, is better than nothing. */
534 select_frame (get_current_frame ());
535 /* There is always a frame. */
536 gdb_assert (deprecated_selected_frame != NULL);
537 return deprecated_selected_frame;
538}
539
540/* Select frame FI (or NULL - to invalidate the current frame). */
541
542void
543select_frame (struct frame_info *fi)
544{
545 register struct symtab *s;
546
547 deprecated_selected_frame = fi;
548 /* NOTE: cagney/2002-05-04: FI can be NULL. This occures when the
549 frame is being invalidated. */
550 if (selected_frame_level_changed_hook)
551 selected_frame_level_changed_hook (frame_relative_level (fi));
552
553 /* FIXME: kseitz/2002-08-28: It would be nice to call
554 selected_frame_level_changed_event right here, but due to limitations
555 in the current interfaces, we would end up flooding UIs with events
556 because select_frame is used extensively internally.
557
558 Once we have frame-parameterized frame (and frame-related) commands,
559 the event notification can be moved here, since this function will only
560 be called when the users selected frame is being changed. */
561
562 /* Ensure that symbols for this frame are read in. Also, determine the
563 source language of this frame, and switch to it if desired. */
564 if (fi)
565 {
566 s = find_pc_symtab (fi->pc);
567 if (s
568 && s->language != current_language->la_language
569 && s->language != language_unknown
570 && language_mode == language_mode_auto)
571 {
572 set_language (s->language);
573 }
574 }
575}
576
4c1e7e9d
AC
577/* Return the register saved in the simplistic ``saved_regs'' cache.
578 If the value isn't here AND a value is needed, try the next inner
579 most frame. */
580
581static void
582frame_saved_regs_register_unwind (struct frame_info *frame, void **cache,
583 int regnum, int *optimizedp,
584 enum lval_type *lvalp, CORE_ADDR *addrp,
585 int *realnump, void *bufferp)
586{
587 /* There is always a frame at this point. And THIS is the frame
588 we're interested in. */
589 gdb_assert (frame != NULL);
590 /* If we're using generic dummy frames, we'd better not be in a call
591 dummy. (generic_call_dummy_register_unwind ought to have been called
592 instead.) */
07555a72 593 gdb_assert (!(DEPRECATED_USE_GENERIC_DUMMY_FRAMES
5e0f933e 594 && (get_frame_type (frame) == DUMMY_FRAME)));
4c1e7e9d 595
8f871025
AC
596 /* Only (older) architectures that implement the
597 FRAME_INIT_SAVED_REGS method should be using this function. */
598 gdb_assert (FRAME_INIT_SAVED_REGS_P ());
599
4c1e7e9d 600 /* Load the saved_regs register cache. */
a94dd1fd 601 if (get_frame_saved_regs (frame) == NULL)
4c1e7e9d
AC
602 FRAME_INIT_SAVED_REGS (frame);
603
a94dd1fd
AC
604 if (get_frame_saved_regs (frame) != NULL
605 && get_frame_saved_regs (frame)[regnum] != 0)
4c1e7e9d
AC
606 {
607 if (regnum == SP_REGNUM)
608 {
609 /* SP register treated specially. */
610 *optimizedp = 0;
611 *lvalp = not_lval;
612 *addrp = 0;
613 *realnump = -1;
614 if (bufferp != NULL)
615 store_address (bufferp, REGISTER_RAW_SIZE (regnum),
a94dd1fd 616 get_frame_saved_regs (frame)[regnum]);
4c1e7e9d
AC
617 }
618 else
619 {
620 /* Any other register is saved in memory, fetch it but cache
621 a local copy of its value. */
622 *optimizedp = 0;
623 *lvalp = lval_memory;
a94dd1fd 624 *addrp = get_frame_saved_regs (frame)[regnum];
4c1e7e9d
AC
625 *realnump = -1;
626 if (bufferp != NULL)
627 {
628#if 1
629 /* Save each register value, as it is read in, in a
630 frame based cache. */
631 void **regs = (*cache);
632 if (regs == NULL)
633 {
634 int sizeof_cache = ((NUM_REGS + NUM_PSEUDO_REGS)
635 * sizeof (void *));
479ab5a0 636 regs = frame_obstack_zalloc (sizeof_cache);
4c1e7e9d
AC
637 (*cache) = regs;
638 }
639 if (regs[regnum] == NULL)
640 {
641 regs[regnum]
479ab5a0 642 = frame_obstack_zalloc (REGISTER_RAW_SIZE (regnum));
a94dd1fd 643 read_memory (get_frame_saved_regs (frame)[regnum], regs[regnum],
4c1e7e9d
AC
644 REGISTER_RAW_SIZE (regnum));
645 }
646 memcpy (bufferp, regs[regnum], REGISTER_RAW_SIZE (regnum));
647#else
648 /* Read the value in from memory. */
a94dd1fd 649 read_memory (get_frame_saved_regs (frame)[regnum], bufferp,
4c1e7e9d
AC
650 REGISTER_RAW_SIZE (regnum));
651#endif
652 }
653 }
654 return;
655 }
656
657 /* No luck, assume this and the next frame have the same register
a94dd1fd
AC
658 value. Pass the request down the frame chain to the next frame.
659 Hopefully that will find the register's location, either in a
660 register or in memory. */
661 frame_register (frame, regnum, optimizedp, lvalp, addrp, realnump,
662 bufferp);
4c1e7e9d
AC
663}
664
f18c5a73
AC
665static CORE_ADDR
666frame_saved_regs_pc_unwind (struct frame_info *frame, void **cache)
667{
668 return FRAME_SAVED_PC (frame);
669}
670
c170fb60
AC
671static void
672frame_saved_regs_id_unwind (struct frame_info *next_frame, void **cache,
673 struct frame_id *id)
c689142b
AC
674{
675 int fromleaf;
c170fb60
AC
676 CORE_ADDR base;
677 CORE_ADDR pc;
678
679 /* Start out by assuming it's NULL. */
680 (*id) = null_frame_id;
c689142b 681
a94dd1fd 682 if (frame_relative_level (next_frame) <= 0)
c689142b
AC
683 /* FIXME: 2002-11-09: Frameless functions can occure anywhere in
684 the frame chain, not just the inner most frame! The generic,
685 per-architecture, frame code should handle this and the below
686 should simply be removed. */
687 fromleaf = FRAMELESS_FUNCTION_INVOCATION (next_frame);
688 else
689 fromleaf = 0;
690
691 if (fromleaf)
692 /* A frameless inner-most frame. The `FP' (which isn't an
693 architecture frame-pointer register!) of the caller is the same
694 as the callee. */
695 /* FIXME: 2002-11-09: There isn't any reason to special case this
696 edge condition. Instead the per-architecture code should hande
697 it locally. */
c170fb60 698 base = get_frame_base (next_frame);
c689142b
AC
699 else
700 {
701 /* Two macros defined in tm.h specify the machine-dependent
702 actions to be performed here.
703
704 First, get the frame's chain-pointer.
705
706 If that is zero, the frame is the outermost frame or a leaf
707 called by the outermost frame. This means that if start
708 calls main without a frame, we'll return 0 (which is fine
709 anyway).
710
711 Nope; there's a problem. This also returns when the current
712 routine is a leaf of main. This is unacceptable. We move
713 this to after the ffi test; I'd rather have backtraces from
714 start go curfluy than have an abort called from main not show
715 main. */
c170fb60 716 base = FRAME_CHAIN (next_frame);
c689142b 717
c170fb60
AC
718 if (!frame_chain_valid (base, next_frame))
719 return;
c689142b 720 }
c170fb60
AC
721 if (base == 0)
722 return;
c689142b
AC
723
724 /* FIXME: cagney/2002-06-08: This should probably return the frame's
725 function and not the PC (a.k.a. resume address). */
c170fb60
AC
726 pc = frame_pc_unwind (next_frame);
727 id->pc = pc;
728 id->base = base;
c689142b
AC
729}
730
dbe9fe58
AC
731static void
732frame_saved_regs_pop (struct frame_info *fi, void **cache,
733 struct regcache *regcache)
734{
dedc2a2b 735 gdb_assert (POP_FRAME_P ());
dbe9fe58
AC
736 POP_FRAME;
737}
738
494cca16 739const struct frame_unwind trad_frame_unwinder = {
dbe9fe58 740 frame_saved_regs_pop,
494cca16
AC
741 frame_saved_regs_pc_unwind,
742 frame_saved_regs_id_unwind,
743 frame_saved_regs_register_unwind
744};
745const struct frame_unwind *trad_frame_unwind = &trad_frame_unwinder;
746
747
4c1e7e9d
AC
748/* Function: get_saved_register
749 Find register number REGNUM relative to FRAME and put its (raw,
750 target format) contents in *RAW_BUFFER.
751
752 Set *OPTIMIZED if the variable was optimized out (and thus can't be
753 fetched). Note that this is never set to anything other than zero
754 in this implementation.
755
756 Set *LVAL to lval_memory, lval_register, or not_lval, depending on
757 whether the value was fetched from memory, from a register, or in a
758 strange and non-modifiable way (e.g. a frame pointer which was
759 calculated rather than fetched). We will use not_lval for values
760 fetched from generic dummy frames.
761
762 Set *ADDRP to the address, either in memory or as a REGISTER_BYTE
763 offset into the registers array. If the value is stored in a dummy
764 frame, set *ADDRP to zero.
765
766 To use this implementation, define a function called
767 "get_saved_register" in your target code, which simply passes all
768 of its arguments to this function.
769
770 The argument RAW_BUFFER must point to aligned memory. */
771
772void
773deprecated_generic_get_saved_register (char *raw_buffer, int *optimized,
774 CORE_ADDR *addrp,
775 struct frame_info *frame, int regnum,
776 enum lval_type *lval)
777{
778 if (!target_has_registers)
779 error ("No registers.");
780
8f871025
AC
781 gdb_assert (FRAME_INIT_SAVED_REGS_P ());
782
4c1e7e9d
AC
783 /* Normal systems don't optimize out things with register numbers. */
784 if (optimized != NULL)
785 *optimized = 0;
786
787 if (addrp) /* default assumption: not found in memory */
788 *addrp = 0;
789
790 /* Note: since the current frame's registers could only have been
791 saved by frames INTERIOR TO the current frame, we skip examining
792 the current frame itself: otherwise, we would be getting the
793 previous frame's registers which were saved by the current frame. */
794
a94dd1fd 795 if (frame != NULL)
4c1e7e9d 796 {
a94dd1fd
AC
797 for (frame = get_next_frame (frame);
798 frame_relative_level (frame) >= 0;
799 frame = get_next_frame (frame))
4c1e7e9d 800 {
a94dd1fd 801 if (get_frame_type (frame) == DUMMY_FRAME)
4c1e7e9d 802 {
a94dd1fd
AC
803 if (lval) /* found it in a CALL_DUMMY frame */
804 *lval = not_lval;
805 if (raw_buffer)
806 /* FIXME: cagney/2002-06-26: This should be via the
807 gdbarch_register_read() method so that it, on the
808 fly, constructs either a raw or pseudo register
809 from the raw register cache. */
810 regcache_raw_read
811 (generic_find_dummy_frame (get_frame_pc (frame),
812 get_frame_base (frame)),
813 regnum, raw_buffer);
814 return;
4c1e7e9d 815 }
a94dd1fd
AC
816
817 FRAME_INIT_SAVED_REGS (frame);
818 if (get_frame_saved_regs (frame) != NULL
819 && get_frame_saved_regs (frame)[regnum] != 0)
4c1e7e9d 820 {
a94dd1fd
AC
821 if (lval) /* found it saved on the stack */
822 *lval = lval_memory;
823 if (regnum == SP_REGNUM)
824 {
825 if (raw_buffer) /* SP register treated specially */
826 store_address (raw_buffer, REGISTER_RAW_SIZE (regnum),
827 get_frame_saved_regs (frame)[regnum]);
828 }
829 else
830 {
831 if (addrp) /* any other register */
832 *addrp = get_frame_saved_regs (frame)[regnum];
833 if (raw_buffer)
834 read_memory (get_frame_saved_regs (frame)[regnum], raw_buffer,
835 REGISTER_RAW_SIZE (regnum));
836 }
837 return;
4c1e7e9d 838 }
4c1e7e9d
AC
839 }
840 }
841
842 /* If we get thru the loop to this point, it means the register was
843 not saved in any frame. Return the actual live-register value. */
844
845 if (lval) /* found it in a live register */
846 *lval = lval_register;
847 if (addrp)
848 *addrp = REGISTER_BYTE (regnum);
849 if (raw_buffer)
850 deprecated_read_register_gen (regnum, raw_buffer);
851}
852
eb4f72c5
AC
853/* Determine the frame's type based on its PC. */
854
855static enum frame_type
856frame_type_from_pc (CORE_ADDR pc)
857{
858 /* FIXME: cagney/2002-11-24: Can't yet directly call
859 pc_in_dummy_frame() as some architectures don't set
860 PC_IN_CALL_DUMMY() to generic_pc_in_call_dummy() (remember the
861 latter is implemented by simply calling pc_in_dummy_frame). */
862 if (DEPRECATED_USE_GENERIC_DUMMY_FRAMES
863 && DEPRECATED_PC_IN_CALL_DUMMY (pc, 0, 0))
864 return DUMMY_FRAME;
865 else
866 {
867 char *name;
868 find_pc_partial_function (pc, &name, NULL, NULL);
869 if (PC_IN_SIGTRAMP (pc, name))
870 return SIGTRAMP_FRAME;
871 else
872 return NORMAL_FRAME;
873 }
874}
875
4c1e7e9d
AC
876/* Create an arbitrary (i.e. address specified by user) or innermost frame.
877 Always returns a non-NULL value. */
878
879struct frame_info *
880create_new_frame (CORE_ADDR addr, CORE_ADDR pc)
881{
882 struct frame_info *fi;
4c1e7e9d 883
479ab5a0 884 fi = frame_obstack_zalloc (sizeof (struct frame_info));
4c1e7e9d
AC
885
886 fi->frame = addr;
887 fi->pc = pc;
a94dd1fd 888 fi->next = create_sentinel_frame (current_regcache);
eb4f72c5 889 fi->type = frame_type_from_pc (pc);
4c1e7e9d
AC
890
891 if (INIT_EXTRA_FRAME_INFO_P ())
892 INIT_EXTRA_FRAME_INFO (0, fi);
893
894 /* Select/initialize an unwind function. */
494cca16 895 fi->unwind = frame_unwind_find_by_pc (current_gdbarch, fi->pc);
4c1e7e9d
AC
896
897 return fi;
898}
899
900/* Return the frame that FRAME calls (NULL if FRAME is the innermost
a94dd1fd
AC
901 frame). Be careful to not fall off the bottom of the frame chain
902 and onto the sentinel frame. */
4c1e7e9d
AC
903
904struct frame_info *
905get_next_frame (struct frame_info *frame)
906{
a94dd1fd
AC
907 if (frame->level > 0)
908 return frame->next;
909 else
910 return NULL;
4c1e7e9d
AC
911}
912
913/* Flush the entire frame cache. */
914
915void
916flush_cached_frames (void)
917{
918 /* Since we can't really be sure what the first object allocated was */
919 obstack_free (&frame_cache_obstack, 0);
920 obstack_init (&frame_cache_obstack);
921
922 current_frame = NULL; /* Invalidate cache */
923 select_frame (NULL);
924 annotate_frames_invalid ();
925}
926
927/* Flush the frame cache, and start a new one if necessary. */
928
929void
930reinit_frame_cache (void)
931{
932 flush_cached_frames ();
933
934 /* FIXME: The inferior_ptid test is wrong if there is a corefile. */
935 if (PIDGET (inferior_ptid) != 0)
936 {
937 select_frame (get_current_frame ());
938 }
939}
940
eb4f72c5
AC
941/* Create the previous frame using the deprecated methods
942 INIT_EXTRA_INFO, INIT_FRAME_PC and INIT_FRAME_PC_FIRST. */
4c1e7e9d 943
eb4f72c5
AC
944static struct frame_info *
945legacy_get_prev_frame (struct frame_info *next_frame)
4c1e7e9d
AC
946{
947 CORE_ADDR address = 0;
948 struct frame_info *prev;
95adb866 949 int fromleaf;
4c1e7e9d 950
eb4f72c5
AC
951 /* This code only works on normal frames. A sentinel frame, where
952 the level is -1, should never reach this code. */
953 gdb_assert (next_frame->level >= 0);
4c1e7e9d
AC
954
955 /* On some machines it is possible to call a function without
956 setting up a stack frame for it. On these machines, we
957 define this macro to take two args; a frameinfo pointer
958 identifying a frame and a variable to set or clear if it is
959 or isn't leafless. */
960
961 /* Still don't want to worry about this except on the innermost
95adb866
AC
962 frame. This macro will set FROMLEAF if NEXT_FRAME is a frameless
963 function invocation. */
eb4f72c5 964 if (next_frame->level == 0)
95adb866
AC
965 /* FIXME: 2002-11-09: Frameless functions can occure anywhere in
966 the frame chain, not just the inner most frame! The generic,
967 per-architecture, frame code should handle this and the below
968 should simply be removed. */
969 fromleaf = FRAMELESS_FUNCTION_INVOCATION (next_frame);
970 else
971 fromleaf = 0;
972
973 if (fromleaf)
974 /* A frameless inner-most frame. The `FP' (which isn't an
975 architecture frame-pointer register!) of the caller is the same
976 as the callee. */
977 /* FIXME: 2002-11-09: There isn't any reason to special case this
978 edge condition. Instead the per-architecture code should hande
979 it locally. */
c193f6ac 980 address = get_frame_base (next_frame);
95adb866 981 else
4c1e7e9d
AC
982 {
983 /* Two macros defined in tm.h specify the machine-dependent
984 actions to be performed here.
95adb866 985
4c1e7e9d 986 First, get the frame's chain-pointer.
95adb866 987
4c1e7e9d
AC
988 If that is zero, the frame is the outermost frame or a leaf
989 called by the outermost frame. This means that if start
990 calls main without a frame, we'll return 0 (which is fine
991 anyway).
992
993 Nope; there's a problem. This also returns when the current
994 routine is a leaf of main. This is unacceptable. We move
995 this to after the ffi test; I'd rather have backtraces from
996 start go curfluy than have an abort called from main not show
997 main. */
998 address = FRAME_CHAIN (next_frame);
999
51603483 1000 if (!frame_chain_valid (address, next_frame))
4c1e7e9d
AC
1001 return 0;
1002 }
1003 if (address == 0)
1004 return 0;
1005
95adb866 1006 /* Create an initially zero previous frame. */
479ab5a0 1007 prev = frame_obstack_zalloc (sizeof (struct frame_info));
4c1e7e9d 1008
95adb866
AC
1009 /* Link it in. */
1010 next_frame->prev = prev;
4c1e7e9d
AC
1011 prev->next = next_frame;
1012 prev->frame = address;
1013 prev->level = next_frame->level + 1;
5a203e44
AC
1014 /* FIXME: cagney/2002-11-18: Should be setting the frame's type
1015 here, before anything else, and not last. Various INIT functions
1016 are full of work-arounds for the frames type not being set
1017 correctly from the word go. Ulgh! */
1018 prev->type = NORMAL_FRAME;
4c1e7e9d 1019
95adb866 1020 /* This change should not be needed, FIXME! We should determine
a5afb99f
AC
1021 whether any targets *need* DEPRECATED_INIT_FRAME_PC to happen
1022 after INIT_EXTRA_FRAME_INFO and come up with a simple way to
1023 express what goes on here.
95adb866
AC
1024
1025 INIT_EXTRA_FRAME_INFO is called from two places: create_new_frame
1026 (where the PC is already set up) and here (where it isn't).
a5afb99f 1027 DEPRECATED_INIT_FRAME_PC is only called from here, always after
95adb866
AC
1028 INIT_EXTRA_FRAME_INFO.
1029
1030 The catch is the MIPS, where INIT_EXTRA_FRAME_INFO requires the
1031 PC value (which hasn't been set yet). Some other machines appear
1032 to require INIT_EXTRA_FRAME_INFO before they can do
a5afb99f 1033 DEPRECATED_INIT_FRAME_PC. Phoo.
95adb866 1034
2ca6c561
AC
1035 We shouldn't need DEPRECATED_INIT_FRAME_PC_FIRST to add more
1036 complication to an already overcomplicated part of GDB.
1037 gnu@cygnus.com, 15Sep92.
95adb866 1038
a5afb99f 1039 Assuming that some machines need DEPRECATED_INIT_FRAME_PC after
95adb866
AC
1040 INIT_EXTRA_FRAME_INFO, one possible scheme:
1041
1042 SETUP_INNERMOST_FRAME(): Default version is just create_new_frame
1043 (read_fp ()), read_pc ()). Machines with extra frame info would
1044 do that (or the local equivalent) and then set the extra fields.
1045
1046 SETUP_ARBITRARY_FRAME(argc, argv): Only change here is that
1047 create_new_frame would no longer init extra frame info;
1048 SETUP_ARBITRARY_FRAME would have to do that.
1049
1050 INIT_PREV_FRAME(fromleaf, prev) Replace INIT_EXTRA_FRAME_INFO and
a5afb99f
AC
1051 DEPRECATED_INIT_FRAME_PC. This should also return a flag saying
1052 whether to keep the new frame, or whether to discard it, because
1053 on some machines (e.g. mips) it is really awkward to have
95adb866
AC
1054 FRAME_CHAIN_VALID called *before* INIT_EXTRA_FRAME_INFO (there is
1055 no good way to get information deduced in FRAME_CHAIN_VALID into
1056 the extra fields of the new frame). std_frame_pc(fromleaf, prev)
1057
1058 This is the default setting for INIT_PREV_FRAME. It just does
a5afb99f
AC
1059 what the default DEPRECATED_INIT_FRAME_PC does. Some machines
1060 will call it from INIT_PREV_FRAME (either at the beginning, the
1061 end, or in the middle). Some machines won't use it.
95adb866
AC
1062
1063 kingdon@cygnus.com, 13Apr93, 31Jan94, 14Dec94. */
1064
1065 /* NOTE: cagney/2002-11-09: Just ignore the above! There is no
1066 reason for things to be this complicated.
1067
1068 The trick is to assume that there is always a frame. Instead of
1069 special casing the inner-most frame, create fake frame
1070 (containing the hardware registers) that is inner to the
1071 user-visible inner-most frame (...) and then unwind from that.
1072 That way architecture code can use use the standard
1073 frame_XX_unwind() functions and not differentiate between the
1074 inner most and any other case.
1075
1076 Since there is always a frame to unwind from, there is always
1077 somewhere (NEXT_FRAME) to store all the info needed to construct
1078 a new (previous) frame without having to first create it. This
1079 means that the convolution below - needing to carefully order a
1080 frame's initialization - isn't needed.
1081
1082 The irony here though, is that FRAME_CHAIN(), at least for a more
1083 up-to-date architecture, always calls FRAME_SAVED_PC(), and
1084 FRAME_SAVED_PC() computes the PC but without first needing the
1085 frame! Instead of the convolution below, we could have simply
1086 called FRAME_SAVED_PC() and been done with it! Note that
1087 FRAME_SAVED_PC() is being superseed by frame_pc_unwind() and that
1088 function does have somewhere to cache that PC value. */
4c1e7e9d 1089
2ca6c561 1090 if (DEPRECATED_INIT_FRAME_PC_FIRST_P ())
97f46953 1091 prev->pc = (DEPRECATED_INIT_FRAME_PC_FIRST (fromleaf, prev));
4c1e7e9d
AC
1092
1093 if (INIT_EXTRA_FRAME_INFO_P ())
1094 INIT_EXTRA_FRAME_INFO (fromleaf, prev);
1095
1096 /* This entry is in the frame queue now, which is good since
95adb866
AC
1097 FRAME_SAVED_PC may use that queue to figure out its value (see
1098 tm-sparc.h). We want the pc saved in the inferior frame. */
a5afb99f
AC
1099 if (DEPRECATED_INIT_FRAME_PC_P ())
1100 prev->pc = DEPRECATED_INIT_FRAME_PC (fromleaf, prev);
4c1e7e9d 1101
95adb866
AC
1102 /* If ->frame and ->pc are unchanged, we are in the process of
1103 getting ourselves into an infinite backtrace. Some architectures
1104 check this in FRAME_CHAIN or thereabouts, but it seems like there
1105 is no reason this can't be an architecture-independent check. */
1106 if (prev->frame == next_frame->frame
1107 && prev->pc == next_frame->pc)
4c1e7e9d 1108 {
95adb866
AC
1109 next_frame->prev = NULL;
1110 obstack_free (&frame_cache_obstack, prev);
1111 return NULL;
4c1e7e9d
AC
1112 }
1113
1114 /* Initialize the code used to unwind the frame PREV based on the PC
1115 (and probably other architectural information). The PC lets you
1116 check things like the debug info at that point (dwarf2cfi?) and
1117 use that to decide how the frame should be unwound. */
494cca16 1118 prev->unwind = frame_unwind_find_by_pc (current_gdbarch, prev->pc);
4c1e7e9d 1119
5a203e44
AC
1120 /* NOTE: cagney/2002-11-18: The code segments, found in
1121 create_new_frame and get_prev_frame(), that initializes the
1122 frames type is subtly different. The latter only updates ->type
1123 when it encounters a SIGTRAMP_FRAME or DUMMY_FRAME. This stops
1124 get_prev_frame() overriding the frame's type when the INIT code
1125 has previously set it. This is really somewhat bogus. The
1126 initialization, as seen in create_new_frame(), should occur
1127 before the INIT function has been called. */
07555a72 1128 if (DEPRECATED_USE_GENERIC_DUMMY_FRAMES
ae45cd16
AC
1129 && (DEPRECATED_PC_IN_CALL_DUMMY_P ()
1130 ? DEPRECATED_PC_IN_CALL_DUMMY (prev->pc, 0, 0)
1131 : pc_in_dummy_frame (prev->pc)))
5a203e44
AC
1132 prev->type = DUMMY_FRAME;
1133 else
1134 {
1135 /* FIXME: cagney/2002-11-10: This should be moved to before the
1136 INIT code above so that the INIT code knows what the frame's
1137 type is (in fact, for a [generic] dummy-frame, the type can
1138 be set and then the entire initialization can be skipped.
1139 Unforunatly, its the INIT code that sets the PC (Hmm, catch
1140 22). */
1141 char *name;
1142 find_pc_partial_function (prev->pc, &name, NULL, NULL);
1143 if (PC_IN_SIGTRAMP (prev->pc, name))
1144 prev->type = SIGTRAMP_FRAME;
1145 /* FIXME: cagney/2002-11-11: Leave prev->type alone. Some
1146 architectures are forcing the frame's type in INIT so we
1147 don't want to override it here. Remember, NORMAL_FRAME == 0,
1148 so it all works (just :-/). Once this initialization is
1149 moved to the start of this function, all this nastness will
1150 go away. */
1151 }
4c1e7e9d
AC
1152
1153 return prev;
1154}
1155
eb4f72c5
AC
1156/* Return a structure containing various interesting information
1157 about the frame that called NEXT_FRAME. Returns NULL
1158 if there is no such frame. */
1159
1160struct frame_info *
1161get_prev_frame (struct frame_info *next_frame)
1162{
1163 struct frame_info *prev_frame;
1164
1165 /* Return the inner-most frame, when the caller passes in NULL. */
1166 /* NOTE: cagney/2002-11-09: Not sure how this would happen. The
1167 caller should have previously obtained a valid frame using
1168 get_selected_frame() and then called this code - only possibility
1169 I can think of is code behaving badly.
1170
1171 NOTE: cagney/2003-01-10: Talk about code behaving badly. Check
1172 block_innermost_frame(). It does the sequence: frame = NULL;
1173 while (1) { frame = get_prev_frame (frame); .... }. Ulgh! Why
1174 it couldn't be written better, I don't know.
1175
1176 NOTE: cagney/2003-01-11: I suspect what is happening is
1177 block_innermost_frame() is, when the target has no state
1178 (registers, memory, ...), still calling this function. The
1179 assumption being that this function will return NULL indicating
1180 that a frame isn't possible, rather than checking that the target
1181 has state and then calling get_current_frame() and
1182 get_prev_frame(). This is a guess mind. */
1183 if (next_frame == NULL)
1184 {
1185 /* NOTE: cagney/2002-11-09: There was a code segment here that
1186 would error out when CURRENT_FRAME was NULL. The comment
1187 that went with it made the claim ...
1188
1189 ``This screws value_of_variable, which just wants a nice
1190 clean NULL return from block_innermost_frame if there are no
1191 frames. I don't think I've ever seen this message happen
1192 otherwise. And returning NULL here is a perfectly legitimate
1193 thing to do.''
1194
1195 Per the above, this code shouldn't even be called with a NULL
1196 NEXT_FRAME. */
1197 return current_frame;
1198 }
1199
1200 /* There is always a frame. If this assertion fails, suspect that
1201 something should be calling get_selected_frame() or
1202 get_current_frame(). */
1203 gdb_assert (next_frame != NULL);
1204
1205 if (next_frame->level >= 0
1206 && !backtrace_below_main
1207 && inside_main_func (get_frame_pc (next_frame)))
1208 /* Don't unwind past main(), bug always unwind the sentinel frame.
1209 Note, this is done _before_ the frame has been marked as
1210 previously unwound. That way if the user later decides to
1211 allow unwinds past main(), that just happens. */
1212 return NULL;
1213
1214 /* Only try to do the unwind once. */
1215 if (next_frame->prev_p)
1216 return next_frame->prev;
1217 next_frame->prev_p = 1;
1218
1219 /* If we're inside the entry file, it isn't valid. */
1220 /* NOTE: drow/2002-12-25: should there be a way to disable this
1221 check? It assumes a single small entry file, and the way some
1222 debug readers (e.g. dbxread) figure out which object is the
1223 entry file is somewhat hokey. */
1224 /* NOTE: cagney/2003-01-10: If there is a way of disabling this test
1225 then it should probably be moved to before the ->prev_p test,
1226 above. */
1227 if (inside_entry_file (get_frame_pc (next_frame)))
1228 return NULL;
1229
1230 /* If any of the old frame initialization methods are around, use
1231 the legacy get_prev_frame method. Just don't try to unwind a
1232 sentinel frame using that method - it doesn't work. All sentinal
1233 frames use the new unwind code. */
1234 if ((DEPRECATED_INIT_FRAME_PC_P ()
1235 || DEPRECATED_INIT_FRAME_PC_FIRST_P ()
1236 || INIT_EXTRA_FRAME_INFO_P ())
1237 && next_frame->level >= 0)
1238 return legacy_get_prev_frame (next_frame);
1239
1240 /* Allocate the new frame but do not wire it in to the frame chain.
1241 Some (bad) code in INIT_FRAME_EXTRA_INFO tries to look along
1242 frame->next to pull some fancy tricks (of course such code is, by
1243 definition, recursive). Try to prevent it.
1244
1245 There is no reason to worry about memory leaks, should the
1246 remainder of the function fail. The allocated memory will be
1247 quickly reclaimed when the frame cache is flushed, and the `we've
1248 been here before' check above will stop repeated memory
1249 allocation calls. */
1250 prev_frame = FRAME_OBSTACK_ZALLOC (struct frame_info);
1251 prev_frame->level = next_frame->level + 1;
1252
1253 /* Try to unwind the PC. If that doesn't work, assume we've reached
1254 the oldest frame and simply return. Is there a better sentinal
1255 value? The unwound PC value is then used to initialize the new
1256 previous frame's type.
1257
1258 Note that the pc-unwind is intentionally performed before the
1259 frame chain. This is ok since, for old targets, both
1260 frame_pc_unwind (nee, FRAME_SAVED_PC) and FRAME_CHAIN()) assume
1261 NEXT_FRAME's data structures have already been initialized (using
1262 INIT_EXTRA_FRAME_INFO) and hence the call order doesn't matter.
1263
1264 By unwinding the PC first, it becomes possible to, in the case of
1265 a dummy frame, avoid also unwinding the frame ID. This is
1266 because (well ignoring the PPC) a dummy frame can be located
1267 using NEXT_FRAME's frame ID. */
1268
1269 prev_frame->pc = frame_pc_unwind (next_frame);
1270 if (prev_frame->pc == 0)
1271 /* The allocated PREV_FRAME will be reclaimed when the frame
1272 obstack is next purged. */
1273 return NULL;
1274 prev_frame->type = frame_type_from_pc (prev_frame->pc);
1275
1276 /* Set the unwind functions based on that identified PC. */
1277 prev_frame->unwind = frame_unwind_find_by_pc (current_gdbarch,
1278 prev_frame->pc);
1279
1280 /* FIXME: cagney/2003-01-13: A dummy frame doesn't need to unwind
1281 the frame ID because the frame ID comes from the previous frame.
1282 The other frames do though. True? */
1283 {
1284 /* FIXME: cagney/2002-12-18: Instead of this hack, should just
1285 save the frame ID directly. */
1286 struct frame_id id = frame_id_unwind (next_frame);
1287 if (!frame_id_p (id))
1288 return NULL;
1289 prev_frame->frame = id.base;
1290 }
1291
1292 /* Link it in. */
1293 next_frame->prev = prev_frame;
1294 prev_frame->next = next_frame;
1295
1296 /* FIXME: cagney/2002-01-19: This call will go away. Instead of
1297 initializing extra info, all frames will use the frame_cache
1298 (passed to the unwind functions) to store additional frame info.
1299 Unfortunatly legacy targets can't use legacy_get_prev_frame() to
1300 unwind the sentinel frame and, consequently, are forced to take
1301 this code path and rely on the below call to INIT_EXTR_FRAME_INFO
1302 to initialize the inner-most frame. */
1303 if (INIT_EXTRA_FRAME_INFO_P ())
1304 {
1305 gdb_assert (prev_frame->level == 0);
1306 INIT_EXTRA_FRAME_INFO (0, prev_frame);
1307 }
1308
1309 return prev_frame;
1310}
1311
4c1e7e9d
AC
1312CORE_ADDR
1313get_frame_pc (struct frame_info *frame)
1314{
1315 return frame->pc;
1316}
1317
1058bca7
AC
1318static int
1319pc_notcurrent (struct frame_info *frame)
1320{
1321 /* If FRAME is not the innermost frame, that normally means that
1322 FRAME->pc points at the return instruction (which is *after* the
1323 call instruction), and we want to get the line containing the
1324 call (because the call is where the user thinks the program is).
1325 However, if the next frame is either a SIGTRAMP_FRAME or a
1326 DUMMY_FRAME, then the next frame will contain a saved interrupt
1327 PC and such a PC indicates the current (rather than next)
1328 instruction/line, consequently, for such cases, want to get the
1329 line containing fi->pc. */
1330 struct frame_info *next = get_next_frame (frame);
1331 int notcurrent = (next != NULL && get_frame_type (next) == NORMAL_FRAME);
1332 return notcurrent;
1333}
1334
1335void
1336find_frame_sal (struct frame_info *frame, struct symtab_and_line *sal)
1337{
1338 (*sal) = find_pc_line (frame->pc, pc_notcurrent (frame));
1339}
1340
c193f6ac
AC
1341/* Per "frame.h", return the ``address'' of the frame. Code should
1342 really be using get_frame_id(). */
1343CORE_ADDR
1344get_frame_base (struct frame_info *fi)
1345{
1346 return fi->frame;
1347}
1348
85cf597a
AC
1349/* Level of the selected frame: 0 for innermost, 1 for its caller, ...
1350 or -1 for a NULL frame. */
1351
1352int
1353frame_relative_level (struct frame_info *fi)
1354{
1355 if (fi == NULL)
1356 return -1;
1357 else
1358 return fi->level;
1359}
1360
5a203e44
AC
1361enum frame_type
1362get_frame_type (struct frame_info *frame)
1363{
1364 /* Some targets still don't use [generic] dummy frames. Catch them
1365 here. */
07555a72 1366 if (!DEPRECATED_USE_GENERIC_DUMMY_FRAMES
5a203e44
AC
1367 && deprecated_frame_in_dummy (frame))
1368 return DUMMY_FRAME;
1369 return frame->type;
1370}
1371
1372void
1373deprecated_set_frame_type (struct frame_info *frame, enum frame_type type)
1374{
1375 /* Arrrg! See comment in "frame.h". */
1376 frame->type = type;
1377}
1378
4c1e7e9d
AC
1379#ifdef FRAME_FIND_SAVED_REGS
1380/* XXX - deprecated. This is a compatibility function for targets
1381 that do not yet implement FRAME_INIT_SAVED_REGS. */
1382/* Find the addresses in which registers are saved in FRAME. */
1383
1384void
95486978
AC
1385deprecated_get_frame_saved_regs (struct frame_info *frame,
1386 struct frame_saved_regs *saved_regs_addr)
4c1e7e9d
AC
1387{
1388 if (frame->saved_regs == NULL)
1389 {
1390 frame->saved_regs = (CORE_ADDR *)
479ab5a0 1391 frame_obstack_zalloc (SIZEOF_FRAME_SAVED_REGS);
4c1e7e9d
AC
1392 }
1393 if (saved_regs_addr == NULL)
1394 {
1395 struct frame_saved_regs saved_regs;
1396 FRAME_FIND_SAVED_REGS (frame, saved_regs);
1397 memcpy (frame->saved_regs, &saved_regs, SIZEOF_FRAME_SAVED_REGS);
1398 }
1399 else
1400 {
1401 FRAME_FIND_SAVED_REGS (frame, *saved_regs_addr);
1402 memcpy (frame->saved_regs, saved_regs_addr, SIZEOF_FRAME_SAVED_REGS);
1403 }
1404}
1405#endif
1406
0394eb2a
AC
1407struct frame_extra_info *
1408get_frame_extra_info (struct frame_info *fi)
1409{
1410 return fi->extra_info;
1411}
1412
2c517d0e
AC
1413struct frame_extra_info *
1414frame_extra_info_zalloc (struct frame_info *fi, long size)
1415{
479ab5a0 1416 fi->extra_info = frame_obstack_zalloc (size);
2c517d0e
AC
1417 return fi->extra_info;
1418}
1419
b87efeee 1420void
2f107107 1421deprecated_update_frame_pc_hack (struct frame_info *frame, CORE_ADDR pc)
b87efeee 1422{
2f107107 1423 /* See comment in "frame.h". */
a94dd1fd 1424 gdb_assert (frame->next != NULL);
2f107107
AC
1425 frame->pc = pc;
1426}
1427
1428void
1429deprecated_update_frame_base_hack (struct frame_info *frame, CORE_ADDR base)
1430{
1431 /* See comment in "frame.h". */
1432 frame->frame = base;
b87efeee
AC
1433}
1434
c8b8a898
AC
1435void
1436deprecated_set_frame_saved_regs_hack (struct frame_info *frame,
1437 CORE_ADDR *saved_regs)
1438{
1439 frame->saved_regs = saved_regs;
1440}
1441
1442void
1443deprecated_set_frame_extra_info_hack (struct frame_info *frame,
1444 struct frame_extra_info *extra_info)
1445{
1446 frame->extra_info = extra_info;
1447}
1448
483d36b2
AC
1449void
1450deprecated_set_frame_next_hack (struct frame_info *fi,
1451 struct frame_info *next)
1452{
1453 fi->next = next;
1454}
1455
1456void
1457deprecated_set_frame_prev_hack (struct frame_info *fi,
1458 struct frame_info *prev)
1459{
1460 fi->prev = prev;
1461}
1462
2d75187b
AC
1463struct context *
1464deprecated_get_frame_context (struct frame_info *fi)
1465{
1466 return fi->context;
1467}
1468
1469void
1470deprecated_set_frame_context (struct frame_info *fi,
1471 struct context *context)
1472{
1473 fi->context = context;
1474}
1475
c8b8a898
AC
1476struct frame_info *
1477deprecated_frame_xmalloc (void)
1478{
1479 struct frame_info *frame = XMALLOC (struct frame_info);
1480 memset (frame, 0, sizeof (struct frame_info));
1481 return frame;
1482}
1483
f6c609c4
AC
1484struct frame_info *
1485deprecated_frame_xmalloc_with_cleanup (long sizeof_saved_regs,
1486 long sizeof_extra_info)
1487{
1488 struct frame_info *frame = deprecated_frame_xmalloc ();
1489 make_cleanup (xfree, frame);
1490 if (sizeof_saved_regs > 0)
1491 {
1492 frame->saved_regs = xcalloc (1, sizeof_saved_regs);
1493 make_cleanup (xfree, frame->saved_regs);
1494 }
1495 if (sizeof_extra_info > 0)
1496 {
1497 frame->extra_info = xcalloc (1, sizeof_extra_info);
1498 make_cleanup (xfree, frame->extra_info);
1499 }
1500 return frame;
1501}
c8b8a898 1502
4c1e7e9d
AC
1503void
1504_initialize_frame (void)
1505{
1506 obstack_init (&frame_cache_obstack);
eb4f72c5
AC
1507
1508 /* FIXME: cagney/2003-01-19: This command needs a rename. Suggest
1509 `set backtrace {past,beyond,...}-main'. Also suggest adding `set
1510 backtrace ...-start' to control backtraces past start. The
1511 problem with `below' is that it stops the `up' command. */
1512
1513 add_setshow_boolean_cmd ("backtrace-below-main", class_obscure,
1514 &backtrace_below_main, "\
1515Set whether backtraces should continue past \"main\".\n\
1516Normally the caller of \"main\" is not of interest, so GDB will terminate\n\
1517the backtrace at \"main\". Set this variable if you need to see the rest\n\
1518of the stack trace.", "\
1519Show whether backtraces should continue past \"main\".\n\
1520Normally the caller of \"main\" is not of interest, so GDB will terminate\n\
1521the backtrace at \"main\". Set this variable if you need to see the rest\n\
1522of the stack trace.",
1523 NULL, NULL, &setlist, &showlist);
4c1e7e9d 1524}
This page took 0.354677 seconds and 4 git commands to generate.