]> Git Repo - binutils.git/blob - gdb/frame.c
2003-01-29 Andrew Cagney <[email protected]>
[binutils.git] / gdb / frame.c
1 /* Cache and manage frames for GDB, the GNU debugger.
2
3    Copyright 1986, 1987, 1989, 1991, 1994, 1995, 1996, 1998, 2000,
4    2001, 2002, 2003 Free Software Foundation, Inc.
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"
27 #include "inferior.h"   /* for inferior_ptid */
28 #include "regcache.h"
29 #include "gdb_assert.h"
30 #include "gdb_string.h"
31 #include "builtin-regs.h"
32 #include "gdb_obstack.h"
33 #include "dummy-frame.h"
34 #include "sentinel-frame.h"
35 #include "gdbcore.h"
36 #include "annotate.h"
37 #include "language.h"
38 #include "frame-unwind.h"
39 #include "command.h"
40 #include "gdbcmd.h"
41
42 /* Flag to indicate whether backtraces should stop at main.  */
43
44 static int backtrace_below_main;
45
46 /* Return a frame uniq ID that can be used to, later, re-find the
47    frame.  */
48
49 struct frame_id
50 get_frame_id (struct frame_info *fi)
51 {
52   if (fi == NULL)
53     {
54       return null_frame_id;
55     }
56   else
57     {
58       struct frame_id id;
59       id.base = fi->frame;
60       id.pc = fi->pc;
61       return id;
62     }
63 }
64
65 const struct frame_id null_frame_id; /* All zeros.  */
66
67 struct frame_id
68 frame_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
76 int
77 frame_id_p (struct frame_id l)
78 {
79   /* The .func can be NULL but the .base cannot.  */
80   return (l.base != 0);
81 }
82
83 int
84 frame_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
94 int
95 frame_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
104 struct frame_info *
105 frame_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()?  */
111   if (!frame_id_p (id))
112     return NULL;
113
114   for (frame = get_current_frame ();
115        frame != NULL;
116        frame = get_prev_frame (frame))
117     {
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.  */
124         return NULL;
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.  */
129     }
130   return NULL;
131 }
132
133 CORE_ADDR
134 frame_pc_unwind (struct frame_info *frame)
135 {
136   if (!frame->pc_unwind_cache_p)
137     {
138       frame->pc_unwind_cache = frame->unwind->pc (frame, &frame->unwind_cache);
139       frame->pc_unwind_cache_p = 1;
140     }
141   return frame->pc_unwind_cache;
142 }
143
144 struct frame_id
145 frame_id_unwind (struct frame_info *frame)
146 {
147   if (!frame->id_unwind_cache_p)
148     {
149       frame->unwind->id (frame, &frame->unwind_cache, &frame->id_unwind_cache);
150       frame->id_unwind_cache_p = 1;
151     }
152   return frame->id_unwind_cache;
153 }
154
155 void
156 frame_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 }
167
168 void
169 frame_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
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);
188
189   /* Ask this frame to unwind its register.  */
190   frame->unwind->reg (frame, &frame->unwind_cache, regnum,
191                       optimizedp, lvalp, addrp, realnump, bufferp);
192 }
193
194 void
195 frame_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
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);
238 }
239
240 void
241 frame_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
254 void
255 frame_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 }
267
268 void
269 frame_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.  */
289   gdb_assert (frame != NULL && frame->next != NULL);
290   frame_unwind_unsigned_register (frame->next, regnum, val);
291 }
292
293 void
294 frame_read_signed_register (struct frame_info *frame, int regnum,
295                             LONGEST *val)
296 {
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);
300 }
301
302 static void
303 generic_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
327   gdb_assert (frame != NULL && frame->next != NULL);
328   frame_register_unwind (frame->next, regnum, optimizedp, lvalp, addrp,
329                          &realnumx, raw_buffer);
330 }
331
332 void
333 get_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 {
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);
347 }
348
349 /* frame_register_read ()
350
351    Find and return the value of REGNUM for the specified stack frame.
352    The number of bytes copied is REGISTER_RAW_SIZE (REGNUM).
353
354    Returns 0 if the register value could not be found.  */
355
356 int
357 frame_register_read (struct frame_info *frame, int regnum, void *myaddr)
358 {
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);
364
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
372   if (register_cached (regnum) < 0)
373     return 0;                   /* register value not available */
374
375   return !optimized;
376 }
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
383 int
384 frame_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
409 const char *
410 frame_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 }
418
419 /* Create a sentinel frame.  */
420
421 struct frame_info *
422 create_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
445 /* Info about the innermost stack frame (contents of FP register) */
446
447 static 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
453 static struct obstack frame_cache_obstack;
454
455 void *
456 frame_obstack_zalloc (unsigned long size)
457 {
458   void *data = obstack_alloc (&frame_cache_obstack, size);
459   memset (data, 0, size);
460   return data;
461 }
462
463 CORE_ADDR *
464 frame_saved_regs_zalloc (struct frame_info *fi)
465 {
466   fi->saved_regs = (CORE_ADDR *)
467     frame_obstack_zalloc (SIZEOF_FRAME_SAVED_REGS);
468   return fi->saved_regs;
469 }
470
471 CORE_ADDR *
472 get_frame_saved_regs (struct frame_info *fi)
473 {
474   return fi->saved_regs;
475 }
476
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
482 static int
483 unwind_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 }
493
494 struct frame_info *
495 get_current_frame (void)
496 {
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.");
503   if (current_frame == NULL)
504     {
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         }
514     }
515   return current_frame;
516 }
517
518 /* The "selected" stack frame is used by default for local and arg
519    access.  May be zero, for no selected frame.  */
520
521 struct 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
527 struct frame_info *
528 get_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
542 void
543 select_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
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
581 static void
582 frame_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.)  */
593   gdb_assert (!(DEPRECATED_USE_GENERIC_DUMMY_FRAMES
594                 && (get_frame_type (frame) == DUMMY_FRAME)));
595
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
600   /* Load the saved_regs register cache.  */
601   if (get_frame_saved_regs (frame) == NULL)
602     FRAME_INIT_SAVED_REGS (frame);
603
604   if (get_frame_saved_regs (frame) != NULL
605       && get_frame_saved_regs (frame)[regnum] != 0)
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),
616                            get_frame_saved_regs (frame)[regnum]);
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;
624           *addrp = get_frame_saved_regs (frame)[regnum];
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 *));
636                   regs = frame_obstack_zalloc (sizeof_cache);
637                   (*cache) = regs;
638                 }
639               if (regs[regnum] == NULL)
640                 {
641                   regs[regnum]
642                     = frame_obstack_zalloc (REGISTER_RAW_SIZE (regnum));
643                   read_memory (get_frame_saved_regs (frame)[regnum], regs[regnum],
644                                REGISTER_RAW_SIZE (regnum));
645                 }
646               memcpy (bufferp, regs[regnum], REGISTER_RAW_SIZE (regnum));
647 #else
648               /* Read the value in from memory.  */
649               read_memory (get_frame_saved_regs (frame)[regnum], bufferp,
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
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);
663 }
664
665 static CORE_ADDR
666 frame_saved_regs_pc_unwind (struct frame_info *frame, void **cache)
667 {
668   gdb_assert (FRAME_SAVED_PC_P ());
669   return FRAME_SAVED_PC (frame);
670 }
671         
672 static void
673 frame_saved_regs_id_unwind (struct frame_info *next_frame, void **cache,
674                             struct frame_id *id)
675 {
676   int fromleaf;
677   CORE_ADDR base;
678   CORE_ADDR pc;
679
680   /* Start out by assuming it's NULL.  */
681   (*id) = null_frame_id;
682
683   if (frame_relative_level (next_frame) <= 0)
684     /* FIXME: 2002-11-09: Frameless functions can occure anywhere in
685        the frame chain, not just the inner most frame!  The generic,
686        per-architecture, frame code should handle this and the below
687        should simply be removed.  */
688     fromleaf = FRAMELESS_FUNCTION_INVOCATION (next_frame);
689   else
690     fromleaf = 0;
691
692   if (fromleaf)
693     /* A frameless inner-most frame.  The `FP' (which isn't an
694        architecture frame-pointer register!) of the caller is the same
695        as the callee.  */
696     /* FIXME: 2002-11-09: There isn't any reason to special case this
697        edge condition.  Instead the per-architecture code should hande
698        it locally.  */
699     base = get_frame_base (next_frame);
700   else
701     {
702       /* Two macros defined in tm.h specify the machine-dependent
703          actions to be performed here.
704
705          First, get the frame's chain-pointer.
706
707          If that is zero, the frame is the outermost frame or a leaf
708          called by the outermost frame.  This means that if start
709          calls main without a frame, we'll return 0 (which is fine
710          anyway).
711
712          Nope; there's a problem.  This also returns when the current
713          routine is a leaf of main.  This is unacceptable.  We move
714          this to after the ffi test; I'd rather have backtraces from
715          start go curfluy than have an abort called from main not show
716          main.  */
717       gdb_assert (FRAME_CHAIN_P ());
718       base = FRAME_CHAIN (next_frame);
719
720       if (!frame_chain_valid (base, next_frame))
721         return;
722     }
723   if (base == 0)
724     return;
725
726   /* FIXME: cagney/2002-06-08: This should probably return the frame's
727      function and not the PC (a.k.a. resume address).  */
728   pc = frame_pc_unwind (next_frame);
729   id->pc = pc;
730   id->base = base;
731 }
732         
733 static void
734 frame_saved_regs_pop (struct frame_info *fi, void **cache,
735                       struct regcache *regcache)
736 {
737   gdb_assert (POP_FRAME_P ());
738   POP_FRAME;
739 }
740
741 const struct frame_unwind trad_frame_unwinder = {
742   frame_saved_regs_pop,
743   frame_saved_regs_pc_unwind,
744   frame_saved_regs_id_unwind,
745   frame_saved_regs_register_unwind
746 };
747 const struct frame_unwind *trad_frame_unwind = &trad_frame_unwinder;
748
749
750 /* Function: get_saved_register
751    Find register number REGNUM relative to FRAME and put its (raw,
752    target format) contents in *RAW_BUFFER.  
753
754    Set *OPTIMIZED if the variable was optimized out (and thus can't be
755    fetched).  Note that this is never set to anything other than zero
756    in this implementation.
757
758    Set *LVAL to lval_memory, lval_register, or not_lval, depending on
759    whether the value was fetched from memory, from a register, or in a
760    strange and non-modifiable way (e.g. a frame pointer which was
761    calculated rather than fetched).  We will use not_lval for values
762    fetched from generic dummy frames.
763
764    Set *ADDRP to the address, either in memory or as a REGISTER_BYTE
765    offset into the registers array.  If the value is stored in a dummy
766    frame, set *ADDRP to zero.
767
768    To use this implementation, define a function called
769    "get_saved_register" in your target code, which simply passes all
770    of its arguments to this function.
771
772    The argument RAW_BUFFER must point to aligned memory.  */
773
774 void
775 deprecated_generic_get_saved_register (char *raw_buffer, int *optimized,
776                                        CORE_ADDR *addrp,
777                                        struct frame_info *frame, int regnum,
778                                        enum lval_type *lval)
779 {
780   if (!target_has_registers)
781     error ("No registers.");
782
783   gdb_assert (FRAME_INIT_SAVED_REGS_P ());
784
785   /* Normal systems don't optimize out things with register numbers.  */
786   if (optimized != NULL)
787     *optimized = 0;
788
789   if (addrp)                    /* default assumption: not found in memory */
790     *addrp = 0;
791
792   /* Note: since the current frame's registers could only have been
793      saved by frames INTERIOR TO the current frame, we skip examining
794      the current frame itself: otherwise, we would be getting the
795      previous frame's registers which were saved by the current frame.  */
796
797   if (frame != NULL)
798     {
799       for (frame = get_next_frame (frame);
800            frame_relative_level (frame) >= 0;
801            frame = get_next_frame (frame))
802         {
803           if (get_frame_type (frame) == DUMMY_FRAME)
804             {
805               if (lval)         /* found it in a CALL_DUMMY frame */
806                 *lval = not_lval;
807               if (raw_buffer)
808                 /* FIXME: cagney/2002-06-26: This should be via the
809                    gdbarch_register_read() method so that it, on the
810                    fly, constructs either a raw or pseudo register
811                    from the raw register cache.  */
812                 regcache_raw_read
813                   (generic_find_dummy_frame (get_frame_pc (frame),
814                                              get_frame_base (frame)),
815                    regnum, raw_buffer);
816               return;
817             }
818
819           FRAME_INIT_SAVED_REGS (frame);
820           if (get_frame_saved_regs (frame) != NULL
821               && get_frame_saved_regs (frame)[regnum] != 0)
822             {
823               if (lval)         /* found it saved on the stack */
824                 *lval = lval_memory;
825               if (regnum == SP_REGNUM)
826                 {
827                   if (raw_buffer)       /* SP register treated specially */
828                     store_address (raw_buffer, REGISTER_RAW_SIZE (regnum),
829                                    get_frame_saved_regs (frame)[regnum]);
830                 }
831               else
832                 {
833                   if (addrp)    /* any other register */
834                     *addrp = get_frame_saved_regs (frame)[regnum];
835                   if (raw_buffer)
836                     read_memory (get_frame_saved_regs (frame)[regnum], raw_buffer,
837                                  REGISTER_RAW_SIZE (regnum));
838                 }
839               return;
840             }
841         }
842     }
843
844   /* If we get thru the loop to this point, it means the register was
845      not saved in any frame.  Return the actual live-register value.  */
846
847   if (lval)                     /* found it in a live register */
848     *lval = lval_register;
849   if (addrp)
850     *addrp = REGISTER_BYTE (regnum);
851   if (raw_buffer)
852     deprecated_read_register_gen (regnum, raw_buffer);
853 }
854
855 /* Determine the frame's type based on its PC.  */
856
857 static enum frame_type
858 frame_type_from_pc (CORE_ADDR pc)
859 {
860   /* FIXME: cagney/2002-11-24: Can't yet directly call
861      pc_in_dummy_frame() as some architectures don't set
862      PC_IN_CALL_DUMMY() to generic_pc_in_call_dummy() (remember the
863      latter is implemented by simply calling pc_in_dummy_frame).  */
864   if (DEPRECATED_USE_GENERIC_DUMMY_FRAMES
865       && DEPRECATED_PC_IN_CALL_DUMMY (pc, 0, 0))
866     return DUMMY_FRAME;
867   else
868     {
869       char *name;
870       find_pc_partial_function (pc, &name, NULL, NULL);
871       if (PC_IN_SIGTRAMP (pc, name))
872         return SIGTRAMP_FRAME;
873       else
874         return NORMAL_FRAME;
875     }
876 }
877
878 /* Create an arbitrary (i.e. address specified by user) or innermost frame.
879    Always returns a non-NULL value.  */
880
881 struct frame_info *
882 create_new_frame (CORE_ADDR addr, CORE_ADDR pc)
883 {
884   struct frame_info *fi;
885
886   fi = frame_obstack_zalloc (sizeof (struct frame_info));
887
888   fi->frame = addr;
889   fi->pc = pc;
890   fi->next = create_sentinel_frame (current_regcache);
891   fi->type = frame_type_from_pc (pc);
892
893   if (INIT_EXTRA_FRAME_INFO_P ())
894     INIT_EXTRA_FRAME_INFO (0, fi);
895
896   /* Select/initialize an unwind function.  */
897   fi->unwind = frame_unwind_find_by_pc (current_gdbarch, fi->pc);
898
899   return fi;
900 }
901
902 /* Return the frame that FRAME calls (NULL if FRAME is the innermost
903    frame).  Be careful to not fall off the bottom of the frame chain
904    and onto the sentinel frame.  */
905
906 struct frame_info *
907 get_next_frame (struct frame_info *frame)
908 {
909   if (frame->level > 0)
910     return frame->next;
911   else
912     return NULL;
913 }
914
915 /* Flush the entire frame cache.  */
916
917 void
918 flush_cached_frames (void)
919 {
920   /* Since we can't really be sure what the first object allocated was */
921   obstack_free (&frame_cache_obstack, 0);
922   obstack_init (&frame_cache_obstack);
923
924   current_frame = NULL;         /* Invalidate cache */
925   select_frame (NULL);
926   annotate_frames_invalid ();
927 }
928
929 /* Flush the frame cache, and start a new one if necessary.  */
930
931 void
932 reinit_frame_cache (void)
933 {
934   flush_cached_frames ();
935
936   /* FIXME: The inferior_ptid test is wrong if there is a corefile.  */
937   if (PIDGET (inferior_ptid) != 0)
938     {
939       select_frame (get_current_frame ());
940     }
941 }
942
943 /* Create the previous frame using the deprecated methods
944    INIT_EXTRA_INFO, INIT_FRAME_PC and INIT_FRAME_PC_FIRST.  */
945
946 static struct frame_info *
947 legacy_get_prev_frame (struct frame_info *next_frame)
948 {
949   CORE_ADDR address = 0;
950   struct frame_info *prev;
951   int fromleaf;
952
953   /* This code only works on normal frames.  A sentinel frame, where
954      the level is -1, should never reach this code.  */
955   gdb_assert (next_frame->level >= 0);
956
957   /* On some machines it is possible to call a function without
958      setting up a stack frame for it.  On these machines, we
959      define this macro to take two args; a frameinfo pointer
960      identifying a frame and a variable to set or clear if it is
961      or isn't leafless.  */
962
963   /* Still don't want to worry about this except on the innermost
964      frame.  This macro will set FROMLEAF if NEXT_FRAME is a frameless
965      function invocation.  */
966   if (next_frame->level == 0)
967     /* FIXME: 2002-11-09: Frameless functions can occure anywhere in
968        the frame chain, not just the inner most frame!  The generic,
969        per-architecture, frame code should handle this and the below
970        should simply be removed.  */
971     fromleaf = FRAMELESS_FUNCTION_INVOCATION (next_frame);
972   else
973     fromleaf = 0;
974
975   if (fromleaf)
976     /* A frameless inner-most frame.  The `FP' (which isn't an
977        architecture frame-pointer register!) of the caller is the same
978        as the callee.  */
979     /* FIXME: 2002-11-09: There isn't any reason to special case this
980        edge condition.  Instead the per-architecture code should hande
981        it locally.  */
982     address = get_frame_base (next_frame);
983   else
984     {
985       /* Two macros defined in tm.h specify the machine-dependent
986          actions to be performed here.
987
988          First, get the frame's chain-pointer.
989
990          If that is zero, the frame is the outermost frame or a leaf
991          called by the outermost frame.  This means that if start
992          calls main without a frame, we'll return 0 (which is fine
993          anyway).
994
995          Nope; there's a problem.  This also returns when the current
996          routine is a leaf of main.  This is unacceptable.  We move
997          this to after the ffi test; I'd rather have backtraces from
998          start go curfluy than have an abort called from main not show
999          main.  */
1000       gdb_assert (FRAME_CHAIN_P ());
1001       address = FRAME_CHAIN (next_frame);
1002
1003       if (!frame_chain_valid (address, next_frame))
1004         return 0;
1005     }
1006   if (address == 0)
1007     return 0;
1008
1009   /* Create an initially zero previous frame.  */
1010   prev = frame_obstack_zalloc (sizeof (struct frame_info));
1011
1012   /* Link it in.  */
1013   next_frame->prev = prev;
1014   prev->next = next_frame;
1015   prev->frame = address;
1016   prev->level = next_frame->level + 1;
1017   /* FIXME: cagney/2002-11-18: Should be setting the frame's type
1018      here, before anything else, and not last.  Various INIT functions
1019      are full of work-arounds for the frames type not being set
1020      correctly from the word go.  Ulgh!  */
1021   prev->type = NORMAL_FRAME;
1022
1023   /* This change should not be needed, FIXME!  We should determine
1024      whether any targets *need* DEPRECATED_INIT_FRAME_PC to happen
1025      after INIT_EXTRA_FRAME_INFO and come up with a simple way to
1026      express what goes on here.
1027
1028      INIT_EXTRA_FRAME_INFO is called from two places: create_new_frame
1029      (where the PC is already set up) and here (where it isn't).
1030      DEPRECATED_INIT_FRAME_PC is only called from here, always after
1031      INIT_EXTRA_FRAME_INFO.
1032
1033      The catch is the MIPS, where INIT_EXTRA_FRAME_INFO requires the
1034      PC value (which hasn't been set yet).  Some other machines appear
1035      to require INIT_EXTRA_FRAME_INFO before they can do
1036      DEPRECATED_INIT_FRAME_PC.  Phoo.
1037
1038      We shouldn't need DEPRECATED_INIT_FRAME_PC_FIRST to add more
1039      complication to an already overcomplicated part of GDB.
1040      [email protected], 15Sep92.
1041
1042      Assuming that some machines need DEPRECATED_INIT_FRAME_PC after
1043      INIT_EXTRA_FRAME_INFO, one possible scheme:
1044
1045      SETUP_INNERMOST_FRAME(): Default version is just create_new_frame
1046      (read_fp ()), read_pc ()).  Machines with extra frame info would
1047      do that (or the local equivalent) and then set the extra fields.
1048
1049      SETUP_ARBITRARY_FRAME(argc, argv): Only change here is that
1050      create_new_frame would no longer init extra frame info;
1051      SETUP_ARBITRARY_FRAME would have to do that.
1052
1053      INIT_PREV_FRAME(fromleaf, prev) Replace INIT_EXTRA_FRAME_INFO and
1054      DEPRECATED_INIT_FRAME_PC.  This should also return a flag saying
1055      whether to keep the new frame, or whether to discard it, because
1056      on some machines (e.g.  mips) it is really awkward to have
1057      FRAME_CHAIN_VALID called *before* INIT_EXTRA_FRAME_INFO (there is
1058      no good way to get information deduced in FRAME_CHAIN_VALID into
1059      the extra fields of the new frame).  std_frame_pc(fromleaf, prev)
1060
1061      This is the default setting for INIT_PREV_FRAME.  It just does
1062      what the default DEPRECATED_INIT_FRAME_PC does.  Some machines
1063      will call it from INIT_PREV_FRAME (either at the beginning, the
1064      end, or in the middle).  Some machines won't use it.
1065
1066      [email protected], 13Apr93, 31Jan94, 14Dec94.  */
1067
1068   /* NOTE: cagney/2002-11-09: Just ignore the above!  There is no
1069      reason for things to be this complicated.
1070
1071      The trick is to assume that there is always a frame.  Instead of
1072      special casing the inner-most frame, create fake frame
1073      (containing the hardware registers) that is inner to the
1074      user-visible inner-most frame (...) and then unwind from that.
1075      That way architecture code can use use the standard
1076      frame_XX_unwind() functions and not differentiate between the
1077      inner most and any other case.
1078
1079      Since there is always a frame to unwind from, there is always
1080      somewhere (NEXT_FRAME) to store all the info needed to construct
1081      a new (previous) frame without having to first create it.  This
1082      means that the convolution below - needing to carefully order a
1083      frame's initialization - isn't needed.
1084
1085      The irony here though, is that FRAME_CHAIN(), at least for a more
1086      up-to-date architecture, always calls FRAME_SAVED_PC(), and
1087      FRAME_SAVED_PC() computes the PC but without first needing the
1088      frame!  Instead of the convolution below, we could have simply
1089      called FRAME_SAVED_PC() and been done with it!  Note that
1090      FRAME_SAVED_PC() is being superseed by frame_pc_unwind() and that
1091      function does have somewhere to cache that PC value.  */
1092
1093   if (DEPRECATED_INIT_FRAME_PC_FIRST_P ())
1094     prev->pc = (DEPRECATED_INIT_FRAME_PC_FIRST (fromleaf, prev));
1095
1096   if (INIT_EXTRA_FRAME_INFO_P ())
1097     INIT_EXTRA_FRAME_INFO (fromleaf, prev);
1098
1099   /* This entry is in the frame queue now, which is good since
1100      FRAME_SAVED_PC may use that queue to figure out its value (see
1101      tm-sparc.h).  We want the pc saved in the inferior frame. */
1102   if (DEPRECATED_INIT_FRAME_PC_P ())
1103     prev->pc = DEPRECATED_INIT_FRAME_PC (fromleaf, prev);
1104
1105   /* If ->frame and ->pc are unchanged, we are in the process of
1106      getting ourselves into an infinite backtrace.  Some architectures
1107      check this in FRAME_CHAIN or thereabouts, but it seems like there
1108      is no reason this can't be an architecture-independent check.  */
1109   if (prev->frame == next_frame->frame
1110       && prev->pc == next_frame->pc)
1111     {
1112       next_frame->prev = NULL;
1113       obstack_free (&frame_cache_obstack, prev);
1114       return NULL;
1115     }
1116
1117   /* Initialize the code used to unwind the frame PREV based on the PC
1118      (and probably other architectural information).  The PC lets you
1119      check things like the debug info at that point (dwarf2cfi?) and
1120      use that to decide how the frame should be unwound.  */
1121   prev->unwind = frame_unwind_find_by_pc (current_gdbarch, prev->pc);
1122
1123   /* NOTE: cagney/2002-11-18: The code segments, found in
1124      create_new_frame and get_prev_frame(), that initializes the
1125      frames type is subtly different.  The latter only updates ->type
1126      when it encounters a SIGTRAMP_FRAME or DUMMY_FRAME.  This stops
1127      get_prev_frame() overriding the frame's type when the INIT code
1128      has previously set it.  This is really somewhat bogus.  The
1129      initialization, as seen in create_new_frame(), should occur
1130      before the INIT function has been called.  */
1131   if (DEPRECATED_USE_GENERIC_DUMMY_FRAMES
1132       && (DEPRECATED_PC_IN_CALL_DUMMY_P ()
1133           ? DEPRECATED_PC_IN_CALL_DUMMY (prev->pc, 0, 0)
1134           : pc_in_dummy_frame (prev->pc)))
1135     prev->type = DUMMY_FRAME;
1136   else
1137     {
1138       /* FIXME: cagney/2002-11-10: This should be moved to before the
1139          INIT code above so that the INIT code knows what the frame's
1140          type is (in fact, for a [generic] dummy-frame, the type can
1141          be set and then the entire initialization can be skipped.
1142          Unforunatly, its the INIT code that sets the PC (Hmm, catch
1143          22).  */
1144       char *name;
1145       find_pc_partial_function (prev->pc, &name, NULL, NULL);
1146       if (PC_IN_SIGTRAMP (prev->pc, name))
1147         prev->type = SIGTRAMP_FRAME;
1148       /* FIXME: cagney/2002-11-11: Leave prev->type alone.  Some
1149          architectures are forcing the frame's type in INIT so we
1150          don't want to override it here.  Remember, NORMAL_FRAME == 0,
1151          so it all works (just :-/).  Once this initialization is
1152          moved to the start of this function, all this nastness will
1153          go away.  */
1154     }
1155
1156   return prev;
1157 }
1158
1159 /* Return a structure containing various interesting information
1160    about the frame that called NEXT_FRAME.  Returns NULL
1161    if there is no such frame.  */
1162
1163 struct frame_info *
1164 get_prev_frame (struct frame_info *next_frame)
1165 {
1166   struct frame_info *prev_frame;
1167
1168   /* Return the inner-most frame, when the caller passes in NULL.  */
1169   /* NOTE: cagney/2002-11-09: Not sure how this would happen.  The
1170      caller should have previously obtained a valid frame using
1171      get_selected_frame() and then called this code - only possibility
1172      I can think of is code behaving badly.
1173
1174      NOTE: cagney/2003-01-10: Talk about code behaving badly.  Check
1175      block_innermost_frame().  It does the sequence: frame = NULL;
1176      while (1) { frame = get_prev_frame (frame); .... }.  Ulgh!  Why
1177      it couldn't be written better, I don't know.
1178
1179      NOTE: cagney/2003-01-11: I suspect what is happening is
1180      block_innermost_frame() is, when the target has no state
1181      (registers, memory, ...), still calling this function.  The
1182      assumption being that this function will return NULL indicating
1183      that a frame isn't possible, rather than checking that the target
1184      has state and then calling get_current_frame() and
1185      get_prev_frame().  This is a guess mind.  */
1186   if (next_frame == NULL)
1187     {
1188       /* NOTE: cagney/2002-11-09: There was a code segment here that
1189          would error out when CURRENT_FRAME was NULL.  The comment
1190          that went with it made the claim ...
1191
1192          ``This screws value_of_variable, which just wants a nice
1193          clean NULL return from block_innermost_frame if there are no
1194          frames.  I don't think I've ever seen this message happen
1195          otherwise.  And returning NULL here is a perfectly legitimate
1196          thing to do.''
1197
1198          Per the above, this code shouldn't even be called with a NULL
1199          NEXT_FRAME.  */
1200       return current_frame;
1201     }
1202
1203   /* There is always a frame.  If this assertion fails, suspect that
1204      something should be calling get_selected_frame() or
1205      get_current_frame().  */
1206   gdb_assert (next_frame != NULL);
1207
1208   if (next_frame->level >= 0
1209       && !backtrace_below_main
1210       && inside_main_func (get_frame_pc (next_frame)))
1211     /* Don't unwind past main(), bug always unwind the sentinel frame.
1212        Note, this is done _before_ the frame has been marked as
1213        previously unwound.  That way if the user later decides to
1214        allow unwinds past main(), that just happens.  */
1215     return NULL;
1216
1217   /* Only try to do the unwind once.  */
1218   if (next_frame->prev_p)
1219     return next_frame->prev;
1220   next_frame->prev_p = 1;
1221
1222   /* If we're inside the entry file, it isn't valid.  */
1223   /* NOTE: drow/2002-12-25: should there be a way to disable this
1224      check?  It assumes a single small entry file, and the way some
1225      debug readers (e.g.  dbxread) figure out which object is the
1226      entry file is somewhat hokey.  */
1227   /* NOTE: cagney/2003-01-10: If there is a way of disabling this test
1228      then it should probably be moved to before the ->prev_p test,
1229      above.  */
1230   if (inside_entry_file (get_frame_pc (next_frame)))
1231       return NULL;
1232
1233   /* If any of the old frame initialization methods are around, use
1234      the legacy get_prev_frame method.  Just don't try to unwind a
1235      sentinel frame using that method - it doesn't work.  All sentinal
1236      frames use the new unwind code.  */
1237   if ((DEPRECATED_INIT_FRAME_PC_P ()
1238        || DEPRECATED_INIT_FRAME_PC_FIRST_P ()
1239        || INIT_EXTRA_FRAME_INFO_P ()
1240        || FRAME_CHAIN_P ())
1241       && next_frame->level >= 0)
1242     return legacy_get_prev_frame (next_frame);
1243
1244   /* Allocate the new frame but do not wire it in to the frame chain.
1245      Some (bad) code in INIT_FRAME_EXTRA_INFO tries to look along
1246      frame->next to pull some fancy tricks (of course such code is, by
1247      definition, recursive).  Try to prevent it.
1248
1249      There is no reason to worry about memory leaks, should the
1250      remainder of the function fail.  The allocated memory will be
1251      quickly reclaimed when the frame cache is flushed, and the `we've
1252      been here before' check above will stop repeated memory
1253      allocation calls.  */
1254   prev_frame = FRAME_OBSTACK_ZALLOC (struct frame_info);
1255   prev_frame->level = next_frame->level + 1;
1256
1257   /* Try to unwind the PC.  If that doesn't work, assume we've reached
1258      the oldest frame and simply return.  Is there a better sentinal
1259      value?  The unwound PC value is then used to initialize the new
1260      previous frame's type.
1261
1262      Note that the pc-unwind is intentionally performed before the
1263      frame chain.  This is ok since, for old targets, both
1264      frame_pc_unwind (nee, FRAME_SAVED_PC) and FRAME_CHAIN()) assume
1265      NEXT_FRAME's data structures have already been initialized (using
1266      INIT_EXTRA_FRAME_INFO) and hence the call order doesn't matter.
1267
1268      By unwinding the PC first, it becomes possible to, in the case of
1269      a dummy frame, avoid also unwinding the frame ID.  This is
1270      because (well ignoring the PPC) a dummy frame can be located
1271      using NEXT_FRAME's frame ID.  */
1272
1273   prev_frame->pc = frame_pc_unwind (next_frame);
1274   if (prev_frame->pc == 0)
1275     /* The allocated PREV_FRAME will be reclaimed when the frame
1276        obstack is next purged.  */
1277     return NULL;
1278   prev_frame->type = frame_type_from_pc (prev_frame->pc);
1279
1280   /* Set the unwind functions based on that identified PC.  */
1281   prev_frame->unwind = frame_unwind_find_by_pc (current_gdbarch,
1282                                                 prev_frame->pc);
1283
1284   /* FIXME: cagney/2003-01-13: A dummy frame doesn't need to unwind
1285      the frame ID because the frame ID comes from the previous frame.
1286      The other frames do though.  True?  */
1287   {
1288     /* FIXME: cagney/2002-12-18: Instead of this hack, should just
1289        save the frame ID directly.  */
1290     struct frame_id id = frame_id_unwind (next_frame);
1291     if (!frame_id_p (id))
1292       return NULL;
1293     prev_frame->frame = id.base;
1294   }
1295
1296   /* Link it in.  */
1297   next_frame->prev = prev_frame;
1298   prev_frame->next = next_frame;
1299
1300   /* FIXME: cagney/2002-01-19: This call will go away.  Instead of
1301      initializing extra info, all frames will use the frame_cache
1302      (passed to the unwind functions) to store additional frame info.
1303      Unfortunatly legacy targets can't use legacy_get_prev_frame() to
1304      unwind the sentinel frame and, consequently, are forced to take
1305      this code path and rely on the below call to INIT_EXTR_FRAME_INFO
1306      to initialize the inner-most frame.  */
1307   if (INIT_EXTRA_FRAME_INFO_P ())
1308     {
1309       gdb_assert (prev_frame->level == 0);
1310       INIT_EXTRA_FRAME_INFO (0, prev_frame);
1311     }
1312
1313   return prev_frame;
1314 }
1315
1316 CORE_ADDR
1317 get_frame_pc (struct frame_info *frame)
1318 {
1319   return frame->pc;
1320 }
1321
1322 static int
1323 pc_notcurrent (struct frame_info *frame)
1324 {
1325   /* If FRAME is not the innermost frame, that normally means that
1326      FRAME->pc points at the return instruction (which is *after* the
1327      call instruction), and we want to get the line containing the
1328      call (because the call is where the user thinks the program is).
1329      However, if the next frame is either a SIGTRAMP_FRAME or a
1330      DUMMY_FRAME, then the next frame will contain a saved interrupt
1331      PC and such a PC indicates the current (rather than next)
1332      instruction/line, consequently, for such cases, want to get the
1333      line containing fi->pc.  */
1334   struct frame_info *next = get_next_frame (frame);
1335   int notcurrent = (next != NULL && get_frame_type (next) == NORMAL_FRAME);
1336   return notcurrent;
1337 }
1338
1339 void
1340 find_frame_sal (struct frame_info *frame, struct symtab_and_line *sal)
1341 {
1342   (*sal) = find_pc_line (frame->pc, pc_notcurrent (frame));
1343 }
1344
1345 /* Per "frame.h", return the ``address'' of the frame.  Code should
1346    really be using get_frame_id().  */
1347 CORE_ADDR
1348 get_frame_base (struct frame_info *fi)
1349 {
1350   return fi->frame;
1351 }
1352
1353 /* Level of the selected frame: 0 for innermost, 1 for its caller, ...
1354    or -1 for a NULL frame.  */
1355
1356 int
1357 frame_relative_level (struct frame_info *fi)
1358 {
1359   if (fi == NULL)
1360     return -1;
1361   else
1362     return fi->level;
1363 }
1364
1365 enum frame_type
1366 get_frame_type (struct frame_info *frame)
1367 {
1368   /* Some targets still don't use [generic] dummy frames.  Catch them
1369      here.  */
1370   if (!DEPRECATED_USE_GENERIC_DUMMY_FRAMES
1371       && deprecated_frame_in_dummy (frame))
1372     return DUMMY_FRAME;
1373   return frame->type;
1374 }
1375
1376 void
1377 deprecated_set_frame_type (struct frame_info *frame, enum frame_type type)
1378 {
1379   /* Arrrg!  See comment in "frame.h".  */
1380   frame->type = type;
1381 }
1382
1383 #ifdef FRAME_FIND_SAVED_REGS
1384 /* XXX - deprecated.  This is a compatibility function for targets
1385    that do not yet implement FRAME_INIT_SAVED_REGS.  */
1386 /* Find the addresses in which registers are saved in FRAME.  */
1387
1388 void
1389 deprecated_get_frame_saved_regs (struct frame_info *frame,
1390                                  struct frame_saved_regs *saved_regs_addr)
1391 {
1392   if (frame->saved_regs == NULL)
1393     {
1394       frame->saved_regs = (CORE_ADDR *)
1395         frame_obstack_zalloc (SIZEOF_FRAME_SAVED_REGS);
1396     }
1397   if (saved_regs_addr == NULL)
1398     {
1399       struct frame_saved_regs saved_regs;
1400       FRAME_FIND_SAVED_REGS (frame, saved_regs);
1401       memcpy (frame->saved_regs, &saved_regs, SIZEOF_FRAME_SAVED_REGS);
1402     }
1403   else
1404     {
1405       FRAME_FIND_SAVED_REGS (frame, *saved_regs_addr);
1406       memcpy (frame->saved_regs, saved_regs_addr, SIZEOF_FRAME_SAVED_REGS);
1407     }
1408 }
1409 #endif
1410
1411 struct frame_extra_info *
1412 get_frame_extra_info (struct frame_info *fi)
1413 {
1414   return fi->extra_info;
1415 }
1416
1417 struct frame_extra_info *
1418 frame_extra_info_zalloc (struct frame_info *fi, long size)
1419 {
1420   fi->extra_info = frame_obstack_zalloc (size);
1421   return fi->extra_info;
1422 }
1423
1424 void
1425 deprecated_update_frame_pc_hack (struct frame_info *frame, CORE_ADDR pc)
1426 {
1427   /* See comment in "frame.h".  */
1428   gdb_assert (frame->next != NULL);
1429   frame->pc = pc;
1430 }
1431
1432 void
1433 deprecated_update_frame_base_hack (struct frame_info *frame, CORE_ADDR base)
1434 {
1435   /* See comment in "frame.h".  */
1436   frame->frame = base;
1437 }
1438
1439 void
1440 deprecated_set_frame_saved_regs_hack (struct frame_info *frame,
1441                                       CORE_ADDR *saved_regs)
1442 {
1443   frame->saved_regs = saved_regs;
1444 }
1445
1446 void
1447 deprecated_set_frame_extra_info_hack (struct frame_info *frame,
1448                                       struct frame_extra_info *extra_info)
1449 {
1450   frame->extra_info = extra_info;
1451 }
1452
1453 void
1454 deprecated_set_frame_next_hack (struct frame_info *fi,
1455                                 struct frame_info *next)
1456 {
1457   fi->next = next;
1458 }
1459
1460 void
1461 deprecated_set_frame_prev_hack (struct frame_info *fi,
1462                                 struct frame_info *prev)
1463 {
1464   fi->prev = prev;
1465 }
1466
1467 struct context *
1468 deprecated_get_frame_context (struct frame_info *fi)
1469 {
1470   return fi->context;
1471 }
1472
1473 void
1474 deprecated_set_frame_context (struct frame_info *fi,
1475                               struct context *context)
1476 {
1477   fi->context = context;
1478 }
1479
1480 struct frame_info *
1481 deprecated_frame_xmalloc (void)
1482 {
1483   struct frame_info *frame = XMALLOC (struct frame_info);
1484   memset (frame, 0, sizeof (struct frame_info));
1485   return frame;
1486 }
1487
1488 struct frame_info *
1489 deprecated_frame_xmalloc_with_cleanup (long sizeof_saved_regs,
1490                                        long sizeof_extra_info)
1491 {
1492   struct frame_info *frame = deprecated_frame_xmalloc ();
1493   make_cleanup (xfree, frame);
1494   if (sizeof_saved_regs > 0)
1495     {
1496       frame->saved_regs = xcalloc (1, sizeof_saved_regs);
1497       make_cleanup (xfree, frame->saved_regs);
1498     }
1499   if (sizeof_extra_info > 0)
1500     {
1501       frame->extra_info = xcalloc (1, sizeof_extra_info);
1502       make_cleanup (xfree, frame->extra_info);
1503     }
1504   return frame;
1505 }
1506
1507 void
1508 _initialize_frame (void)
1509 {
1510   obstack_init (&frame_cache_obstack);
1511
1512   /* FIXME: cagney/2003-01-19: This command needs a rename.  Suggest
1513      `set backtrace {past,beyond,...}-main'.  Also suggest adding `set
1514      backtrace ...-start' to control backtraces past start.  The
1515      problem with `below' is that it stops the `up' command.  */
1516
1517   add_setshow_boolean_cmd ("backtrace-below-main", class_obscure,
1518                            &backtrace_below_main, "\
1519 Set whether backtraces should continue past \"main\".\n\
1520 Normally the caller of \"main\" is not of interest, so GDB will terminate\n\
1521 the backtrace at \"main\".  Set this variable if you need to see the rest\n\
1522 of the stack trace.", "\
1523 Show whether backtraces should continue past \"main\".\n\
1524 Normally the caller of \"main\" is not of interest, so GDB will terminate\n\
1525 the backtrace at \"main\".  Set this variable if you need to see the rest\n\
1526 of the stack trace.",
1527                            NULL, NULL, &setlist, &showlist);
1528 }
This page took 0.108064 seconds and 4 git commands to generate.