Subversion Repositories openrisc

/* Data structures associated with breakpoints in GDB.

/* Data structures associated with breakpoints in GDB.

   Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,

   Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,

   2002, 2003, 2004, 2007, 2008 Free Software Foundation, Inc.

   2002, 2003, 2004, 2007, 2008 Free Software Foundation, Inc.

   This file is part of GDB.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify

   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

   it under the terms of the GNU General Public License as published by

   the Free Software Foundation; either version 3 of the License, or

   the Free Software Foundation; either version 3 of the License, or

   (at your option) any later version.

   (at your option) any later version.

   This program is distributed in the hope that it will be useful,

   This program is distributed in the hope that it will be useful,

   but WITHOUT ANY WARRANTY; without even the implied warranty of

   but WITHOUT ANY WARRANTY; without even the implied warranty of

   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

   GNU General Public License for more details.

   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License

   You should have received a copy of the GNU General Public License

   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

#if !defined (BREAKPOINT_H)

#if !defined (BREAKPOINT_H)

#define BREAKPOINT_H 1

#define BREAKPOINT_H 1

#include "frame.h"

#include "frame.h"

#include "value.h"

#include "value.h"

#include "vec.h"

#include "vec.h"

#include "gdb-events.h"

#include "gdb-events.h"

struct value;

struct value;

struct block;

struct block;

/* This is the maximum number of bytes a breakpoint instruction can take.

/* This is the maximum number of bytes a breakpoint instruction can take.

   Feel free to increase it.  It's just used in a few places to size

   Feel free to increase it.  It's just used in a few places to size

   arrays that should be independent of the target architecture.  */

   arrays that should be independent of the target architecture.  */

#define BREAKPOINT_MAX  16

#define BREAKPOINT_MAX  16

/* Type of breakpoint. */

/* Type of breakpoint. */

/* FIXME In the future, we should fold all other breakpoint-like things into

/* FIXME In the future, we should fold all other breakpoint-like things into

   here.  This includes:

   here.  This includes:

   * single-step (for machines where we have to simulate single stepping)

   * single-step (for machines where we have to simulate single stepping)

   (probably, though perhaps it is better for it to look as much as

   (probably, though perhaps it is better for it to look as much as

   possible like a single-step to wait_for_inferior).  */

   possible like a single-step to wait_for_inferior).  */

enum bptype

enum bptype

  {

  {

    bp_none = 0,         /* Eventpoint has been deleted. */

    bp_none = 0,         /* Eventpoint has been deleted. */

    bp_breakpoint,              /* Normal breakpoint */

    bp_breakpoint,              /* Normal breakpoint */

    bp_hardware_breakpoint,     /* Hardware assisted breakpoint */

    bp_hardware_breakpoint,     /* Hardware assisted breakpoint */

    bp_until,                   /* used by until command */

    bp_until,                   /* used by until command */

    bp_finish,                  /* used by finish command */

    bp_finish,                  /* used by finish command */

    bp_watchpoint,              /* Watchpoint */

    bp_watchpoint,              /* Watchpoint */

    bp_hardware_watchpoint,     /* Hardware assisted watchpoint */

    bp_hardware_watchpoint,     /* Hardware assisted watchpoint */

    bp_read_watchpoint,         /* read watchpoint, (hardware assisted) */

    bp_read_watchpoint,         /* read watchpoint, (hardware assisted) */

    bp_access_watchpoint,       /* access watchpoint, (hardware assisted) */

    bp_access_watchpoint,       /* access watchpoint, (hardware assisted) */

    bp_longjmp,                 /* secret breakpoint to find longjmp() */

    bp_longjmp,                 /* secret breakpoint to find longjmp() */

    bp_longjmp_resume,          /* secret breakpoint to escape longjmp() */

    bp_longjmp_resume,          /* secret breakpoint to escape longjmp() */

    /* Used by wait_for_inferior for stepping over subroutine calls, for

    /* Used by wait_for_inferior for stepping over subroutine calls, for

       stepping over signal handlers, and for skipping prologues.  */

       stepping over signal handlers, and for skipping prologues.  */

    bp_step_resume,

    bp_step_resume,

    /* Used to detect when a watchpoint expression has gone out of

    /* Used to detect when a watchpoint expression has gone out of

       scope.  These breakpoints are usually not visible to the user.

       scope.  These breakpoints are usually not visible to the user.

       This breakpoint has some interesting properties:

       This breakpoint has some interesting properties:

       1) There's always a 1:1 mapping between watchpoints

       1) There's always a 1:1 mapping between watchpoints

       on local variables and watchpoint_scope breakpoints.

       on local variables and watchpoint_scope breakpoints.

       2) It automatically deletes itself and the watchpoint it's

       2) It automatically deletes itself and the watchpoint it's

       associated with when hit.

       associated with when hit.

       3) It can never be disabled.  */

       3) It can never be disabled.  */

    bp_watchpoint_scope,

    bp_watchpoint_scope,

    /* The breakpoint at the end of a call dummy.  */

    /* The breakpoint at the end of a call dummy.  */

    /* FIXME: What if the function we are calling longjmp()s out of the

    /* 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

       call, or the user gets out with the "return" command?  We currently

       have no way of cleaning up the breakpoint in these (obscure) situations.

       have no way of cleaning up the breakpoint in these (obscure) situations.

       (Probably can solve this by noticing longjmp, "return", etc., it's

       (Probably can solve this by noticing longjmp, "return", etc., it's

       similar to noticing when a watchpoint on a local variable goes out

       similar to noticing when a watchpoint on a local variable goes out

       of scope (with hardware support for watchpoints)).  */

       of scope (with hardware support for watchpoints)).  */

    bp_call_dummy,

    bp_call_dummy,

    /* Some dynamic linkers (HP, maybe Solaris) can arrange for special

    /* Some dynamic linkers (HP, maybe Solaris) can arrange for special

       code in the inferior to run when significant events occur in the

       code in the inferior to run when significant events occur in the

       dynamic linker (for example a library is loaded or unloaded).

       dynamic linker (for example a library is loaded or unloaded).

       By placing a breakpoint in this magic code GDB will get control

       By placing a breakpoint in this magic code GDB will get control

       when these significant events occur.  GDB can then re-examine

       when these significant events occur.  GDB can then re-examine

       the dynamic linker's data structures to discover any newly loaded

       the dynamic linker's data structures to discover any newly loaded

       dynamic libraries.  */

       dynamic libraries.  */

    bp_shlib_event,

    bp_shlib_event,

    /* Some multi-threaded systems can arrange for a location in the

    /* Some multi-threaded systems can arrange for a location in the

       inferior to be executed when certain thread-related events occur

       inferior to be executed when certain thread-related events occur

       (such as thread creation or thread death).

       (such as thread creation or thread death).

       By placing a breakpoint at one of these locations, GDB will get

       By placing a breakpoint at one of these locations, GDB will get

       control when these events occur.  GDB can then update its thread

       control when these events occur.  GDB can then update its thread

       lists etc.  */

       lists etc.  */

    bp_thread_event,

    bp_thread_event,

    /* On the same principal, an overlay manager can arrange to call a

    /* On the same principal, an overlay manager can arrange to call a

       magic location in the inferior whenever there is an interesting

       magic location in the inferior whenever there is an interesting

       change in overlay status.  GDB can update its overlay tables

       change in overlay status.  GDB can update its overlay tables

       and fiddle with breakpoints in overlays when this breakpoint

       and fiddle with breakpoints in overlays when this breakpoint

       is hit.  */

       is hit.  */

    bp_overlay_event,

    bp_overlay_event,

    /* These breakpoints are used to implement the "catch load" command

    /* These breakpoints are used to implement the "catch load" command

       on platforms whose dynamic linkers support such functionality.  */

       on platforms whose dynamic linkers support such functionality.  */

    bp_catch_load,

    bp_catch_load,

    /* These breakpoints are used to implement the "catch unload" command

    /* These breakpoints are used to implement the "catch unload" command

       on platforms whose dynamic linkers support such functionality.  */

       on platforms whose dynamic linkers support such functionality.  */

    bp_catch_unload,

    bp_catch_unload,

    /* These are not really breakpoints, but are catchpoints that

    /* These are not really breakpoints, but are catchpoints that

       implement the "catch fork", "catch vfork" and "catch exec" commands

       implement the "catch fork", "catch vfork" and "catch exec" commands

       on platforms whose kernel support such functionality.  (I.e.,

       on platforms whose kernel support such functionality.  (I.e.,

       kernels which can raise an event when a fork or exec occurs, as

       kernels which can raise an event when a fork or exec occurs, as

       opposed to the debugger setting breakpoints on functions named

       opposed to the debugger setting breakpoints on functions named

       "fork" or "exec".) */

       "fork" or "exec".) */

    bp_catch_fork,

    bp_catch_fork,

    bp_catch_vfork,

    bp_catch_vfork,

    bp_catch_exec,

    bp_catch_exec,

  };

  };

/* States of enablement of breakpoint. */

/* States of enablement of breakpoint. */

enum enable_state

enum enable_state

  {

  {

    bp_disabled,        /* The eventpoint is inactive, and cannot trigger. */

    bp_disabled,        /* The eventpoint is inactive, and cannot trigger. */

    bp_enabled,         /* The eventpoint is active, and can trigger. */

    bp_enabled,         /* The eventpoint is active, and can trigger. */

    bp_call_disabled,   /* The eventpoint has been disabled while a call

    bp_call_disabled,   /* The eventpoint has been disabled while a call

                           into the inferior is "in flight", because some

                           into the inferior is "in flight", because some

                           eventpoints interfere with the implementation of

                           eventpoints interfere with the implementation of

                           a call on some targets.  The eventpoint will be

                           a call on some targets.  The eventpoint will be

                           automatically enabled and reset when the call

                           automatically enabled and reset when the call

                           "lands" (either completes, or stops at another

                           "lands" (either completes, or stops at another

                           eventpoint). */

                           eventpoint). */

    bp_permanent        /* There is a breakpoint instruction hard-wired into

    bp_permanent        /* There is a breakpoint instruction hard-wired into

                           the target's code.  Don't try to write another

                           the target's code.  Don't try to write another

                           breakpoint instruction on top of it, or restore

                           breakpoint instruction on top of it, or restore

                           its value.  Step over it using the architecture's

                           its value.  Step over it using the architecture's

                           SKIP_INSN macro.  */

                           SKIP_INSN macro.  */

  };

  };

/* Disposition of breakpoint.  Ie: what to do after hitting it. */

/* Disposition of breakpoint.  Ie: what to do after hitting it. */

enum bpdisp

enum bpdisp

  {

  {

    disp_del,                   /* Delete it */

    disp_del,                   /* Delete it */

    disp_del_at_next_stop,      /* Delete at next stop, whether hit or not */

    disp_del_at_next_stop,      /* Delete at next stop, whether hit or not */

    disp_disable,               /* Disable it */

    disp_disable,               /* Disable it */

    disp_donttouch              /* Leave it alone */

    disp_donttouch              /* Leave it alone */

  };

  };

enum target_hw_bp_type

enum target_hw_bp_type

  {

  {

    hw_write   = 0,              /* Common  HW watchpoint */

    hw_write   = 0,              /* Common  HW watchpoint */

    hw_read    = 1,             /* Read    HW watchpoint */

    hw_read    = 1,             /* Read    HW watchpoint */

    hw_access  = 2,             /* Access  HW watchpoint */

    hw_access  = 2,             /* Access  HW watchpoint */

    hw_execute = 3              /* Execute HW breakpoint */

    hw_execute = 3              /* Execute HW breakpoint */

  };

  };

/* Information used by targets to insert and remove breakpoints.  */

/* Information used by targets to insert and remove breakpoints.  */

struct bp_target_info

struct bp_target_info

{

{

  /* Address at which the breakpoint was placed.  This is normally the

  /* Address at which the breakpoint was placed.  This is normally the

     same as ADDRESS from the bp_location, except when adjustment

     same as ADDRESS from the bp_location, except when adjustment

     happens in gdbarch_breakpoint_from_pc.  The most common form of

     happens in gdbarch_breakpoint_from_pc.  The most common form of

     adjustment is stripping an alternate ISA marker from the PC which

     adjustment is stripping an alternate ISA marker from the PC which

     is used to determine the type of breakpoint to insert.  */

     is used to determine the type of breakpoint to insert.  */

  CORE_ADDR placed_address;

  CORE_ADDR placed_address;

  /* If the breakpoint lives in memory and reading that memory would

  /* If the breakpoint lives in memory and reading that memory would

     give back the breakpoint, instead of the original contents, then

     give back the breakpoint, instead of the original contents, then

     the original contents are cached here.  Only SHADOW_LEN bytes of

     the original contents are cached here.  Only SHADOW_LEN bytes of

     this buffer are valid, and only when the breakpoint is inserted.  */

     this buffer are valid, and only when the breakpoint is inserted.  */

  gdb_byte shadow_contents[BREAKPOINT_MAX];

  gdb_byte shadow_contents[BREAKPOINT_MAX];

  /* The length of the data cached in SHADOW_CONTENTS.  */

  /* The length of the data cached in SHADOW_CONTENTS.  */

  int shadow_len;

  int shadow_len;

  /* The size of the placed breakpoint, according to

  /* The size of the placed breakpoint, according to

     gdbarch_breakpoint_from_pc, when the breakpoint was inserted.  This is

     gdbarch_breakpoint_from_pc, when the breakpoint was inserted.  This is

     generally the same as SHADOW_LEN, unless we did not need

     generally the same as SHADOW_LEN, unless we did not need

     to read from the target to implement the memory breakpoint

     to read from the target to implement the memory breakpoint

     (e.g. if a remote stub handled the details).  We may still

     (e.g. if a remote stub handled the details).  We may still

     need the size to remove the breakpoint safely.  */

     need the size to remove the breakpoint safely.  */

  int placed_size;

  int placed_size;

};

};

/* GDB maintains two types of information about each breakpoint (or

/* GDB maintains two types of information about each breakpoint (or

   watchpoint, or other related event).  The first type corresponds

   watchpoint, or other related event).  The first type corresponds

   to struct breakpoint; this is a relatively high-level structure

   to struct breakpoint; this is a relatively high-level structure

   which contains the source location(s), stopping conditions, user

   which contains the source location(s), stopping conditions, user

   commands to execute when the breakpoint is hit, and so forth.

   commands to execute when the breakpoint is hit, and so forth.

   The second type of information corresponds to struct bp_location.

   The second type of information corresponds to struct bp_location.

   Each breakpoint has one or (eventually) more locations associated

   Each breakpoint has one or (eventually) more locations associated

   with it, which represent target-specific and machine-specific

   with it, which represent target-specific and machine-specific

   mechanisms for stopping the program.  For instance, a watchpoint

   mechanisms for stopping the program.  For instance, a watchpoint

   expression may require multiple hardware watchpoints in order to

   expression may require multiple hardware watchpoints in order to

   catch all changes in the value of the expression being watched.  */

   catch all changes in the value of the expression being watched.  */

enum bp_loc_type

enum bp_loc_type

{

{

  bp_loc_software_breakpoint,

  bp_loc_software_breakpoint,

  bp_loc_hardware_breakpoint,

  bp_loc_hardware_breakpoint,

  bp_loc_hardware_watchpoint,

  bp_loc_hardware_watchpoint,

  bp_loc_other                  /* Miscellaneous...  */

  bp_loc_other                  /* Miscellaneous...  */

};

};

struct bp_location

struct bp_location

{

{

  /* Chain pointer to the next breakpoint location for

  /* Chain pointer to the next breakpoint location for

     the same parent breakpoint.  */

     the same parent breakpoint.  */

  struct bp_location *next;

  struct bp_location *next;

  /* Pointer to the next breakpoint location, in a global

  /* Pointer to the next breakpoint location, in a global

     list of all breakpoint locations.  */

     list of all breakpoint locations.  */

  struct bp_location *global_next;

  struct bp_location *global_next;

  /* Type of this breakpoint location.  */

  /* Type of this breakpoint location.  */

  enum bp_loc_type loc_type;

  enum bp_loc_type loc_type;

  /* Each breakpoint location must belong to exactly one higher-level

  /* Each breakpoint location must belong to exactly one higher-level

     breakpoint.  This and the DUPLICATE flag are more straightforward

     breakpoint.  This and the DUPLICATE flag are more straightforward

     than reference counting.  */

     than reference counting.  */

  struct breakpoint *owner;

  struct breakpoint *owner;

  /* Conditional.  Break only if this expression's value is nonzero.

  /* Conditional.  Break only if this expression's value is nonzero.

     Unlike string form of condition, which is associated with breakpoint,

     Unlike string form of condition, which is associated with breakpoint,

     this is associated with location, since if breakpoint has several

     this is associated with location, since if breakpoint has several

     locations,  the evaluation of expression can be different for

     locations,  the evaluation of expression can be different for

     different locations.  */

     different locations.  */

  struct expression *cond;

  struct expression *cond;

  /* This location's address is in an unloaded solib, and so this

  /* This location's address is in an unloaded solib, and so this

     location should not be inserted.  It will be automatically

     location should not be inserted.  It will be automatically

     enabled when that solib is loaded.  */

     enabled when that solib is loaded.  */

  char shlib_disabled;

  char shlib_disabled;

  /* Is this particular location enabled.  */

  /* Is this particular location enabled.  */

  char enabled;

  char enabled;

  /* Nonzero if this breakpoint is now inserted.  */

  /* Nonzero if this breakpoint is now inserted.  */

  char inserted;

  char inserted;

  /* Nonzero if this is not the first breakpoint in the list

  /* Nonzero if this is not the first breakpoint in the list

     for the given address.  */

     for the given address.  */

  char duplicate;

  char duplicate;

  /* If we someday support real thread-specific breakpoints, then

  /* If we someday support real thread-specific breakpoints, then

     the breakpoint location will need a thread identifier.  */

     the breakpoint location will need a thread identifier.  */

  /* Data for specific breakpoint types.  These could be a union, but

  /* Data for specific breakpoint types.  These could be a union, but

     simplicity is more important than memory usage for breakpoints.  */

     simplicity is more important than memory usage for breakpoints.  */

  /* Note that zero is a perfectly valid code address on some platforms

  /* Note that zero is a perfectly valid code address on some platforms

     (for example, the mn10200 (OBSOLETE) and mn10300 simulators).  NULL

     (for example, the mn10200 (OBSOLETE) and mn10300 simulators).  NULL

     is not a special value for this field.  Valid for all types except

     is not a special value for this field.  Valid for all types except

     bp_loc_other.  */

     bp_loc_other.  */

  CORE_ADDR address;

  CORE_ADDR address;

  /* For hardware watchpoints, the size of data ad ADDRESS being watches.  */

  /* For hardware watchpoints, the size of data ad ADDRESS being watches.  */

  int length;

  int length;

  /* Type of hardware watchpoint. */

  /* Type of hardware watchpoint. */

  enum target_hw_bp_type watchpoint_type;

  enum target_hw_bp_type watchpoint_type;

  /* For any breakpoint type with an address, this is the BFD section

  /* For any breakpoint type with an address, this is the BFD section

     associated with the address.  Used primarily for overlay debugging.  */

     associated with the address.  Used primarily for overlay debugging.  */

  asection *section;

  asection *section;

  /* Address at which breakpoint was requested, either by the user or

  /* Address at which breakpoint was requested, either by the user or

     by GDB for internal breakpoints.  This will usually be the same

     by GDB for internal breakpoints.  This will usually be the same

     as ``address'' (above) except for cases in which

     as ``address'' (above) except for cases in which

     ADJUST_BREAKPOINT_ADDRESS has computed a different address at

     ADJUST_BREAKPOINT_ADDRESS has computed a different address at

     which to place the breakpoint in order to comply with a

     which to place the breakpoint in order to comply with a

     processor's architectual constraints.  */

     processor's architectual constraints.  */

  CORE_ADDR requested_address;

  CORE_ADDR requested_address;

  char *function_name;

  char *function_name;

  /* Details of the placed breakpoint, when inserted.  */

  /* Details of the placed breakpoint, when inserted.  */

  struct bp_target_info target_info;

  struct bp_target_info target_info;

  /* Similarly, for the breakpoint at an overlay's LMA, if necessary.  */

  /* Similarly, for the breakpoint at an overlay's LMA, if necessary.  */

  struct bp_target_info overlay_target_info;

  struct bp_target_info overlay_target_info;

};

};

/* This structure is a collection of function pointers that, if available,

/* This structure is a collection of function pointers that, if available,

   will be called instead of the performing the default action for this

   will be called instead of the performing the default action for this

   bptype.  */

   bptype.  */

struct breakpoint_ops

struct breakpoint_ops

{

{

  /* The normal print routine for this breakpoint, called when we

  /* The normal print routine for this breakpoint, called when we

     hit it.  */

     hit it.  */

  enum print_stop_action (*print_it) (struct breakpoint *);

  enum print_stop_action (*print_it) (struct breakpoint *);

  /* Display information about this breakpoint, for "info breakpoints".  */

  /* Display information about this breakpoint, for "info breakpoints".  */

  void (*print_one) (struct breakpoint *, CORE_ADDR *);

  void (*print_one) (struct breakpoint *, CORE_ADDR *);

  /* Display information about this breakpoint after setting it (roughly

  /* Display information about this breakpoint after setting it (roughly

     speaking; this is called from "mention").  */

     speaking; this is called from "mention").  */

  void (*print_mention) (struct breakpoint *);

  void (*print_mention) (struct breakpoint *);

};

};

enum watchpoint_triggered

enum watchpoint_triggered

{

{

  /* This watchpoint definitely did not trigger.  */

  /* This watchpoint definitely did not trigger.  */

  watch_triggered_no = 0,

  watch_triggered_no = 0,

  /* Some hardware watchpoint triggered, and it might have been this

  /* Some hardware watchpoint triggered, and it might have been this

     one, but we do not know which it was.  */

     one, but we do not know which it was.  */

  watch_triggered_unknown,

  watch_triggered_unknown,

  /* This hardware watchpoint definitely did trigger.  */

  /* This hardware watchpoint definitely did trigger.  */

  watch_triggered_yes

  watch_triggered_yes

};

};

/* Note that the ->silent field is not currently used by any commands

/* 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

   (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

   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

   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 */

   I can see how there might be times when it would indeed be useful */

/* This is for a breakpoint or a watchpoint.  */

/* This is for a breakpoint or a watchpoint.  */

struct breakpoint

struct breakpoint

  {

  {

    struct breakpoint *next;

    struct breakpoint *next;

    /* Type of breakpoint. */

    /* Type of breakpoint. */

    enum bptype type;

    enum bptype type;

    /* Zero means disabled; remember the info but don't break here.  */

    /* Zero means disabled; remember the info but don't break here.  */

    enum enable_state enable_state;

    enum enable_state enable_state;

    /* What to do with this breakpoint after we hit it. */

    /* What to do with this breakpoint after we hit it. */

    enum bpdisp disposition;

    enum bpdisp disposition;

    /* Number assigned to distinguish breakpoints.  */

    /* Number assigned to distinguish breakpoints.  */

    int number;

    int number;

    /* Location(s) associated with this high-level breakpoint.  */

    /* Location(s) associated with this high-level breakpoint.  */

    struct bp_location *loc;

    struct bp_location *loc;

    /* Line number of this address.  */

    /* Line number of this address.  */

    int line_number;

    int line_number;

    /* Source file name of this address.  */

    /* Source file name of this address.  */

    char *source_file;

    char *source_file;

    /* Non-zero means a silent breakpoint (don't print frame info

    /* Non-zero means a silent breakpoint (don't print frame info

       if we stop here). */

       if we stop here). */

    unsigned char silent;

    unsigned char silent;

    /* Number of stops at this breakpoint that should

    /* Number of stops at this breakpoint that should

       be continued automatically before really stopping.  */

       be continued automatically before really stopping.  */

    int ignore_count;

    int ignore_count;

    /* Chain of command lines to execute when this breakpoint is hit.  */

    /* Chain of command lines to execute when this breakpoint is hit.  */

    struct command_line *commands;

    struct command_line *commands;

    /* Stack depth (address of frame).  If nonzero, break only if fp

    /* Stack depth (address of frame).  If nonzero, break only if fp

       equals this.  */

       equals this.  */

    struct frame_id frame_id;

    struct frame_id frame_id;

    /* String we used to set the breakpoint (malloc'd).  */

    /* String we used to set the breakpoint (malloc'd).  */

    char *addr_string;

    char *addr_string;

    /* Language we used to set the breakpoint.  */

    /* Language we used to set the breakpoint.  */

    enum language language;

    enum language language;

    /* Input radix we used to set the breakpoint.  */

    /* Input radix we used to set the breakpoint.  */

    int input_radix;

    int input_radix;

    /* String form of the breakpoint condition (malloc'd), or NULL if there

    /* String form of the breakpoint condition (malloc'd), or NULL if there

       is no condition.  */

       is no condition.  */

    char *cond_string;

    char *cond_string;

    /* String form of exp (malloc'd), or NULL if none.  */

    /* String form of exp (malloc'd), or NULL if none.  */

    char *exp_string;

    char *exp_string;

    /* The expression we are watching, or NULL if not a watchpoint.  */

    /* The expression we are watching, or NULL if not a watchpoint.  */

    struct expression *exp;

    struct expression *exp;

    /* The largest block within which it is valid, or NULL if it is

    /* The largest block within which it is valid, or NULL if it is

       valid anywhere (e.g. consists just of global symbols).  */

       valid anywhere (e.g. consists just of global symbols).  */

    struct block *exp_valid_block;

    struct block *exp_valid_block;

    /* Value of the watchpoint the last time we checked it.  */

    /* Value of the watchpoint the last time we checked it.  */

    struct value *val;

    struct value *val;

    /* Holds the address of the related watchpoint_scope breakpoint

    /* Holds the address of the related watchpoint_scope breakpoint

       when using watchpoints on local variables (might the concept

       when using watchpoints on local variables (might the concept

       of a related breakpoint be useful elsewhere, if not just call

       of a related breakpoint be useful elsewhere, if not just call

       it the watchpoint_scope breakpoint or something like that. FIXME).  */

       it the watchpoint_scope breakpoint or something like that. FIXME).  */

    struct breakpoint *related_breakpoint;

    struct breakpoint *related_breakpoint;

    /* Holds the frame address which identifies the frame this

    /* Holds the frame address which identifies the frame this

       watchpoint should be evaluated in, or `null' if the watchpoint

       watchpoint should be evaluated in, or `null' if the watchpoint

       should be evaluated on the outermost frame.  */

       should be evaluated on the outermost frame.  */

    struct frame_id watchpoint_frame;

    struct frame_id watchpoint_frame;

    /* For hardware watchpoints, the triggered status according to the

    /* For hardware watchpoints, the triggered status according to the

       hardware.  */

       hardware.  */

    enum watchpoint_triggered watchpoint_triggered;

    enum watchpoint_triggered watchpoint_triggered;

    /* Thread number for thread-specific breakpoint, or -1 if don't care */

    /* Thread number for thread-specific breakpoint, or -1 if don't care */

    int thread;

    int thread;

    /* Count of the number of times this breakpoint was taken, dumped

    /* Count of the number of times this breakpoint was taken, dumped

       with the info, but not used for anything else.  Useful for

       with the info, but not used for anything else.  Useful for

       seeing how many times you hit a break prior to the program

       seeing how many times you hit a break prior to the program

       aborting, so you can back up to just before the abort.  */

       aborting, so you can back up to just before the abort.  */

    int hit_count;

    int hit_count;

    /* Filename of a dynamically-linked library (dll), used for

    /* Filename of a dynamically-linked library (dll), used for

       bp_catch_load and bp_catch_unload (malloc'd), or NULL if any

       bp_catch_load and bp_catch_unload (malloc'd), or NULL if any

       library is significant.  */

       library is significant.  */

    char *dll_pathname;

    char *dll_pathname;

    /* Filename of a dll whose state change (e.g., load or unload)

    /* Filename of a dll whose state change (e.g., load or unload)

       triggered this catchpoint.  This field is only valid immediately

       triggered this catchpoint.  This field is only valid immediately

       after this catchpoint has triggered.  */

       after this catchpoint has triggered.  */

    char *triggered_dll_pathname;

    char *triggered_dll_pathname;

    /* Process id of a child process whose forking triggered this

    /* Process id of a child process whose forking triggered this

       catchpoint.  This field is only valid immediately after this

       catchpoint.  This field is only valid immediately after this

       catchpoint has triggered.  */

       catchpoint has triggered.  */

    int forked_inferior_pid;

    int forked_inferior_pid;

    /* Filename of a program whose exec triggered this catchpoint.

    /* Filename of a program whose exec triggered this catchpoint.

       This field is only valid immediately after this catchpoint has

       This field is only valid immediately after this catchpoint has

       triggered.  */

       triggered.  */

    char *exec_pathname;

    char *exec_pathname;

    /* Methods associated with this breakpoint.  */

    /* Methods associated with this breakpoint.  */

    struct breakpoint_ops *ops;

    struct breakpoint_ops *ops;

    /* Is breakpoint's condition not yet parsed because we found

    /* Is breakpoint's condition not yet parsed because we found

       no location initially so had no context to parse

       no location initially so had no context to parse

       the condition in.  */

       the condition in.  */

    int condition_not_parsed;

    int condition_not_parsed;

  };

  };

typedef struct breakpoint *breakpoint_p;

typedef struct breakpoint *breakpoint_p;

DEF_VEC_P(breakpoint_p);

DEF_VEC_P(breakpoint_p);

/* The following stuff is an abstract data type "bpstat" ("breakpoint

/* The following stuff is an abstract data type "bpstat" ("breakpoint

   status").  This provides the ability to determine whether we have

   status").  This provides the ability to determine whether we have

   stopped at a breakpoint, and what we should do about it.  */

   stopped at a breakpoint, and what we should do about it.  */

typedef struct bpstats *bpstat;

typedef struct bpstats *bpstat;

/* Frees any storage that is part of a bpstat.

/* Frees any storage that is part of a bpstat.

   Does not walk the 'next' chain.  */

   Does not walk the 'next' chain.  */

extern void bpstat_free (bpstat);

extern void bpstat_free (bpstat);

/* Clears a chain of bpstat, freeing storage

/* Clears a chain of bpstat, freeing storage

   of each.  */

   of each.  */

extern void bpstat_clear (bpstat *);

extern void bpstat_clear (bpstat *);

/* Return a copy of a bpstat.  Like "bs1 = bs2" but all storage that

/* Return a copy of a bpstat.  Like "bs1 = bs2" but all storage that

   is part of the bpstat is copied as well.  */

   is part of the bpstat is copied as well.  */

extern bpstat bpstat_copy (bpstat);

extern bpstat bpstat_copy (bpstat);

extern bpstat bpstat_stop_status (CORE_ADDR pc, ptid_t ptid);

extern bpstat bpstat_stop_status (CORE_ADDR pc, ptid_t ptid);

/* This bpstat_what stuff tells wait_for_inferior what to do with a

/* This bpstat_what stuff tells wait_for_inferior what to do with a

   breakpoint (a challenging task).  */

   breakpoint (a challenging task).  */

enum bpstat_what_main_action

enum bpstat_what_main_action

  {

  {

    /* Perform various other tests; that is, this bpstat does not

    /* Perform various other tests; that is, this bpstat does not

       say to perform any action (e.g. failed watchpoint and nothing

       say to perform any action (e.g. failed watchpoint and nothing

       else).  */

       else).  */

    BPSTAT_WHAT_KEEP_CHECKING,

    BPSTAT_WHAT_KEEP_CHECKING,

    /* Rather than distinguish between noisy and silent stops here, it

    /* Rather than distinguish between noisy and silent stops here, it

       might be cleaner to have bpstat_print make that decision (also

       might be cleaner to have bpstat_print make that decision (also

       taking into account stop_print_frame and source_only).  But the

       taking into account stop_print_frame and source_only).  But the

       implications are a bit scary (interaction with auto-displays, etc.),

       implications are a bit scary (interaction with auto-displays, etc.),

       so I won't try it.  */

       so I won't try it.  */

    /* Stop silently.  */

    /* Stop silently.  */

    BPSTAT_WHAT_STOP_SILENT,

    BPSTAT_WHAT_STOP_SILENT,

    /* Stop and print.  */

    /* Stop and print.  */

    BPSTAT_WHAT_STOP_NOISY,

    BPSTAT_WHAT_STOP_NOISY,

    /* Remove breakpoints, single step once, then put them back in and

    /* Remove breakpoints, single step once, then put them back in and

       go back to what we were doing.  It's possible that this should be

       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

       removed from the main_action and put into a separate field, to more

       cleanly handle BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE.  */

       cleanly handle BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE.  */

    BPSTAT_WHAT_SINGLE,

    BPSTAT_WHAT_SINGLE,

    /* Set longjmp_resume breakpoint, remove all other breakpoints,

    /* Set longjmp_resume breakpoint, remove all other breakpoints,

       and continue.  The "remove all other breakpoints" part is required

       and continue.  The "remove all other breakpoints" part is required

       if we are also stepping over another breakpoint as well as doing

       if we are also stepping over another breakpoint as well as doing

       the longjmp handling.  */

       the longjmp handling.  */

    BPSTAT_WHAT_SET_LONGJMP_RESUME,

    BPSTAT_WHAT_SET_LONGJMP_RESUME,

    /* Clear longjmp_resume breakpoint, then handle as

    /* Clear longjmp_resume breakpoint, then handle as

       BPSTAT_WHAT_KEEP_CHECKING.  */

       BPSTAT_WHAT_KEEP_CHECKING.  */

    BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,

    BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,

    /* Clear longjmp_resume breakpoint, then handle as BPSTAT_WHAT_SINGLE.  */

    /* Clear longjmp_resume breakpoint, then handle as BPSTAT_WHAT_SINGLE.  */

    BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE,

    BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE,

    /* Clear step resume breakpoint, and keep checking.  */

    /* Clear step resume breakpoint, and keep checking.  */

    BPSTAT_WHAT_STEP_RESUME,

    BPSTAT_WHAT_STEP_RESUME,

    /* Check the dynamic linker's data structures for new libraries, then

    /* Check the dynamic linker's data structures for new libraries, then

       keep checking.  */

       keep checking.  */

    BPSTAT_WHAT_CHECK_SHLIBS,

    BPSTAT_WHAT_CHECK_SHLIBS,

    /* Check the dynamic linker's data structures for new libraries, then

    /* Check the dynamic linker's data structures for new libraries, then

       resume out of the dynamic linker's callback, stop and print.  */

       resume out of the dynamic linker's callback, stop and print.  */

    BPSTAT_WHAT_CHECK_SHLIBS_RESUME_FROM_HOOK,

    BPSTAT_WHAT_CHECK_SHLIBS_RESUME_FROM_HOOK,

    /* This is just used to keep track of how many enums there are.  */

    /* This is just used to keep track of how many enums there are.  */

    BPSTAT_WHAT_LAST

    BPSTAT_WHAT_LAST

  };

  };

struct bpstat_what

struct bpstat_what

  {

  {

    enum bpstat_what_main_action main_action;

    enum bpstat_what_main_action main_action;

    /* Did we hit a call dummy breakpoint?  This only goes with a 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

       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

       continuing from a call dummy without popping the frame is not a

       useful one).  */

       useful one).  */

    int call_dummy;

    int call_dummy;

  };

  };

/* The possible return values for print_bpstat, print_it_normal,

/* The possible return values for print_bpstat, print_it_normal,

   print_it_done, print_it_noop. */

   print_it_done, print_it_noop. */

enum print_stop_action

enum print_stop_action

  {

  {

    PRINT_UNKNOWN = -1,

    PRINT_UNKNOWN = -1,

    PRINT_SRC_AND_LOC,

    PRINT_SRC_AND_LOC,

    PRINT_SRC_ONLY,

    PRINT_SRC_ONLY,

    PRINT_NOTHING

    PRINT_NOTHING

  };

  };

/* Tell what to do about this bpstat.  */

/* Tell what to do about this bpstat.  */

struct bpstat_what bpstat_what (bpstat);

struct bpstat_what bpstat_what (bpstat);

/* Find the bpstat associated with a breakpoint.  NULL otherwise. */

/* Find the bpstat associated with a breakpoint.  NULL otherwise. */

bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);

bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);

/* Find a step_resume breakpoint associated with this bpstat.

/* Find a step_resume breakpoint associated with this bpstat.

   (If there are multiple step_resume bp's on the list, this function

   (If there are multiple step_resume bp's on the list, this function

   will arbitrarily pick one.)

   will arbitrarily pick one.)

   It is an error to use this function if BPSTAT doesn't contain a

   It is an error to use this function if BPSTAT doesn't contain a

   step_resume breakpoint.

   step_resume breakpoint.

   See wait_for_inferior's use of this function.

   See wait_for_inferior's use of this function.

 */

 */

extern struct breakpoint *bpstat_find_step_resume_breakpoint (bpstat);

extern struct breakpoint *bpstat_find_step_resume_breakpoint (bpstat);

/* Nonzero if a signal that we got in wait() was due to circumstances

/* Nonzero if a signal that we got in wait() was due to circumstances

   explained by the BS.  */

   explained by the BS.  */

/* Currently that is true if we have hit a breakpoint, or if there is

/* Currently that is true if we have hit a breakpoint, or if there is

   a watchpoint enabled.  */

   a watchpoint enabled.  */

#define bpstat_explains_signal(bs) ((bs) != NULL)

#define bpstat_explains_signal(bs) ((bs) != NULL)

/* Nonzero if we should step constantly (e.g. watchpoints on machines

/* Nonzero if we should step constantly (e.g. watchpoints on machines

   without hardware support).  This isn't related to a specific bpstat,

   without hardware support).  This isn't related to a specific bpstat,

   just to things like whether watchpoints are set.  */

   just to things like whether watchpoints are set.  */

extern int bpstat_should_step (void);

extern int bpstat_should_step (void);

/* Print a message indicating what happened.  Returns nonzero to

/* Print a message indicating what happened.  Returns nonzero to

   say that only the source line should be printed after this (zero

   say that only the source line should be printed after this (zero

   return means print the frame as well as the source line).  */

   return means print the frame as well as the source line).  */

extern enum print_stop_action bpstat_print (bpstat);

extern enum print_stop_action bpstat_print (bpstat);

/* Put in *NUM the breakpoint number of the first breakpoint we are stopped

/* Put in *NUM the breakpoint number of the first breakpoint we are stopped

   at.  *BSP upon return is a bpstat which points to the remaining

   at.  *BSP upon return is a bpstat which points to the remaining

   breakpoints stopped at (but which is not guaranteed to be good for

   breakpoints stopped at (but which is not guaranteed to be good for

   anything but further calls to bpstat_num).

   anything but further calls to bpstat_num).

   Return 0 if passed a bpstat which does not indicate any breakpoints.

   Return 0 if passed a bpstat which does not indicate any breakpoints.

   Return -1 if stopped at a breakpoint that has been deleted since

   Return -1 if stopped at a breakpoint that has been deleted since

   we set it.

   we set it.

   Return 1 otherwise.  */

   Return 1 otherwise.  */

extern int bpstat_num (bpstat *, int *);

extern int bpstat_num (bpstat *, int *);

/* Perform actions associated with having stopped at *BSP.  Actually, we just

/* Perform actions associated with having stopped at *BSP.  Actually, we just

   use this for breakpoint commands.  Perhaps other actions will go here

   use this for breakpoint commands.  Perhaps other actions will go here

   later, but this is executed at a late time (from the command loop).  */

   later, but this is executed at a late time (from the command loop).  */

extern void bpstat_do_actions (bpstat *);

extern void bpstat_do_actions (bpstat *);

/* Modify BS so that the actions will not be performed.  */

/* Modify BS so that the actions will not be performed.  */

extern void bpstat_clear_actions (bpstat);

extern void bpstat_clear_actions (bpstat);

/* Given a bpstat that records zero or more triggered eventpoints, this

/* Given a bpstat that records zero or more triggered eventpoints, this

   function returns another bpstat which contains only the catchpoints

   function returns another bpstat which contains only the catchpoints

   on that first list, if any.

   on that first list, if any.

 */

 */

extern void bpstat_get_triggered_catchpoints (bpstat, bpstat *);

extern void bpstat_get_triggered_catchpoints (bpstat, bpstat *);

/* Implementation:  */

/* Implementation:  */

/* Values used to tell the printing routine how to behave for this bpstat. */

/* Values used to tell the printing routine how to behave for this bpstat. */

enum bp_print_how

enum bp_print_how

  {

  {

    /* This is used when we want to do a normal printing of the reason

    /* This is used when we want to do a normal printing of the reason

       for stopping. The output will depend on the type of eventpoint

       for stopping. The output will depend on the type of eventpoint

       we are dealing with. This is the default value, most commonly

       we are dealing with. This is the default value, most commonly

       used. */

       used. */

    print_it_normal,

    print_it_normal,

    /* This is used when nothing should be printed for this bpstat entry.  */

    /* This is used when nothing should be printed for this bpstat entry.  */

    print_it_noop,

    print_it_noop,

    /* This is used when everything which needs to be printed has

    /* This is used when everything which needs to be printed has

       already been printed.  But we still want to print the frame.  */

       already been printed.  But we still want to print the frame.  */

    print_it_done

    print_it_done

  };

  };

struct bpstats

struct bpstats

  {

  {

    /* Linked list because there can be two breakpoints at the same

    /* Linked list because there can be two breakpoints at the same

       place, and a bpstat reflects the fact that both have been hit.  */

       place, and a bpstat reflects the fact that both have been hit.  */

    bpstat next;

    bpstat next;

    /* Breakpoint that we are at.  */

    /* Breakpoint that we are at.  */

    const struct bp_location *breakpoint_at;

    const struct bp_location *breakpoint_at;

    /* Commands left to be done.  */

    /* Commands left to be done.  */

    struct command_line *commands;

    struct command_line *commands;

    /* Old value associated with a watchpoint.  */

    /* Old value associated with a watchpoint.  */

    struct value *old_val;

    struct value *old_val;

    /* Nonzero if this breakpoint tells us to print the frame.  */

    /* Nonzero if this breakpoint tells us to print the frame.  */

    char print;

    char print;

    /* Nonzero if this breakpoint tells us to stop.  */

    /* Nonzero if this breakpoint tells us to stop.  */

    char stop;

    char stop;

    /* Tell bpstat_print and print_bp_stop_message how to print stuff

    /* Tell bpstat_print and print_bp_stop_message how to print stuff

       associated with this element of the bpstat chain.  */

       associated with this element of the bpstat chain.  */

    enum bp_print_how print_it;

    enum bp_print_how print_it;

  };

  };

enum inf_context

enum inf_context

  {

  {

    inf_starting,

    inf_starting,

    inf_running,

    inf_running,

    inf_exited

    inf_exited

  };

  };

/* The possible return values for breakpoint_here_p.

/* The possible return values for breakpoint_here_p.

   We guarantee that zero always means "no breakpoint here".  */

   We guarantee that zero always means "no breakpoint here".  */

enum breakpoint_here

enum breakpoint_here

  {

  {

    no_breakpoint_here = 0,

    no_breakpoint_here = 0,

    ordinary_breakpoint_here,

    ordinary_breakpoint_here,

    permanent_breakpoint_here

    permanent_breakpoint_here

  };

  };

/* Prototypes for breakpoint-related functions.  */

/* Prototypes for breakpoint-related functions.  */

extern enum breakpoint_here breakpoint_here_p (CORE_ADDR);

extern enum breakpoint_here breakpoint_here_p (CORE_ADDR);

extern int breakpoint_inserted_here_p (CORE_ADDR);

extern int breakpoint_inserted_here_p (CORE_ADDR);

extern int regular_breakpoint_inserted_here_p (CORE_ADDR);

extern int regular_breakpoint_inserted_here_p (CORE_ADDR);

extern int software_breakpoint_inserted_here_p (CORE_ADDR);

extern int software_breakpoint_inserted_here_p (CORE_ADDR);

extern int breakpoint_thread_match (CORE_ADDR, ptid_t);

extern int breakpoint_thread_match (CORE_ADDR, ptid_t);

extern void until_break_command (char *, int, int);

extern void until_break_command (char *, int, int);

extern void breakpoint_re_set (void);

extern void breakpoint_re_set (void);

extern void breakpoint_re_set_thread (struct breakpoint *);

extern void breakpoint_re_set_thread (struct breakpoint *);

extern int ep_is_exception_catchpoint (struct breakpoint *);

extern int ep_is_exception_catchpoint (struct breakpoint *);

extern struct breakpoint *set_momentary_breakpoint

extern struct breakpoint *set_momentary_breakpoint

  (struct symtab_and_line, struct frame_id, enum bptype);

  (struct symtab_and_line, struct frame_id, enum bptype);

extern void set_ignore_count (int, int, int);

extern void set_ignore_count (int, int, int);

extern void set_default_breakpoint (int, CORE_ADDR, struct symtab *, int);

extern void set_default_breakpoint (int, CORE_ADDR, struct symtab *, int);

extern void breakpoint_init_inferior (enum inf_context);

extern void breakpoint_init_inferior (enum inf_context);

extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);

extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);

extern struct cleanup *make_exec_cleanup_delete_breakpoint (struct breakpoint *);

extern struct cleanup *make_exec_cleanup_delete_breakpoint (struct breakpoint *);

extern void delete_breakpoint (struct breakpoint *);

extern void delete_breakpoint (struct breakpoint *);

extern void breakpoint_auto_delete (bpstat);

extern void breakpoint_auto_delete (bpstat);

extern void breakpoint_clear_ignore_counts (void);

extern void breakpoint_clear_ignore_counts (void);

extern void break_command (char *, int);

extern void break_command (char *, int);

extern void hbreak_command_wrapper (char *, int);

extern void hbreak_command_wrapper (char *, int);

extern void thbreak_command_wrapper (char *, int);

extern void thbreak_command_wrapper (char *, int);

extern void rbreak_command_wrapper (char *, int);

extern void rbreak_command_wrapper (char *, int);

extern void watch_command_wrapper (char *, int);

extern void watch_command_wrapper (char *, int);

extern void awatch_command_wrapper (char *, int);

extern void awatch_command_wrapper (char *, int);

extern void rwatch_command_wrapper (char *, int);

extern void rwatch_command_wrapper (char *, int);

extern void tbreak_command (char *, int);

extern void tbreak_command (char *, int);

extern void set_breakpoint (char *address, char *condition,

extern void set_breakpoint (char *address, char *condition,

                            int hardwareflag, int tempflag,

                            int hardwareflag, int tempflag,

                            int thread, int ignore_count,

                            int thread, int ignore_count,

                            int pending);

                            int pending);

extern void insert_breakpoints (void);

extern void insert_breakpoints (void);