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