Thu Aug 7 13:39:31 1997 Geoffrey Noer <noer@cygnus.com>
[deliverable/binutils-gdb.git] / gdb / breakpoint.h
index 3949777c69615ed6b2d0cd3f7ced67e7dcb69439..0aa42f59d1dc0c58952613d48817f11670920c05 100644 (file)
@@ -1,5 +1,5 @@
 /* Data structures associated with breakpoints in GDB.
-   Copyright (C) 1992 Free Software Foundation, Inc.
+   Copyright (C) 1992, 1993, 1994, 1995, 1996 Free Software Foundation, Inc.
 
 This file is part of GDB.
 
@@ -15,7 +15,7 @@ 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., 675 Mass Ave, Cambridge, MA 02139, USA.  */
+Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
 
 #if !defined (BREAKPOINT_H)
 #define BREAKPOINT_H 1
@@ -29,11 +29,189 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
 
 #define        BREAKPOINT_MAX  16
 \f
-/* The follow stuff is an abstract data type "bpstat" ("breakpoint status").
+/* Type of breakpoint. */
+/* FIXME In the future, we should fold all other breakpoint-like things into
+   here.  This includes:
+
+   * single-step (for machines where we have to simulate single stepping)
+      (probably, though perhaps it is better for it to look as much as
+      possible like a single-step to wait_for_inferior).  */
+
+enum bptype {
+  bp_breakpoint,               /* Normal breakpoint */
+  bp_hardware_breakpoint,      /* Hardware assisted breakpoint */
+  bp_until,                    /* used by until command */
+  bp_finish,                   /* used by finish command */
+  bp_watchpoint,               /* Watchpoint */
+  bp_hardware_watchpoint,      /* Hardware assisted watchpoint */
+  bp_read_watchpoint,          /* read watchpoint, (hardware assisted) */
+  bp_access_watchpoint,                /* access watchpoint, (hardware assisted) */
+  bp_longjmp,                  /* secret breakpoint to find longjmp() */
+  bp_longjmp_resume,           /* secret breakpoint to escape longjmp() */
+
+  /* Used by wait_for_inferior for stepping over subroutine calls, for
+     stepping over signal handlers, and for skipping prologues.  */
+  bp_step_resume,
+
+  /* Used by wait_for_inferior for stepping over signal handlers.  */
+  bp_through_sigtramp,
+
+  /* Used to detect when a watchpoint expression has gone out of
+     scope.  These breakpoints are usually not visible to the user.
+
+     This breakpoint has some interesting properties:
+
+       1) There's always a 1:1 mapping between watchpoints
+       on local variables and watchpoint_scope breakpoints.
+
+       2) It automatically deletes itself and the watchpoint it's
+       associated with when hit.
+
+       3) It can never be disabled.  */
+  bp_watchpoint_scope,
+
+  /* The breakpoint at the end of a call dummy.  */
+  /* FIXME: What if the function we are calling longjmp()s out of the
+     call, or the user gets out with the "return" command?  We currently
+     have no way of cleaning up the breakpoint in these (obscure) situations.
+     (Probably can solve this by noticing longjmp, "return", etc., it's
+     similar to noticing when a watchpoint on a local variable goes out
+     of scope (with hardware support for watchpoints)).  */
+  bp_call_dummy,
+
+  /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
+     code in the inferior to run when significant events occur in the
+     dynamic linker (for example a library is loaded or unloaded).
+
+     By placing a breakpoint in this magic code GDB will get control
+     when these significant events occur.  GDB can then re-examine
+     the dynamic linker's data structures to discover any newly loaded
+     dynamic libraries.  */
+  bp_shlib_event
+};
+
+/* States of enablement of breakpoint. */
+
+enum enable { disabled, enabled, shlib_disabled};
+
+/* Disposition of breakpoint.  Ie: what to do after hitting it. */
+
+enum bpdisp {
+  del,                         /* Delete it */
+  del_at_next_stop,            /* Delete at next stop, whether hit or not */
+  disable,                     /* Disable it */
+  donttouch                    /* Leave it alone */
+};
+
+/* Note that the ->silent field is not currently used by any commands
+   (though the code is in there if it was to be, and set_raw_breakpoint
+   does set it to 0).  I implemented it because I thought it would be
+   useful for a hack I had to put in; I'm going to leave it in because
+   I can see how there might be times when it would indeed be useful */
+
+/* This is for a breakpoint or a watchpoint.  */
+
+struct breakpoint
+{
+  struct breakpoint *next;
+  /* Type of breakpoint. */
+  enum bptype type;
+  /* Zero means disabled; remember the info but don't break here.  */
+  enum enable enable;
+  /* What to do with this breakpoint after we hit it. */
+  enum bpdisp disposition;
+  /* Number assigned to distinguish breakpoints.  */
+  int number;
+
+  /* Address to break at, or NULL if not a breakpoint.  */
+  CORE_ADDR address;
+
+  /* Line number of this address.  Only matters if address is
+     non-NULL.  */
+
+  int line_number;
+
+  /* Source file name of this address.  Only matters if address is
+     non-NULL.  */
+
+  char *source_file;
+
+  /* Non-zero means a silent breakpoint (don't print frame info
+     if we stop here). */
+  unsigned char silent;
+  /* Number of stops at this breakpoint that should
+     be continued automatically before really stopping.  */
+  int ignore_count;
+  /* "Real" contents of byte where breakpoint has been inserted.
+     Valid only when breakpoints are in the program.  Under the complete
+     control of the target insert_breakpoint and remove_breakpoint routines.
+     No other code should assume anything about the value(s) here.  */
+  char shadow_contents[BREAKPOINT_MAX];
+  /* Nonzero if this breakpoint is now inserted.  Only matters if address
+     is non-NULL.  */
+  char inserted;
+  /* Nonzero if this is not the first breakpoint in the list
+     for the given address.  Only matters if address is non-NULL.  */
+  char duplicate;
+  /* Chain of command lines to execute when this breakpoint is hit.  */
+  struct command_line *commands;
+  /* Stack depth (address of frame).  If nonzero, break only if fp
+     equals this.  */
+  CORE_ADDR frame;
+  /* Conditional.  Break only if this expression's value is nonzero.  */
+  struct expression *cond;
+
+  /* String we used to set the breakpoint (malloc'd).  Only matters if
+     address is non-NULL.  */
+  char *addr_string;
+  /* Language we used to set the breakpoint.  */
+  enum language language;
+  /* Input radix we used to set the breakpoint.  */
+  int input_radix;
+  /* String form of the breakpoint condition (malloc'd), or NULL if there
+     is no condition.  */
+  char *cond_string;
+  /* String form of exp (malloc'd), or NULL if none.  */
+  char *exp_string;
+
+  /* The expression we are watching, or NULL if not a watchpoint.  */
+  struct expression *exp;
+  /* The largest block within which it is valid, or NULL if it is
+     valid anywhere (e.g. consists just of global symbols).  */
+  struct block *exp_valid_block;
+  /* Value of the watchpoint the last time we checked it.  */
+  value_ptr val;
+
+  /* Holds the value chain for a hardware watchpoint expression.  */
+  value_ptr val_chain;
+
+  /* Holds the address of the related watchpoint_scope breakpoint
+     when using watchpoints on local variables (might the concept
+     of a related breakpoint be useful elsewhere, if not just call
+     it the watchpoint_scope breakpoint or something like that. FIXME).  */
+  struct breakpoint *related_breakpoint; 
+
+  /* Holds the frame address which identifies the frame this watchpoint
+     should be evaluated in, or NULL if the watchpoint should be evaluated
+     on the outermost frame.  */
+  CORE_ADDR watchpoint_frame;
+
+  /* Thread number for thread-specific breakpoint, or -1 if don't care */
+  int thread;
+
+  /* Count of the number of times this breakpoint was taken, dumped
+     with the info, but not used for anything else.  Useful for
+     seeing how many times you hit a break prior to the program
+     aborting, so you can back up to just before the abort.  */
+  int hit_count;
+
+};
+\f
+/* The following stuff is an abstract data type "bpstat" ("breakpoint status").
    This provides the ability to determine whether we have stopped at a
    breakpoint, and what we should do about it.  */
 
-typedef struct bpstat *bpstat;
+typedef struct bpstats *bpstat;
 
 /* Interface:  */
 /* Clear a bpstat so that it says we are not at any breakpoint.
@@ -44,14 +222,12 @@ extern void bpstat_clear PARAMS ((bpstat *));
    is part of the bpstat is copied as well.  */
 extern bpstat bpstat_copy PARAMS ((bpstat));
 
-/* Get a bpstat associated with having just stopped at address *PC
-   and frame address FRAME_ADDRESS.  Update *PC to point at the
-   breakpoint (if we hit a breakpoint).  */
-/* FIXME:  prototypes uses equivalence between FRAME_ADDR and CORE_ADDR */
-extern bpstat bpstat_stop_status PARAMS ((CORE_ADDR *, CORE_ADDR));
+extern bpstat bpstat_stop_status PARAMS ((CORE_ADDR *, int));
+\f
+/* This bpstat_what stuff tells wait_for_inferior what to do with a
+   breakpoint (a challenging task).  */
 
-/* Return values from bpstat_what.  */
-enum bpstat_what {
+enum bpstat_what_main_action {
   /* Perform various other tests; that is, this bpstat does not
      say to perform any action (e.g. failed watchpoint and nothing
      else).  */
@@ -70,7 +246,9 @@ enum bpstat_what {
   BPSTAT_WHAT_STOP_NOISY,
 
   /* Remove breakpoints, single step once, then put them back in and
-     go back to what we were doing.  */
+     go back to what we were doing.  It's possible that this should be
+     removed from the main_action and put into a separate field, to more
+     cleanly handle BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE.  */
   BPSTAT_WHAT_SINGLE,
 
   /* Set longjmp_resume breakpoint, remove all other breakpoints,
@@ -86,13 +264,34 @@ enum bpstat_what {
   /* Clear longjmp_resume breakpoint, then handle as BPSTAT_WHAT_SINGLE.  */
   BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE,
 
+  /* Clear step resume breakpoint, and keep checking.  */
+  BPSTAT_WHAT_STEP_RESUME,
+
+  /* Clear through_sigtramp breakpoint, muck with trap_expected, and keep
+     checking.  */
+  BPSTAT_WHAT_THROUGH_SIGTRAMP,
+
+  /* Check the dynamic linker's data structures for new libraries, then
+     keep checking.  */
+  BPSTAT_WHAT_CHECK_SHLIBS,
+
   /* This is just used to keep track of how many enums there are.  */
   BPSTAT_WHAT_LAST
 };
 
-/* Tell what to do about this bpstat.  */
-enum bpstat_what bpstat_what PARAMS ((bpstat));
+struct bpstat_what {
+  enum bpstat_what_main_action main_action;
 
+  /* Did we hit a call dummy breakpoint?  This only goes with a main_action
+     of BPSTAT_WHAT_STOP_SILENT or BPSTAT_WHAT_STOP_NOISY (the concept of
+     continuing from a call dummy without popping the frame is not a
+     useful one).  */
+  int call_dummy;
+};
+
+/* Tell what to do about this bpstat.  */
+struct bpstat_what bpstat_what PARAMS ((bpstat));
+\f
 /* Find the bpstat associated with a breakpoint.  NULL otherwise. */
 bpstat bpstat_find_breakpoint PARAMS ((bpstat, struct breakpoint *));
 
@@ -119,14 +318,16 @@ extern int bpstat_print PARAMS ((bpstat));
    Return 0 if passed a bpstat which does not indicate any breakpoints.  */
 extern int bpstat_num PARAMS ((bpstat *));
 
-/* Perform actions associated with having stopped at *BSP.  */
+/* Perform actions associated with having stopped at *BSP.  Actually, we just
+   use this for breakpoint commands.  Perhaps other actions will go here
+   later, but this is executed at a late time (from the command loop).  */
 extern void bpstat_do_actions PARAMS ((bpstat *));
 
 /* Modify BS so that the actions will not be performed.  */
 extern void bpstat_clear_actions PARAMS ((bpstat));
 
 /* Implementation:  */
-struct bpstat
+struct bpstats
 {
   /* Linked list because there can be two breakpoints at the
      same place, and a bpstat reflects the fact that both have been hit.  */
@@ -136,7 +337,7 @@ struct bpstat
   /* Commands left to be done.  */
   struct command_line *commands;
   /* Old value associated with a watchpoint.  */
-  value old_val;
+  value_ptr old_val;
 
   /* Nonzero if this breakpoint tells us to print the frame.  */
   char print;
@@ -150,185 +351,75 @@ struct bpstat
   int (*print_it) PARAMS((bpstat bs));
 };
 \f
-/* Type of breakpoint. */
-/* FIXME In the future, we should fold all other breakpoint-like things into
-   here.  This includes:
+/* Prototypes for breakpoint-related functions.  */
 
-   1) single-step (for machines where we have to simulate single stepping),
-   2) step-resume (for 'next'ing over subroutine calls),
-   3) call-dummy (the breakpoint at the end of a subroutine stub that gdb
-      uses to call functions in the target).
+#ifdef __STDC__                /* Forward declarations for prototypes */
+struct frame_info;
+#endif
 
-   I definately agree with (2) and (3); I'm not as sure about (1)
-   (it is a low-level thing, perhaps the best thing is that it looks
-   as much as possible like a single-step to wait_for_inferior)
-   -kingdon, 8 Apr 93.
-*/
+extern int breakpoint_here_p PARAMS ((CORE_ADDR));
 
-enum bptype {
-  bp_breakpoint,               /* Normal breakpoint */
-  bp_until,                    /* used by until command */
-  bp_finish,                   /* used by finish command */
-  bp_watchpoint,               /* Watchpoint */
-  bp_longjmp,                  /* secret breakpoint to find longjmp() */
-  bp_longjmp_resume            /* secret breakpoint to escape longjmp() */
-};
+extern int frame_in_dummy PARAMS ((struct frame_info *));
 
-/* States of enablement of breakpoint. */
+extern int breakpoint_thread_match PARAMS ((CORE_ADDR, int));
 
-enum enable { disabled, enabled};
+extern void until_break_command PARAMS ((char *, int));
 
-/* Disposition of breakpoint.  Ie: what to do after hitting it. */
+extern void breakpoint_re_set PARAMS ((void));
 
-enum bpdisp {
-  delete,                      /* Delete it */
-  disable,                     /* Disable it */
-  donttouch                    /* Leave it alone */
-};
+extern void clear_momentary_breakpoints PARAMS ((void));
 
-/* Note that the ->silent field is not currently used by any commands
-   (though the code is in there if it was to be, and set_raw_breakpoint
-   does set it to 0).  I implemented it because I thought it would be
-   useful for a hack I had to put in; I'm going to leave it in because
-   I can see how there might be times when it would indeed be useful */
+extern struct breakpoint *set_momentary_breakpoint
+  PARAMS ((struct symtab_and_line, struct frame_info *, enum bptype));
 
-/* This is for a breakpoint or a watchpoint.  */
+extern void set_ignore_count PARAMS ((int, int, int));
 
-struct breakpoint
-{
-  struct breakpoint *next;
-  /* Type of breakpoint. */
-  enum bptype type;
-  /* Zero means disabled; remember the info but don't break here.  */
-  enum enable enable;
-  /* What to do with this breakpoint after we hit it. */
-  enum bpdisp disposition;
-  /* Number assigned to distinguish breakpoints.  */
-  int number;
-  /* Address to break at, or NULL if not a breakpoint.  */
-  CORE_ADDR address;
-  /* Line number of this address.  Redundant.  Only matters if address
-     is non-NULL.  */
-  int line_number;
-  /* Symtab of file of this address.  Redundant.  Only matters if address
-     is non-NULL.  */
-  struct symtab *symtab;
-  /* Non-zero means a silent breakpoint (don't print frame info
-     if we stop here). */
-  unsigned char silent;
-  /* Number of stops at this breakpoint that should
-     be continued automatically before really stopping.  */
-  int ignore_count;
-  /* "Real" contents of byte where breakpoint has been inserted.
-     Valid only when breakpoints are in the program.  Under the complete
-     control of the target insert_breakpoint and remove_breakpoint routines.
-     No other code should assume anything about the value(s) here.  */
-  char shadow_contents[BREAKPOINT_MAX];
-  /* Nonzero if this breakpoint is now inserted.  Only matters if address
-     is non-NULL.  */
-  char inserted;
-  /* Nonzero if this is not the first breakpoint in the list
-     for the given address.  Only matters if address is non-NULL.  */
-  char duplicate;
-  /* Chain of command lines to execute when this breakpoint is hit.  */
-  struct command_line *commands;
-  /* Stack depth (address of frame).  If nonzero, break only if fp
-     equals this.  */
-  FRAME_ADDR frame;
-  /* Conditional.  Break only if this expression's value is nonzero.  */
-  struct expression *cond;
-
-  /* String we used to set the breakpoint (malloc'd).  Only matters if
-     address is non-NULL.  */
-  char *addr_string;
-  /* String form of the breakpoint condition (malloc'd), or NULL if there
-     is no condition.  */
-  char *cond_string;
-  /* String form of exp (malloc'd), or NULL if none.  */
-  char *exp_string;
-
-  /* The expression we are watching, or NULL if not a watchpoint.  */
-  struct expression *exp;
-  /* The largest block within which it is valid, or NULL if it is
-     valid anywhere (e.g. consists just of global symbols).  */
-  struct block *exp_valid_block;
-  /* Value of the watchpoint the last time we checked it.  */
-  value val;
-};
-\f
-/* Prototypes for breakpoint-related functions.  */
-
-#ifdef __STDC__                /* Forward declarations for prototypes */
-struct frame_info;
-#endif
+extern void set_default_breakpoint PARAMS ((int, CORE_ADDR, struct symtab *, int));
 
-extern int
-breakpoint_here_p PARAMS ((CORE_ADDR));
+extern void mark_breakpoints_out PARAMS ((void));
 
-extern void
-until_break_command PARAMS ((char *, int));
+extern void breakpoint_init_inferior PARAMS ((void));
 
-extern void
-breakpoint_re_set PARAMS ((void));
+extern void delete_breakpoint PARAMS ((struct breakpoint *));
 
-extern void
-clear_momentary_breakpoints PARAMS ((void));
+extern void breakpoint_auto_delete PARAMS ((bpstat));
 
-/* FIXME:  Prototype uses equivalence of "struct frame_info *" and FRAME */
-extern struct breakpoint *
-set_momentary_breakpoint PARAMS ((struct symtab_and_line,
-                                 struct frame_info *,
-                                 enum bptype));
+extern void breakpoint_clear_ignore_counts PARAMS ((void));
 
-extern void
-set_ignore_count PARAMS ((int, int, int));
+extern void break_command PARAMS ((char *, int));
 
-extern void
-set_default_breakpoint PARAMS ((int, CORE_ADDR, struct symtab *, int));
+extern int insert_breakpoints PARAMS ((void));
 
-extern void
-mark_breakpoints_out PARAMS ((void));
+extern int remove_breakpoints PARAMS ((void));
 
-extern void
-delete_breakpoint PARAMS ((struct breakpoint *));
+extern void enable_longjmp_breakpoint PARAMS ((void));
 
-extern void
-breakpoint_auto_delete PARAMS ((bpstat));
+extern void disable_longjmp_breakpoint PARAMS ((void));
 
-extern void
-breakpoint_clear_ignore_counts PARAMS ((void));
+extern void set_longjmp_resume_breakpoint PARAMS ((CORE_ADDR,
+                                                  struct frame_info *));
+extern void clear_breakpoint_hit_counts PARAMS ((void));
 
-extern void
-break_command PARAMS ((char *, int));
+/* The following are for displays, which aren't really breakpoints, but
+   here is as good a place as any for them.  */
 
-extern int
-insert_breakpoints PARAMS ((void));
+extern void disable_current_display PARAMS ((void));
 
-extern int
-remove_breakpoints PARAMS ((void));
+extern void do_displays PARAMS ((void));
 
-extern void
-enable_longjmp_breakpoint PARAMS ((void));
+extern void disable_display PARAMS ((int));
 
-extern void
-disable_longjmp_breakpoint PARAMS ((void));
+extern void clear_displays PARAMS ((void));
 
-extern void
-set_longjmp_resume_breakpoint PARAMS ((CORE_ADDR, FRAME));
-/* The following are for displays, which aren't really breakpoints, but
-   here is as good a place as any for them.  */
+extern void disable_breakpoint PARAMS ((struct breakpoint *));
 
-extern void
-disable_current_display PARAMS ((void));
+extern void enable_breakpoint PARAMS ((struct breakpoint *));
 
-extern void
-do_displays PARAMS ((void));
+extern void create_solib_event_breakpoint PARAMS ((CORE_ADDR));
 
-extern void
-disable_display PARAMS ((int));
+extern void remove_solib_event_breakpoints PARAMS ((void));
 
-extern void
-clear_displays PARAMS ((void));
+extern void re_enable_breakpoints_in_shlibs PARAMS ((void));
 
 #endif /* !defined (BREAKPOINT_H) */
This page took 0.028166 seconds and 4 git commands to generate.