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