]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blobdiff - gdb/trad-frame.h
Switch the license of all .c files to GPLv3.
[thirdparty/binutils-gdb.git] / gdb / trad-frame.h
index ab58e358e312807d167c753a3fc8e4917a31eac9..010137c38dbaccf96e9fb8f8a895ab98ec4b8173 100644 (file)
@@ -1,12 +1,12 @@
 /* Traditional frame unwind support, for GDB the GNU Debugger.
 
-   Copyright 2003 Free Software Foundation, Inc.
+   Copyright (C) 2003, 2004, 2007 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #ifndef TRAD_FRAME_H
 #define TRAD_FRAME_H
 
-struct trad_frame
+#include "frame.h"             /* For "struct frame_id".  */
+
+struct frame_info;
+struct trad_frame_cache;
+
+/* A simple, or traditional frame cache.
+
+   The entire cache is populated in a single pass and then generic
+   routines are used to extract the various cache values.  */
+
+struct trad_frame_cache *trad_frame_cache_zalloc (struct frame_info *next_frame);
+
+/* This frame's ID.  */
+void trad_frame_set_id (struct trad_frame_cache *this_trad_cache,
+                       struct frame_id this_id);
+void trad_frame_get_id (struct trad_frame_cache *this_trad_cache,
+                       struct frame_id *this_id);
+void trad_frame_set_this_base (struct trad_frame_cache *this_trad_cache,
+                              CORE_ADDR this_base);
+CORE_ADDR trad_frame_get_this_base (struct trad_frame_cache *this_trad_cache);
+
+void trad_frame_set_reg_realreg (struct trad_frame_cache *this_trad_cache,
+                                int regnum, int realreg);
+void trad_frame_set_reg_unknown (struct trad_frame_cache *this_trad_cache,
+                                int regnum, CORE_ADDR addr);
+void trad_frame_set_reg_addr (struct trad_frame_cache *this_trad_cache,
+                             int regnum, CORE_ADDR addr);
+void trad_frame_set_reg_value (struct trad_frame_cache *this_cache,
+                              int regnum, LONGEST val);
+
+void trad_frame_get_register (struct trad_frame_cache *this_trad_cache,
+                             struct frame_info *next_frame,
+                             int regnum, int *optimizedp,
+                             enum lval_type *lvalp, CORE_ADDR *addrp,
+                             int *realregp, gdb_byte *bufferp);
+
+/* A traditional saved regs table, indexed by REGNUM, encoding where
+   the value of REGNUM for the previous frame can be found in this
+   frame.
+
+   The table is initialized with an identity encoding (ADDR == -1,
+   REALREG == REGNUM) indicating that the value of REGNUM in the
+   previous frame can be found in register REGNUM (== REALREG) in this
+   frame.
+
+   The initial encoding can then be changed:
+
+   Modify ADDR (REALREG >= 0, ADDR != -1) to indicate that the value
+   of register REGNUM in the previous frame can be found in memory at
+   ADDR in this frame (addr_p, !realreg_p, !value_p).
+
+   Modify REALREG (REALREG >= 0, ADDR == -1) to indicate that the
+   value of register REGNUM in the previous frame is found in register
+   REALREG in this frame (!addr_p, realreg_p, !value_p).
+
+   Call trad_frame_set_value (REALREG == -1) to indicate that the
+   value of register REGNUM in the previous frame is found in ADDR
+   (!addr_p, !realreg_p, value_p).
+
+   Call trad_frame_set_unknown (REALREG == -2) to indicate that the
+   register's value is not known.  */
+
+struct trad_frame_saved_reg
 {
-  /* If non-zero (and regnum >= 0), the stack address at which the
-     register is saved.  By default, it is assumed that the register
-     was not saved (addr == 0).  Remember, a LONGEST can always fit a
-     CORE_ADDR.  */
-  LONGEST addr;
-  /* else, if regnum >=0 (and addr == 0), the REGNUM that contains
-     this registers value.  By default, it is assumed that the
-     registers are not moved (the register's value is still in that
-     register and regnum == the index).  */
-  int regnum;
-  /* else, if regnum < 0, ADDR is the registers value.  */
+  LONGEST addr; /* A CORE_ADDR fits in a longest.  */
+  int realreg;
 };
 
-/* Convenience function, encode the register's value in the
-   trad-frame.  */
-void trad_frame_register_value (struct trad_frame this_saved_regs[],
-                               int regnum, LONGEST val);
+/* Encode REGNUM value in the trad-frame.  */
+void trad_frame_set_value (struct trad_frame_saved_reg this_saved_regs[],
+                          int regnum, LONGEST val);
+
+/* Mark REGNUM as unknown.  */
+void trad_frame_set_unknown (struct trad_frame_saved_reg this_saved_regs[],
+                            int regnum);
+
+/* Convenience functions, return non-zero if the register has been
+   encoded as specified.  */
+int trad_frame_value_p (struct trad_frame_saved_reg this_saved_regs[],
+                       int regnum);
+int trad_frame_addr_p (struct trad_frame_saved_reg this_saved_regs[],
+                      int regnum);
+int trad_frame_realreg_p (struct trad_frame_saved_reg this_saved_regs[],
+                         int regnum);
+
 
 /* Return a freshly allocated (and initialized) trad_frame array.  */
-struct trad_frame *trad_frame_alloc_saved_regs (struct frame_info *next_frame);
+struct trad_frame_saved_reg *trad_frame_alloc_saved_regs (struct frame_info *next_frame);
 
 /* Given the trad_frame info, return the location of the specified
    register.  */
-void trad_frame_prev_register (struct frame_info *next_frame,
-                              struct trad_frame this_saved_regs[],
-                              int regnum, int *optimizedp,
-                              enum lval_type *lvalp, CORE_ADDR *addrp,
-                              int *realnump, void *bufferp);
+void trad_frame_get_prev_register (struct frame_info *next_frame,
+                                  struct trad_frame_saved_reg this_saved_regs[],
+                                  int regnum, int *optimizedp,
+                                  enum lval_type *lvalp, CORE_ADDR *addrp,
+                                  int *realregp, gdb_byte *bufferp);
 
 #endif