gdb/breakpoint.h

   1 /* Data structures associated with breakpoints in GDB.
   2    Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
   3    2002, 2003, 2004, 2007 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20    Boston, MA 02110-1301, USA.  */
  21
  22 #if !defined (BREAKPOINT_H)
  23 #define BREAKPOINT_H 1
  24
  25 #include "frame.h"
  26 #include "value.h"
  27
  28 #include "gdb-events.h"
  29
  30 struct value;
  31 struct block;
  32
  33 /* This is the maximum number of bytes a breakpoint instruction can take.
  34    Feel free to increase it.  It's just used in a few places to size
  35    arrays that should be independent of the target architecture.  */
  36
  37 #define BREAKPOINT_MAX  16
  38 \f
  39 /* Type of breakpoint. */
  40 /* FIXME In the future, we should fold all other breakpoint-like things into
  41    here.  This includes:
  42
  43    * single-step (for machines where we have to simulate single stepping)
  44    (probably, though perhaps it is better for it to look as much as
  45    possible like a single-step to wait_for_inferior).  */
  46
  47 enum bptype
  48   {
  49     bp_none = 0,                /* Eventpoint has been deleted. */
  50     bp_breakpoint,              /* Normal breakpoint */
  51     bp_hardware_breakpoint,     /* Hardware assisted breakpoint */
  52     bp_until,                   /* used by until command */
  53     bp_finish,                  /* used by finish command */
  54     bp_watchpoint,              /* Watchpoint */
  55     bp_hardware_watchpoint,     /* Hardware assisted watchpoint */
  56     bp_read_watchpoint,         /* read watchpoint, (hardware assisted) */
  57     bp_access_watchpoint,       /* access watchpoint, (hardware assisted) */
  58     bp_longjmp,                 /* secret breakpoint to find longjmp() */
  59     bp_longjmp_resume,          /* secret breakpoint to escape longjmp() */
  60
  61     /* Used by wait_for_inferior for stepping over subroutine calls, for
  62        stepping over signal handlers, and for skipping prologues.  */
  63     bp_step_resume,
  64
  65     /* Used by wait_for_inferior for stepping over signal handlers.  */
  66     bp_through_sigtramp,
  67
  68     /* Used to detect when a watchpoint expression has gone out of
  69        scope.  These breakpoints are usually not visible to the user.
  70
  71        This breakpoint has some interesting properties:
  72
  73        1) There's always a 1:1 mapping between watchpoints
  74        on local variables and watchpoint_scope breakpoints.
  75
  76        2) It automatically deletes itself and the watchpoint it's
  77        associated with when hit.
  78
  79        3) It can never be disabled.  */
  80     bp_watchpoint_scope,
  81
  82     /* The breakpoint at the end of a call dummy.  */
  83     /* FIXME: What if the function we are calling longjmp()s out of the
  84        call, or the user gets out with the "return" command?  We currently
  85        have no way of cleaning up the breakpoint in these (obscure) situations.
  86        (Probably can solve this by noticing longjmp, "return", etc., it's
  87        similar to noticing when a watchpoint on a local variable goes out
  88        of scope (with hardware support for watchpoints)).  */
  89     bp_call_dummy,
  90
  91     /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
  92        code in the inferior to run when significant events occur in the
  93        dynamic linker (for example a library is loaded or unloaded).
  94
  95        By placing a breakpoint in this magic code GDB will get control
  96        when these significant events occur.  GDB can then re-examine
  97        the dynamic linker's data structures to discover any newly loaded
  98        dynamic libraries.  */
  99     bp_shlib_event,
 100
 101     /* Some multi-threaded systems can arrange for a location in the
 102        inferior to be executed when certain thread-related events occur
 103        (such as thread creation or thread death).
 104
 105        By placing a breakpoint at one of these locations, GDB will get
 106        control when these events occur.  GDB can then update its thread
 107        lists etc.  */
 108
 109     bp_thread_event,
 110
 111     /* On the same principal, an overlay manager can arrange to call a
 112        magic location in the inferior whenever there is an interesting
 113        change in overlay status.  GDB can update its overlay tables
 114        and fiddle with breakpoints in overlays when this breakpoint
 115        is hit.  */
 116
 117     bp_overlay_event,
 118
 119     /* These breakpoints are used to implement the "catch load" command
 120        on platforms whose dynamic linkers support such functionality.  */
 121     bp_catch_load,
 122
 123     /* These breakpoints are used to implement the "catch unload" command
 124        on platforms whose dynamic linkers support such functionality.  */
 125     bp_catch_unload,
 126
 127     /* These are not really breakpoints, but are catchpoints that
 128        implement the "catch fork", "catch vfork" and "catch exec" commands
 129        on platforms whose kernel support such functionality.  (I.e.,
 130        kernels which can raise an event when a fork or exec occurs, as
 131        opposed to the debugger setting breakpoints on functions named
 132        "fork" or "exec".) */
 133     bp_catch_fork,
 134     bp_catch_vfork,
 135     bp_catch_exec,
 136
 137     /* These are catchpoints to implement "catch catch" and "catch throw"
 138        commands for C++ exception handling. */
 139     bp_catch_catch,
 140     bp_catch_throw
 141
 142
 143   };
 144
 145 /* States of enablement of breakpoint. */
 146
 147 enum enable_state
 148   {
 149     bp_disabled,        /* The eventpoint is inactive, and cannot trigger. */
 150     bp_enabled,         /* The eventpoint is active, and can trigger. */
 151     bp_shlib_disabled,  /* The eventpoint's address is in an unloaded solib.
 152                            The eventpoint will be automatically enabled
 153                            and reset when that solib is loaded. */
 154     bp_call_disabled,   /* The eventpoint has been disabled while a call
 155                            into the inferior is "in flight", because some
 156                            eventpoints interfere with the implementation of
 157                            a call on some targets.  The eventpoint will be
 158                            automatically enabled and reset when the call
 159                            "lands" (either completes, or stops at another
 160                            eventpoint). */
 161     bp_permanent        /* There is a breakpoint instruction hard-wired into
 162                            the target's code.  Don't try to write another
 163                            breakpoint instruction on top of it, or restore
 164                            its value.  Step over it using the architecture's
 165                            SKIP_INSN macro.  */
 166   };
 167
 168
 169 /* Disposition of breakpoint.  Ie: what to do after hitting it. */
 170
 171 enum bpdisp
 172   {
 173     disp_del,                   /* Delete it */
 174     disp_del_at_next_stop,      /* Delete at next stop, whether hit or not */
 175     disp_disable,               /* Disable it */
 176     disp_donttouch              /* Leave it alone */
 177   };
 178
 179 enum target_hw_bp_type
 180   {
 181     hw_write   = 0,             /* Common  HW watchpoint */
 182     hw_read    = 1,             /* Read    HW watchpoint */
 183     hw_access  = 2,             /* Access  HW watchpoint */
 184     hw_execute = 3              /* Execute HW breakpoint */
 185   };
 186
 187
 188 /* Information used by targets to insert and remove breakpoints.  */
 189
 190 struct bp_target_info
 191 {
 192   /* Address at which the breakpoint was placed.  This is normally the
 193      same as ADDRESS from the bp_location, except when adjustment
 194      happens in BREAKPOINT_FROM_PC.  The most common form of
 195      adjustment is stripping an alternate ISA marker from the PC which
 196      is used to determine the type of breakpoint to insert.  */
 197   CORE_ADDR placed_address;
 198
 199   /* If the breakpoint lives in memory and reading that memory would
 200      give back the breakpoint, instead of the original contents, then
 201      the original contents are cached here.  Only SHADOW_LEN bytes of
 202      this buffer are valid, and only when the breakpoint is inserted.  */
 203   gdb_byte shadow_contents[BREAKPOINT_MAX];
 204
 205   /* The length of the data cached in SHADOW_CONTENTS.  */
 206   int shadow_len;
 207
 208   /* The size of the placed breakpoint, according to
 209      BREAKPOINT_FROM_PC, when the breakpoint was inserted.  This is
 210      generally the same as SHADOW_LEN, unless we did not need
 211      to read from the target to implement the memory breakpoint
 212      (e.g. if a remote stub handled the details).  We may still
 213      need the size to remove the breakpoint safely.  */
 214   int placed_size;
 215 };
 216
 217 /* GDB maintains two types of information about each breakpoint (or
 218    watchpoint, or other related event).  The first type corresponds
 219    to struct breakpoint; this is a relatively high-level structure
 220    which contains the source location(s), stopping conditions, user
 221    commands to execute when the breakpoint is hit, and so forth.
 222
 223    The second type of information corresponds to struct bp_location.
 224    Each breakpoint has one or (eventually) more locations associated
 225    with it, which represent target-specific and machine-specific
 226    mechanisms for stopping the program.  For instance, a watchpoint
 227    expression may require multiple hardware watchpoints in order to
 228    catch all changes in the value of the expression being watched.  */
 229
 230 enum bp_loc_type
 231 {
 232   bp_loc_software_breakpoint,
 233   bp_loc_hardware_breakpoint,
 234   bp_loc_hardware_watchpoint,
 235   bp_loc_other                  /* Miscellaneous...  */
 236 };
 237
 238 struct bp_location
 239 {
 240   /* Chain pointer to the next breakpoint location.  */
 241   struct bp_location *next;
 242
 243   /* Type of this breakpoint location.  */
 244   enum bp_loc_type loc_type;
 245
 246   /* Each breakpoint location must belong to exactly one higher-level
 247      breakpoint.  This and the DUPLICATE flag are more straightforward
 248      than reference counting.  */
 249   struct breakpoint *owner;
 250
 251   /* Nonzero if this breakpoint is now inserted.  */
 252   char inserted;
 253
 254   /* Nonzero if this is not the first breakpoint in the list
 255      for the given address.  */
 256   char duplicate;
 257
 258   /* If we someday support real thread-specific breakpoints, then
 259      the breakpoint location will need a thread identifier.  */
 260
 261   /* Data for specific breakpoint types.  These could be a union, but
 262      simplicity is more important than memory usage for breakpoints.  */
 263
 264   /* Note that zero is a perfectly valid code address on some platforms
 265      (for example, the mn10200 (OBSOLETE) and mn10300 simulators).  NULL
 266      is not a special value for this field.  Valid for all types except
 267      bp_loc_other.  */
 268   CORE_ADDR address;
 269
 270   /* For any breakpoint type with an address, this is the BFD section
 271      associated with the address.  Used primarily for overlay debugging.  */
 272   asection *section;
 273
 274   /* Address at which breakpoint was requested, either by the user or
 275      by GDB for internal breakpoints.  This will usually be the same
 276      as ``address'' (above) except for cases in which
 277      ADJUST_BREAKPOINT_ADDRESS has computed a different address at
 278      which to place the breakpoint in order to comply with a
 279      processor's architectual constraints.  */
 280   CORE_ADDR requested_address;
 281
 282   /* Details of the placed breakpoint, when inserted.  */
 283   struct bp_target_info target_info;
 284
 285   /* Similarly, for the breakpoint at an overlay's LMA, if necessary.  */
 286   struct bp_target_info overlay_target_info;
 287 };
 288
 289 /* This structure is a collection of function pointers that, if available,
 290    will be called instead of the performing the default action for this
 291    bptype.  */
 292
 293 struct breakpoint_ops
 294 {
 295   /* The normal print routine for this breakpoint, called when we
 296      hit it.  */
 297   enum print_stop_action (*print_it) (struct breakpoint *);
 298
 299   /* Display information about this breakpoint, for "info breakpoints".  */
 300   void (*print_one) (struct breakpoint *, CORE_ADDR *);
 301
 302   /* Display information about this breakpoint after setting it (roughly
 303      speaking; this is called from "mention").  */
 304   void (*print_mention) (struct breakpoint *);
 305 };
 306
 307 /* Note that the ->silent field is not currently used by any commands
 308    (though the code is in there if it was to be, and set_raw_breakpoint
 309    does set it to 0).  I implemented it because I thought it would be
 310    useful for a hack I had to put in; I'm going to leave it in because
 311    I can see how there might be times when it would indeed be useful */
 312
 313 /* This is for a breakpoint or a watchpoint.  */
 314
 315 struct breakpoint
 316   {
 317     struct breakpoint *next;
 318     /* Type of breakpoint. */
 319     enum bptype type;
 320     /* Zero means disabled; remember the info but don't break here.  */
 321     enum enable_state enable_state;
 322     /* What to do with this breakpoint after we hit it. */
 323     enum bpdisp disposition;
 324     /* Number assigned to distinguish breakpoints.  */
 325     int number;
 326
 327     /* Location(s) associated with this high-level breakpoint.  */
 328     struct bp_location *loc;
 329
 330     /* Line number of this address.  */
 331
 332     int line_number;
 333
 334     /* Source file name of this address.  */
 335
 336     char *source_file;
 337
 338     /* Non-zero means a silent breakpoint (don't print frame info
 339        if we stop here). */
 340     unsigned char silent;
 341     /* Number of stops at this breakpoint that should
 342        be continued automatically before really stopping.  */
 343     int ignore_count;
 344     /* Chain of command lines to execute when this breakpoint is hit.  */
 345     struct command_line *commands;
 346     /* Stack depth (address of frame).  If nonzero, break only if fp
 347        equals this.  */
 348     struct frame_id frame_id;
 349     /* Conditional.  Break only if this expression's value is nonzero.  */
 350     struct expression *cond;
 351
 352     /* String we used to set the breakpoint (malloc'd).  */
 353     char *addr_string;
 354     /* Language we used to set the breakpoint.  */
 355     enum language language;
 356     /* Input radix we used to set the breakpoint.  */
 357     int input_radix;
 358     /* String form of the breakpoint condition (malloc'd), or NULL if there
 359        is no condition.  */
 360     char *cond_string;
 361     /* String form of exp (malloc'd), or NULL if none.  */
 362     char *exp_string;
 363
 364     /* The expression we are watching, or NULL if not a watchpoint.  */
 365     struct expression *exp;
 366     /* The largest block within which it is valid, or NULL if it is
 367        valid anywhere (e.g. consists just of global symbols).  */
 368     struct block *exp_valid_block;
 369     /* Value of the watchpoint the last time we checked it.  */
 370     struct value *val;
 371
 372     /* Holds the value chain for a hardware watchpoint expression.  */
 373     struct value *val_chain;
 374
 375     /* Holds the address of the related watchpoint_scope breakpoint
 376        when using watchpoints on local variables (might the concept
 377        of a related breakpoint be useful elsewhere, if not just call
 378        it the watchpoint_scope breakpoint or something like that. FIXME).  */
 379     struct breakpoint *related_breakpoint;
 380
 381     /* Holds the frame address which identifies the frame this
 382        watchpoint should be evaluated in, or `null' if the watchpoint
 383        should be evaluated on the outermost frame.  */
 384     struct frame_id watchpoint_frame;
 385
 386     /* Thread number for thread-specific breakpoint, or -1 if don't care */
 387     int thread;
 388
 389     /* Count of the number of times this breakpoint was taken, dumped
 390        with the info, but not used for anything else.  Useful for
 391        seeing how many times you hit a break prior to the program
 392        aborting, so you can back up to just before the abort.  */
 393     int hit_count;
 394
 395     /* Filename of a dynamically-linked library (dll), used for
 396        bp_catch_load and bp_catch_unload (malloc'd), or NULL if any
 397        library is significant.  */
 398     char *dll_pathname;
 399
 400     /* Filename of a dll whose state change (e.g., load or unload)
 401        triggered this catchpoint.  This field is only valid immediately
 402        after this catchpoint has triggered.  */
 403     char *triggered_dll_pathname;
 404
 405     /* Process id of a child process whose forking triggered this
 406        catchpoint.  This field is only valid immediately after this
 407        catchpoint has triggered.  */
 408     int forked_inferior_pid;
 409
 410     /* Filename of a program whose exec triggered this catchpoint.
 411        This field is only valid immediately after this catchpoint has
 412        triggered.  */
 413     char *exec_pathname;
 414
 415     /* Methods associated with this breakpoint.  */
 416     struct breakpoint_ops *ops;
 417
 418     /* Was breakpoint issued from a tty?  Saved for the use of pending breakpoints.  */
 419     int from_tty;
 420
 421     /* Flag value for pending breakpoint.
 422        first bit  : 0 non-temporary, 1 temporary.
 423        second bit : 0 normal breakpoint, 1 hardware breakpoint. */
 424     int flag;
 425
 426     /* Is breakpoint pending on shlib loads?  */
 427     int pending;
 428   };
 429 \f
 430 /* The following stuff is an abstract data type "bpstat" ("breakpoint
 431    status").  This provides the ability to determine whether we have
 432    stopped at a breakpoint, and what we should do about it.  */
 433
 434 typedef struct bpstats *bpstat;
 435
 436 /* Interface:  */
 437 /* Clear a bpstat so that it says we are not at any breakpoint.
 438    Also free any storage that is part of a bpstat.  */
 439 extern void bpstat_clear (bpstat *);
 440
 441 /* Return a copy of a bpstat.  Like "bs1 = bs2" but all storage that
 442    is part of the bpstat is copied as well.  */
 443 extern bpstat bpstat_copy (bpstat);
 444
 445 extern bpstat bpstat_stop_status (CORE_ADDR pc, ptid_t ptid,
 446                                   int stopped_by_watchpoint);
 447 \f
 448 /* This bpstat_what stuff tells wait_for_inferior what to do with a
 449    breakpoint (a challenging task).  */
 450
 451 enum bpstat_what_main_action
 452   {
 453     /* Perform various other tests; that is, this bpstat does not
 454        say to perform any action (e.g. failed watchpoint and nothing
 455        else).  */
 456     BPSTAT_WHAT_KEEP_CHECKING,
 457
 458     /* Rather than distinguish between noisy and silent stops here, it
 459        might be cleaner to have bpstat_print make that decision (also
 460        taking into account stop_print_frame and source_only).  But the
 461        implications are a bit scary (interaction with auto-displays, etc.),
 462        so I won't try it.  */
 463
 464     /* Stop silently.  */
 465     BPSTAT_WHAT_STOP_SILENT,
 466
 467     /* Stop and print.  */
 468     BPSTAT_WHAT_STOP_NOISY,
 469
 470     /* Remove breakpoints, single step once, then put them back in and
 471        go back to what we were doing.  It's possible that this should be
 472        removed from the main_action and put into a separate field, to more
 473        cleanly handle BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE.  */
 474     BPSTAT_WHAT_SINGLE,
 475
 476     /* Set longjmp_resume breakpoint, remove all other breakpoints,
 477        and continue.  The "remove all other breakpoints" part is required
 478        if we are also stepping over another breakpoint as well as doing
 479        the longjmp handling.  */
 480     BPSTAT_WHAT_SET_LONGJMP_RESUME,
 481
 482     /* Clear longjmp_resume breakpoint, then handle as
 483        BPSTAT_WHAT_KEEP_CHECKING.  */
 484     BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
 485
 486     /* Clear longjmp_resume breakpoint, then handle as BPSTAT_WHAT_SINGLE.  */
 487     BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE,
 488
 489     /* Clear step resume breakpoint, and keep checking.  */
 490     BPSTAT_WHAT_STEP_RESUME,
 491
 492     /* Clear through_sigtramp breakpoint, muck with trap_expected, and keep
 493        checking.  */
 494     BPSTAT_WHAT_THROUGH_SIGTRAMP,
 495
 496     /* Check the dynamic linker's data structures for new libraries, then
 497        keep checking.  */
 498     BPSTAT_WHAT_CHECK_SHLIBS,
 499
 500     /* Check the dynamic linker's data structures for new libraries, then
 501        resume out of the dynamic linker's callback, stop and print.  */
 502     BPSTAT_WHAT_CHECK_SHLIBS_RESUME_FROM_HOOK,
 503
 504     /* This is just used to keep track of how many enums there are.  */
 505     BPSTAT_WHAT_LAST
 506   };
 507
 508 struct bpstat_what
 509   {
 510     enum bpstat_what_main_action main_action;
 511
 512     /* Did we hit a call dummy breakpoint?  This only goes with a main_action
 513        of BPSTAT_WHAT_STOP_SILENT or BPSTAT_WHAT_STOP_NOISY (the concept of
 514        continuing from a call dummy without popping the frame is not a
 515        useful one).  */
 516     int call_dummy;
 517   };
 518
 519 /* The possible return values for print_bpstat, print_it_normal,
 520    print_it_done, print_it_noop. */
 521 enum print_stop_action
 522   {
 523     PRINT_UNKNOWN = -1,
 524     PRINT_SRC_AND_LOC,
 525     PRINT_SRC_ONLY,
 526     PRINT_NOTHING
 527   };
 528
 529 /* Tell what to do about this bpstat.  */
 530 struct bpstat_what bpstat_what (bpstat);
 531 \f
 532 /* Find the bpstat associated with a breakpoint.  NULL otherwise. */
 533 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
 534
 535 /* Find a step_resume breakpoint associated with this bpstat.
 536    (If there are multiple step_resume bp's on the list, this function
 537    will arbitrarily pick one.)
 538
 539    It is an error to use this function if BPSTAT doesn't contain a
 540    step_resume breakpoint.
 541
 542    See wait_for_inferior's use of this function.
 543  */
 544 extern struct breakpoint *bpstat_find_step_resume_breakpoint (bpstat);
 545
 546 /* Nonzero if a signal that we got in wait() was due to circumstances
 547    explained by the BS.  */
 548 /* Currently that is true if we have hit a breakpoint, or if there is
 549    a watchpoint enabled.  */
 550 #define bpstat_explains_signal(bs) ((bs) != NULL)
 551
 552 /* Nonzero if we should step constantly (e.g. watchpoints on machines
 553    without hardware support).  This isn't related to a specific bpstat,
 554    just to things like whether watchpoints are set.  */
 555 extern int bpstat_should_step (void);
 556
 557 /* Nonzero if there are enabled hardware watchpoints. */
 558 extern int bpstat_have_active_hw_watchpoints (void);
 559
 560 /* Print a message indicating what happened.  Returns nonzero to
 561    say that only the source line should be printed after this (zero
 562    return means print the frame as well as the source line).  */
 563 extern enum print_stop_action bpstat_print (bpstat);
 564
 565 /* Return the breakpoint number of the first breakpoint we are stopped
 566    at.  *BSP upon return is a bpstat which points to the remaining
 567    breakpoints stopped at (but which is not guaranteed to be good for
 568    anything but further calls to bpstat_num).
 569    Return 0 if passed a bpstat which does not indicate any breakpoints.  */
 570 extern int bpstat_num (bpstat *);
 571
 572 /* Perform actions associated with having stopped at *BSP.  Actually, we just
 573    use this for breakpoint commands.  Perhaps other actions will go here
 574    later, but this is executed at a late time (from the command loop).  */
 575 extern void bpstat_do_actions (bpstat *);
 576
 577 /* Modify BS so that the actions will not be performed.  */
 578 extern void bpstat_clear_actions (bpstat);
 579
 580 /* Given a bpstat that records zero or more triggered eventpoints, this
 581    function returns another bpstat which contains only the catchpoints
 582    on that first list, if any.
 583  */
 584 extern void bpstat_get_triggered_catchpoints (bpstat, bpstat *);
 585
 586 /* Implementation:  */
 587
 588 /* Values used to tell the printing routine how to behave for this bpstat. */
 589 enum bp_print_how
 590   {
 591     /* This is used when we want to do a normal printing of the reason
 592        for stopping. The output will depend on the type of eventpoint
 593        we are dealing with. This is the default value, most commonly
 594        used. */
 595     print_it_normal,
 596     /* This is used when nothing should be printed for this bpstat entry.  */
 597     print_it_noop,
 598     /* This is used when everything which needs to be printed has
 599        already been printed.  But we still want to print the frame.  */
 600     print_it_done
 601   };
 602
 603 struct bpstats
 604   {
 605     /* Linked list because there can be two breakpoints at the same
 606        place, and a bpstat reflects the fact that both have been hit.  */
 607     bpstat next;
 608     /* Breakpoint that we are at.  */
 609     struct breakpoint *breakpoint_at;
 610     /* Commands left to be done.  */
 611     struct command_line *commands;
 612     /* Old value associated with a watchpoint.  */
 613     struct value *old_val;
 614
 615     /* Nonzero if this breakpoint tells us to print the frame.  */
 616     char print;
 617
 618     /* Nonzero if this breakpoint tells us to stop.  */
 619     char stop;
 620
 621     /* Tell bpstat_print and print_bp_stop_message how to print stuff
 622        associated with this element of the bpstat chain.  */
 623     enum bp_print_how print_it;
 624   };
 625
 626 enum inf_context
 627   {
 628     inf_starting,
 629     inf_running,
 630     inf_exited
 631   };
 632
 633 /* The possible return values for breakpoint_here_p.
 634    We guarantee that zero always means "no breakpoint here".  */
 635 enum breakpoint_here
 636   {
 637     no_breakpoint_here = 0,
 638     ordinary_breakpoint_here,
 639     permanent_breakpoint_here
 640   };
 641 \f
 642
 643 /* Prototypes for breakpoint-related functions.  */
 644
 645 extern enum breakpoint_here breakpoint_here_p (CORE_ADDR);
 646
 647 extern int breakpoint_inserted_here_p (CORE_ADDR);
 648
 649 extern int software_breakpoint_inserted_here_p (CORE_ADDR);
 650
 651 extern int breakpoint_thread_match (CORE_ADDR, ptid_t);
 652
 653 extern void until_break_command (char *, int, int);
 654
 655 extern void breakpoint_re_set (void);
 656
 657 extern void breakpoint_re_set_thread (struct breakpoint *);
 658
 659 extern int ep_is_exception_catchpoint (struct breakpoint *);
 660
 661 extern struct breakpoint *set_momentary_breakpoint
 662   (struct symtab_and_line, struct frame_id, enum bptype);
 663
 664 extern void set_ignore_count (int, int, int);
 665
 666 extern void set_default_breakpoint (int, CORE_ADDR, struct symtab *, int);
 667
 668 extern void mark_breakpoints_out (void);
 669
 670 extern void breakpoint_init_inferior (enum inf_context);
 671
 672 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
 673
 674 extern struct cleanup *make_exec_cleanup_delete_breakpoint (struct breakpoint *);
 675
 676 extern void delete_breakpoint (struct breakpoint *);
 677
 678 extern void breakpoint_auto_delete (bpstat);
 679
 680 extern void breakpoint_clear_ignore_counts (void);
 681
 682 extern void break_command (char *, int);
 683
 684 extern void hbreak_command_wrapper (char *, int);
 685 extern void thbreak_command_wrapper (char *, int);
 686 extern void rbreak_command_wrapper (char *, int);
 687 extern void watch_command_wrapper (char *, int);
 688 extern void awatch_command_wrapper (char *, int);
 689 extern void rwatch_command_wrapper (char *, int);
 690 extern void tbreak_command (char *, int);
 691
 692 extern int insert_breakpoints (void);
 693
 694 extern int remove_breakpoints (void);
 695
 696 /* This function can be used to physically insert eventpoints from the
 697    specified traced inferior process, without modifying the breakpoint
 698    package's state.  This can be useful for those targets which support
 699    following the processes of a fork() or vfork() system call, when both
 700    of the resulting two processes are to be followed.  */
 701 extern int reattach_breakpoints (int);
 702
 703 /* This function can be used to update the breakpoint package's state
 704    after an exec() system call has been executed.
 705
 706    This function causes the following:
 707
 708    - All eventpoints are marked "not inserted".
 709    - All eventpoints with a symbolic address are reset such that
 710    the symbolic address must be reevaluated before the eventpoints
 711    can be reinserted.
 712    - The solib breakpoints are explicitly removed from the breakpoint
 713    list.
 714    - A step-resume breakpoint, if any, is explicitly removed from the
 715    breakpoint list.
 716    - All eventpoints without a symbolic address are removed from the
 717    breakpoint list. */
 718 extern void update_breakpoints_after_exec (void);
 719
 720 /* This function can be used to physically remove hardware breakpoints
 721    and watchpoints from the specified traced inferior process, without
 722    modifying the breakpoint package's state.  This can be useful for
 723    those targets which support following the processes of a fork() or
 724    vfork() system call, when one of the resulting two processes is to
 725    be detached and allowed to run free.
 726
 727    It is an error to use this function on the process whose id is
 728    inferior_ptid.  */
 729 extern int detach_breakpoints (int);
 730
 731 extern void enable_longjmp_breakpoint (void);
 732 extern void disable_longjmp_breakpoint (void);
 733 extern void enable_overlay_breakpoints (void);
 734 extern void disable_overlay_breakpoints (void);
 735
 736 extern void set_longjmp_resume_breakpoint (CORE_ADDR, struct frame_id);
 737 /* These functions respectively disable or reenable all currently
 738    enabled watchpoints.  When disabled, the watchpoints are marked
 739    call_disabled.  When reenabled, they are marked enabled.
 740
 741    The intended client of these functions is call_function_by_hand.
 742
 743    The inferior must be stopped, and all breakpoints removed, when
 744    these functions are used.
 745
 746    The need for these functions is that on some targets (e.g., HP-UX),
 747    gdb is unable to unwind through the dummy frame that is pushed as
 748    part of the implementation of a call command.  Watchpoints can
 749    cause the inferior to stop in places where this frame is visible,
 750    and that can cause execution control to become very confused.
 751
 752    Note that if a user sets breakpoints in an interactively called
 753    function, the call_disabled watchpoints will have been reenabled
 754    when the first such breakpoint is reached.  However, on targets
 755    that are unable to unwind through the call dummy frame, watches
 756    of stack-based storage may then be deleted, because gdb will
 757    believe that their watched storage is out of scope.  (Sigh.) */
 758 extern void disable_watchpoints_before_interactive_call_start (void);
 759
 760 extern void enable_watchpoints_after_interactive_call_stop (void);
 761
 762
 763 extern void clear_breakpoint_hit_counts (void);
 764
 765 extern int get_number (char **);
 766
 767 extern int get_number_or_range (char **);
 768
 769 /* The following are for displays, which aren't really breakpoints, but
 770    here is as good a place as any for them.  */
 771
 772 extern void disable_current_display (void);
 773
 774 extern void do_displays (void);
 775
 776 extern void disable_display (int);
 777
 778 extern void clear_displays (void);
 779
 780 extern void disable_breakpoint (struct breakpoint *);
 781
 782 extern void enable_breakpoint (struct breakpoint *);
 783
 784 extern void make_breakpoint_permanent (struct breakpoint *);
 785
 786 extern struct breakpoint *create_solib_event_breakpoint (CORE_ADDR);
 787
 788 extern struct breakpoint *create_thread_event_breakpoint (CORE_ADDR);
 789
 790 extern void remove_solib_event_breakpoints (void);
 791
 792 extern void remove_thread_event_breakpoints (void);
 793
 794 extern void disable_breakpoints_in_shlibs (int silent);
 795
 796 extern void re_enable_breakpoints_in_shlibs (void);
 797
 798 extern void create_solib_load_event_breakpoint (char *, int, char *, char *);
 799
 800 extern void create_solib_unload_event_breakpoint (char *, int,
 801                                                   char *, char *);
 802
 803 extern void create_fork_event_catchpoint (int, char *);
 804
 805 extern void create_vfork_event_catchpoint (int, char *);
 806
 807 extern void create_exec_event_catchpoint (int, char *);
 808
 809 /* This function returns TRUE if ep is a catchpoint. */
 810 extern int ep_is_catchpoint (struct breakpoint *);
 811
 812 /* This function returns TRUE if ep is a catchpoint of a
 813    shared library (aka dynamically-linked library) event,
 814    such as a library load or unload. */
 815 extern int ep_is_shlib_catchpoint (struct breakpoint *);
 816
 817 extern struct breakpoint *set_breakpoint_sal (struct symtab_and_line);
 818
 819 /* Enable breakpoints and delete when hit.  Called with ARG == NULL
 820    deletes all breakpoints. */
 821 extern void delete_command (char *arg, int from_tty);
 822
 823 /* Pull all H/W watchpoints from the target. Return non-zero if the
 824    remove fails. */
 825 extern int remove_hw_watchpoints (void);
 826
 827 /* Manage a software single step breakpoint (or two).  Insert may be called
 828    twice before remove is called.  */
 829 extern void insert_single_step_breakpoint (CORE_ADDR);
 830 extern void remove_single_step_breakpoints (void);
 831
 832 /* Manage manual breakpoints, separate from the normal chain of
 833    breakpoints.  These functions are used in murky target-specific
 834    ways.  Please do not add more uses!  */
 835 extern void *deprecated_insert_raw_breakpoint (CORE_ADDR);
 836 extern int deprecated_remove_raw_breakpoint (void *);
 837
 838 /* Indicator of whether exception catchpoints should be nuked between
 839    runs of a program.  */
 840 extern int deprecated_exception_catchpoints_are_fragile;
 841
 842 /* Indicator of when exception catchpoints set-up should be
 843    reinitialized -- e.g. when program is re-run.  */
 844 extern int deprecated_exception_support_initialized;
 845
 846 #endif /* !defined (BREAKPOINT_H) */