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