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, 2009, 2010, 2011
   4    Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #if !defined (BREAKPOINT_H)
  22 #define BREAKPOINT_H 1
  23
  24 #include "frame.h"
  25 #include "value.h"
  26 #include "vec.h"
  27
  28 struct value;
  29 struct block;
  30 struct breakpoint_object;
  31 struct get_number_or_range_state;
  32 struct thread_info;
  33 struct bpstats;
  34 struct bp_location;
  35
  36 /* This is the maximum number of bytes a breakpoint instruction can
  37    take.  Feel free to increase it.  It's just used in a few places to
  38    size arrays that should be independent of the target
  39    architecture.  */
  40
  41 #define BREAKPOINT_MAX  16
  42 \f
  43
  44 /* Type of breakpoint.  */
  45 /* FIXME In the future, we should fold all other breakpoint-like
  46    things into here.  This includes:
  47
  48    * single-step (for machines where we have to simulate single
  49    stepping) (probably, though perhaps it is better for it to look as
  50    much as possible like a single-step to wait_for_inferior).  */
  51
  52 enum bptype
  53   {
  54     bp_none = 0,                /* Eventpoint has been deleted */
  55     bp_breakpoint,              /* Normal breakpoint */
  56     bp_hardware_breakpoint,     /* Hardware assisted breakpoint */
  57     bp_until,                   /* used by until command */
  58     bp_finish,                  /* used by finish command */
  59     bp_watchpoint,              /* Watchpoint */
  60     bp_hardware_watchpoint,     /* Hardware assisted watchpoint */
  61     bp_read_watchpoint,         /* read watchpoint, (hardware assisted) */
  62     bp_access_watchpoint,       /* access watchpoint, (hardware assisted) */
  63     bp_longjmp,                 /* secret breakpoint to find longjmp() */
  64     bp_longjmp_resume,          /* secret breakpoint to escape longjmp() */
  65
  66     /* An internal breakpoint that is installed on the unwinder's
  67        debug hook.  */
  68     bp_exception,
  69     /* An internal breakpoint that is set at the point where an
  70        exception will land.  */
  71     bp_exception_resume,
  72
  73     /* Used by wait_for_inferior for stepping over subroutine calls,
  74        and for skipping prologues.  */
  75     bp_step_resume,
  76
  77     /* Used by wait_for_inferior for stepping over signal
  78        handlers.  */
  79     bp_hp_step_resume,
  80
  81     /* Used to detect when a watchpoint expression has gone out of
  82        scope.  These breakpoints are usually not visible to the user.
  83
  84        This breakpoint has some interesting properties:
  85
  86        1) There's always a 1:1 mapping between watchpoints
  87        on local variables and watchpoint_scope breakpoints.
  88
  89        2) It automatically deletes itself and the watchpoint it's
  90        associated with when hit.
  91
  92        3) It can never be disabled.  */
  93     bp_watchpoint_scope,
  94
  95     /* The breakpoint at the end of a call dummy.  */
  96     /* FIXME: What if the function we are calling longjmp()s out of
  97        the call, or the user gets out with the "return" command?  We
  98        currently have no way of cleaning up the breakpoint in these
  99        (obscure) situations.  (Probably can solve this by noticing
 100        longjmp, "return", etc., it's similar to noticing when a
 101        watchpoint on a local variable goes out of scope (with hardware
 102        support for watchpoints)).  */
 103     bp_call_dummy,
 104
 105     /* A breakpoint set on std::terminate, that is used to catch
 106        otherwise uncaught exceptions thrown during an inferior call.  */
 107     bp_std_terminate,
 108
 109     /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
 110        code in the inferior to run when significant events occur in the
 111        dynamic linker (for example a library is loaded or unloaded).
 112
 113        By placing a breakpoint in this magic code GDB will get control
 114        when these significant events occur.  GDB can then re-examine
 115        the dynamic linker's data structures to discover any newly loaded
 116        dynamic libraries.  */
 117     bp_shlib_event,
 118
 119     /* Some multi-threaded systems can arrange for a location in the
 120        inferior to be executed when certain thread-related events occur
 121        (such as thread creation or thread death).
 122
 123        By placing a breakpoint at one of these locations, GDB will get
 124        control when these events occur.  GDB can then update its thread
 125        lists etc.  */
 126
 127     bp_thread_event,
 128
 129     /* On the same principal, an overlay manager can arrange to call a
 130        magic location in the inferior whenever there is an interesting
 131        change in overlay status.  GDB can update its overlay tables
 132        and fiddle with breakpoints in overlays when this breakpoint
 133        is hit.  */
 134
 135     bp_overlay_event,
 136
 137     /* Master copies of longjmp breakpoints.  These are always installed
 138        as soon as an objfile containing longjmp is loaded, but they are
 139        always disabled.  While necessary, temporary clones of bp_longjmp
 140        type will be created and enabled.  */
 141
 142     bp_longjmp_master,
 143
 144     /* Master copies of std::terminate breakpoints.  */
 145     bp_std_terminate_master,
 146
 147     /* Like bp_longjmp_master, but for exceptions.  */
 148     bp_exception_master,
 149
 150     bp_catchpoint,
 151
 152     bp_tracepoint,
 153     bp_fast_tracepoint,
 154     bp_static_tracepoint,
 155
 156     /* Event for JIT compiled code generation or deletion.  */
 157     bp_jit_event,
 158
 159     /* Breakpoint is placed at the STT_GNU_IFUNC resolver.  When hit GDB
 160        inserts new bp_gnu_ifunc_resolver_return at the caller.
 161        bp_gnu_ifunc_resolver is still being kept here as a different thread
 162        may still hit it before bp_gnu_ifunc_resolver_return is hit by the
 163        original thread.  */
 164     bp_gnu_ifunc_resolver,
 165
 166     /* On its hit GDB now know the resolved address of the target
 167        STT_GNU_IFUNC function.  Associated bp_gnu_ifunc_resolver can be
 168        deleted now and the breakpoint moved to the target function entry
 169        point.  */
 170     bp_gnu_ifunc_resolver_return,
 171   };
 172
 173 /* States of enablement of breakpoint.  */
 174
 175 enum enable_state
 176   {
 177     bp_disabled,         /* The eventpoint is inactive, and cannot
 178                             trigger.  */
 179     bp_enabled,          /* The eventpoint is active, and can
 180                             trigger.  */
 181     bp_call_disabled,    /* The eventpoint has been disabled while a
 182                             call into the inferior is "in flight",
 183                             because some eventpoints interfere with
 184                             the implementation of a call on some
 185                             targets.  The eventpoint will be
 186                             automatically enabled and reset when the
 187                             call "lands" (either completes, or stops
 188                             at another eventpoint).  */
 189     bp_startup_disabled, /* The eventpoint has been disabled during
 190                             inferior startup.  This is necessary on
 191                             some targets where the main executable
 192                             will get relocated during startup, making
 193                             breakpoint addresses invalid.  The
 194                             eventpoint will be automatically enabled
 195                             and reset once inferior startup is
 196                             complete.  */
 197     bp_permanent         /* There is a breakpoint instruction
 198                             hard-wired into the target's code.  Don't
 199                             try to write another breakpoint
 200                             instruction on top of it, or restore its
 201                             value.  Step over it using the
 202                             architecture's SKIP_INSN macro.  */
 203   };
 204
 205
 206 /* Disposition of breakpoint.  Ie: what to do after hitting it.  */
 207
 208 enum bpdisp
 209   {
 210     disp_del,                   /* Delete it */
 211     disp_del_at_next_stop,      /* Delete at next stop,
 212                                    whether hit or not */
 213     disp_disable,               /* Disable it */
 214     disp_donttouch              /* Leave it alone */
 215   };
 216
 217 enum target_hw_bp_type
 218   {
 219     hw_write   = 0,             /* Common  HW watchpoint */
 220     hw_read    = 1,             /* Read    HW watchpoint */
 221     hw_access  = 2,             /* Access  HW watchpoint */
 222     hw_execute = 3              /* Execute HW breakpoint */
 223   };
 224
 225
 226 /* Information used by targets to insert and remove breakpoints.  */
 227
 228 struct bp_target_info
 229 {
 230   /* Address space at which the breakpoint was placed.  */
 231   struct address_space *placed_address_space;
 232
 233   /* Address at which the breakpoint was placed.  This is normally the
 234      same as ADDRESS from the bp_location, except when adjustment
 235      happens in gdbarch_breakpoint_from_pc.  The most common form of
 236      adjustment is stripping an alternate ISA marker from the PC which
 237      is used to determine the type of breakpoint to insert.  */
 238   CORE_ADDR placed_address;
 239
 240   /* If this is a ranged breakpoint, then this field contains the
 241      length of the range that will be watched for execution.  */
 242   int length;
 243
 244   /* If the breakpoint lives in memory and reading that memory would
 245      give back the breakpoint, instead of the original contents, then
 246      the original contents are cached here.  Only SHADOW_LEN bytes of
 247      this buffer are valid, and only when the breakpoint is inserted.  */
 248   gdb_byte shadow_contents[BREAKPOINT_MAX];
 249
 250   /* The length of the data cached in SHADOW_CONTENTS.  */
 251   int shadow_len;
 252
 253   /* The size of the placed breakpoint, according to
 254      gdbarch_breakpoint_from_pc, when the breakpoint was inserted.
 255      This is generally the same as SHADOW_LEN, unless we did not need
 256      to read from the target to implement the memory breakpoint
 257      (e.g. if a remote stub handled the details).  We may still need
 258      the size to remove the breakpoint safely.  */
 259   int placed_size;
 260 };
 261
 262 /* GDB maintains two types of information about each breakpoint (or
 263    watchpoint, or other related event).  The first type corresponds
 264    to struct breakpoint; this is a relatively high-level structure
 265    which contains the source location(s), stopping conditions, user
 266    commands to execute when the breakpoint is hit, and so forth.
 267
 268    The second type of information corresponds to struct bp_location.
 269    Each breakpoint has one or (eventually) more locations associated
 270    with it, which represent target-specific and machine-specific
 271    mechanisms for stopping the program.  For instance, a watchpoint
 272    expression may require multiple hardware watchpoints in order to
 273    catch all changes in the value of the expression being watched.  */
 274
 275 enum bp_loc_type
 276 {
 277   bp_loc_software_breakpoint,
 278   bp_loc_hardware_breakpoint,
 279   bp_loc_hardware_watchpoint,
 280   bp_loc_other                  /* Miscellaneous...  */
 281 };
 282
 283 /* This structure is a collection of function pointers that, if
 284    available, will be called instead of performing the default action
 285    for this bp_loc_type.  */
 286
 287 struct bp_location_ops
 288 {
 289   /* Destructor.  Releases everything from SELF (but not SELF
 290      itself).  */
 291   void (*dtor) (struct bp_location *self);
 292 };
 293
 294 struct bp_location
 295 {
 296   /* Chain pointer to the next breakpoint location for
 297      the same parent breakpoint.  */
 298   struct bp_location *next;
 299
 300   /* Methods associated with this location.  */
 301   const struct bp_location_ops *ops;
 302
 303   /* The reference count.  */
 304   int refc;
 305
 306   /* Type of this breakpoint location.  */
 307   enum bp_loc_type loc_type;
 308
 309   /* Each breakpoint location must belong to exactly one higher-level
 310      breakpoint.  This pointer is NULL iff this bp_location is no
 311      longer attached to a breakpoint.  For example, when a breakpoint
 312      is deleted, its locations may still be found in the
 313      moribund_locations list, or if we had stopped for it, in
 314      bpstats.  */
 315   struct breakpoint *owner;
 316
 317   /* Conditional.  Break only if this expression's value is nonzero.
 318      Unlike string form of condition, which is associated with
 319      breakpoint, this is associated with location, since if breakpoint
 320      has several locations, the evaluation of expression can be
 321      different for different locations.  Only valid for real
 322      breakpoints; a watchpoint's conditional expression is stored in
 323      the owner breakpoint object.  */
 324   struct expression *cond;
 325
 326   /* This location's address is in an unloaded solib, and so this
 327      location should not be inserted.  It will be automatically
 328      enabled when that solib is loaded.  */
 329   char shlib_disabled;
 330
 331   /* Is this particular location enabled.  */
 332   char enabled;
 333
 334   /* Nonzero if this breakpoint is now inserted.  */
 335   char inserted;
 336
 337   /* Nonzero if this is not the first breakpoint in the list
 338      for the given address.  */
 339   char duplicate;
 340
 341   /* If we someday support real thread-specific breakpoints, then
 342      the breakpoint location will need a thread identifier.  */
 343
 344   /* Data for specific breakpoint types.  These could be a union, but
 345      simplicity is more important than memory usage for breakpoints.  */
 346
 347   /* Architecture associated with this location's address.  May be
 348      different from the breakpoint architecture.  */
 349   struct gdbarch *gdbarch;
 350
 351   /* The program space associated with this breakpoint location
 352      address.  Note that an address space may be represented in more
 353      than one program space (e.g. each uClinux program will be given
 354      its own program space, but there will only be one address space
 355      for all of them), but we must not insert more than one location
 356      at the same address in the same address space.  */
 357   struct program_space *pspace;
 358
 359   /* Note that zero is a perfectly valid code address on some platforms
 360      (for example, the mn10200 (OBSOLETE) and mn10300 simulators).  NULL
 361      is not a special value for this field.  Valid for all types except
 362      bp_loc_other.  */
 363   CORE_ADDR address;
 364
 365   /* For hardware watchpoints, the size of the memory region being
 366      watched.  For hardware ranged breakpoints, the size of the
 367      breakpoint range.  */
 368   int length;
 369
 370   /* Type of hardware watchpoint.  */
 371   enum target_hw_bp_type watchpoint_type;
 372
 373   /* For any breakpoint type with an address, this is the section
 374      associated with the address.  Used primarily for overlay
 375      debugging.  */
 376   struct obj_section *section;
 377
 378   /* Address at which breakpoint was requested, either by the user or
 379      by GDB for internal breakpoints.  This will usually be the same
 380      as ``address'' (above) except for cases in which
 381      ADJUST_BREAKPOINT_ADDRESS has computed a different address at
 382      which to place the breakpoint in order to comply with a
 383      processor's architectual constraints.  */
 384   CORE_ADDR requested_address;
 385
 386   char *function_name;
 387
 388   /* Details of the placed breakpoint, when inserted.  */
 389   struct bp_target_info target_info;
 390
 391   /* Similarly, for the breakpoint at an overlay's LMA, if necessary.  */
 392   struct bp_target_info overlay_target_info;
 393
 394   /* In a non-stop mode, it's possible that we delete a breakpoint,
 395      but as we do that, some still running thread hits that breakpoint.
 396      For that reason, we need to keep locations belonging to deleted
 397      breakpoints for a bit, so that don't report unexpected SIGTRAP.
 398      We can't keep such locations forever, so we use a heuristic --
 399      after we process certain number of inferior events since
 400      breakpoint was deleted, we retire all locations of that breakpoint.
 401      This variable keeps a number of events still to go, when
 402      it becomes 0 this location is retired.  */
 403   int events_till_retirement;
 404 };
 405
 406 /* This structure is a collection of function pointers that, if available,
 407    will be called instead of the performing the default action for this
 408    bptype.  */
 409
 410 struct breakpoint_ops
 411 {
 412   /* Destructor.  Releases everything from SELF (but not SELF
 413      itself).  */
 414   void (*dtor) (struct breakpoint *self);
 415
 416   /* Allocate a location for this breakpoint.  */
 417   struct bp_location * (*allocate_location) (struct breakpoint *);
 418
 419   /* Reevaluate a breakpoint.  This is necessary after symbols change
 420      (e.g., an executable or DSO was loaded, or the inferior just
 421      started).  */
 422   void (*re_set) (struct breakpoint *self);
 423
 424   /* Insert the breakpoint or watchpoint or activate the catchpoint.
 425      Return 0 for success, 1 if the breakpoint, watchpoint or
 426      catchpoint type is not supported, -1 for failure.  */
 427   int (*insert_location) (struct bp_location *);
 428
 429   /* Remove the breakpoint/catchpoint that was previously inserted
 430      with the "insert" method above.  Return 0 for success, 1 if the
 431      breakpoint, watchpoint or catchpoint type is not supported,
 432      -1 for failure.  */
 433   int (*remove_location) (struct bp_location *);
 434
 435   /* Return true if it the target has stopped due to hitting
 436      breakpoint location BL.  This function does not check if we
 437      should stop, only if BL explains the stop.  */
 438   int (*breakpoint_hit) (const struct bp_location *bl, struct address_space *,
 439                          CORE_ADDR);
 440
 441   /* Check internal conditions of the breakpoint referred to by BS.
 442      If we should not stop for this breakpoint, set BS->stop to 0.  */
 443   void (*check_status) (struct bpstats *bs);
 444
 445   /* Tell how many hardware resources (debug registers) are needed
 446      for this breakpoint.  If this function is not provided, then
 447      the breakpoint or watchpoint needs one debug register.  */
 448   int (*resources_needed) (const struct bp_location *);
 449
 450   /* Tell whether we can downgrade from a hardware watchpoint to a software
 451      one.  If not, the user will not be able to enable the watchpoint when
 452      there are not enough hardware resources available.  */
 453   int (*works_in_software_mode) (const struct breakpoint *);
 454
 455   /* The normal print routine for this breakpoint, called when we
 456      hit it.  */
 457   enum print_stop_action (*print_it) (struct bpstats *bs);
 458
 459   /* Display information about this breakpoint, for "info
 460      breakpoints".  */
 461   void (*print_one) (struct breakpoint *, struct bp_location **);
 462
 463   /* Display extra information about this breakpoint, below the normal
 464      breakpoint description in "info breakpoints".
 465
 466      In the example below, the "address range" line was printed
 467      by print_one_detail_ranged_breakpoint.
 468
 469      (gdb) info breakpoints
 470      Num     Type           Disp Enb Address    What
 471      2       hw breakpoint  keep y              in main at test-watch.c:70
 472              address range: [0x10000458, 0x100004c7]
 473
 474    */
 475   void (*print_one_detail) (const struct breakpoint *, struct ui_out *);
 476
 477   /* Display information about this breakpoint after setting it
 478      (roughly speaking; this is called from "mention").  */
 479   void (*print_mention) (struct breakpoint *);
 480
 481   /* Print to FP the CLI command that recreates this breakpoint.  */
 482   void (*print_recreate) (struct breakpoint *, struct ui_file *fp);
 483 };
 484
 485 enum watchpoint_triggered
 486 {
 487   /* This watchpoint definitely did not trigger.  */
 488   watch_triggered_no = 0,
 489
 490   /* Some hardware watchpoint triggered, and it might have been this
 491      one, but we do not know which it was.  */
 492   watch_triggered_unknown,
 493
 494   /* This hardware watchpoint definitely did trigger.  */
 495   watch_triggered_yes
 496 };
 497
 498 /* This is used to declare the VEC syscalls_to_be_caught.  */
 499 DEF_VEC_I(int);
 500
 501 typedef struct bp_location *bp_location_p;
 502 DEF_VEC_P(bp_location_p);
 503
 504 /* A reference-counted struct command_line.  This lets multiple
 505    breakpoints share a single command list.  This is an implementation
 506    detail to the breakpoints module.  */
 507 struct counted_command_line;
 508
 509 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
 510    a watchpoint over a memory region.  If this flag is true, GDB will use
 511    only one register per watchpoint, thus assuming that all acesses that
 512    modify a memory location happen at its starting address. */
 513
 514 extern int target_exact_watchpoints;
 515
 516 /* Note that the ->silent field is not currently used by any commands
 517    (though the code is in there if it was to be, and set_raw_breakpoint
 518    does set it to 0).  I implemented it because I thought it would be
 519    useful for a hack I had to put in; I'm going to leave it in because
 520    I can see how there might be times when it would indeed be useful */
 521
 522 /* This is for all kinds of breakpoints.  */
 523
 524 struct breakpoint
 525   {
 526     /* Methods associated with this breakpoint.  */
 527     struct breakpoint_ops *ops;
 528
 529     struct breakpoint *next;
 530     /* Type of breakpoint.  */
 531     enum bptype type;
 532     /* Zero means disabled; remember the info but don't break here.  */
 533     enum enable_state enable_state;
 534     /* What to do with this breakpoint after we hit it.  */
 535     enum bpdisp disposition;
 536     /* Number assigned to distinguish breakpoints.  */
 537     int number;
 538
 539     /* Location(s) associated with this high-level breakpoint.  */
 540     struct bp_location *loc;
 541
 542     /* Line number of this address.  */
 543
 544     int line_number;
 545
 546     /* Source file name of this address.  */
 547
 548     char *source_file;
 549
 550     /* Non-zero means a silent breakpoint (don't print frame info
 551        if we stop here).  */
 552     unsigned char silent;
 553     /* Non-zero means display ADDR_STRING to the user verbatim.  */
 554     unsigned char display_canonical;
 555     /* Number of stops at this breakpoint that should
 556        be continued automatically before really stopping.  */
 557     int ignore_count;
 558     /* Chain of command lines to execute when this breakpoint is
 559        hit.  */
 560     struct counted_command_line *commands;
 561     /* Stack depth (address of frame).  If nonzero, break only if fp
 562        equals this.  */
 563     struct frame_id frame_id;
 564
 565     /* The program space used to set the breakpoint.  */
 566     struct program_space *pspace;
 567
 568     /* String we used to set the breakpoint (malloc'd).  */
 569     char *addr_string;
 570
 571     /* For a ranged breakpoint, the string we used to find
 572        the end of the range (malloc'd).  */
 573     char *addr_string_range_end;
 574
 575     /* Architecture we used to set the breakpoint.  */
 576     struct gdbarch *gdbarch;
 577     /* Language we used to set the breakpoint.  */
 578     enum language language;
 579     /* Input radix we used to set the breakpoint.  */
 580     int input_radix;
 581     /* String form of the breakpoint condition (malloc'd), or NULL if
 582        there is no condition.  */
 583     char *cond_string;
 584     /* String form of exp to use for displaying to the user
 585        (malloc'd), or NULL if none.  */
 586
 587     /* Holds the address of the related watchpoint_scope breakpoint
 588        when using watchpoints on local variables (might the concept of
 589        a related breakpoint be useful elsewhere, if not just call it
 590        the watchpoint_scope breakpoint or something like that.
 591        FIXME).  */
 592     struct breakpoint *related_breakpoint;
 593
 594     /* Thread number for thread-specific breakpoint,
 595        or -1 if don't care.  */
 596     int thread;
 597
 598     /* Ada task number for task-specific breakpoint,
 599        or 0 if don't care.  */
 600     int task;
 601
 602     /* Count of the number of times this breakpoint was taken, dumped
 603        with the info, but not used for anything else.  Useful for
 604        seeing how many times you hit a break prior to the program
 605        aborting, so you can back up to just before the abort.  */
 606     int hit_count;
 607
 608     /* Is breakpoint's condition not yet parsed because we found
 609        no location initially so had no context to parse
 610        the condition in.  */
 611     int condition_not_parsed;
 612
 613     /* Number of times this tracepoint should single-step
 614        and collect additional data.  */
 615     long step_count;
 616
 617     /* Number of times this tracepoint should be hit before
 618        disabling/ending.  */
 619     int pass_count;
 620
 621     /* The number of the tracepoint on the target.  */
 622     int number_on_target;
 623
 624     /* The static tracepoint marker id, if known.  */
 625     char *static_trace_marker_id;
 626
 627     /* LTTng/UST allow more than one marker with the same ID string,
 628        although it unadvised because it confuses tools.  When setting
 629        static tracepoints by marker ID, this will record the index in
 630        the array of markers we found for the given marker ID for which
 631        this static tracepoint corresponds.  When resetting
 632        breakpoints, we will use this index to try to find the same
 633        marker again.  */
 634     int static_trace_marker_id_idx;
 635
 636     /* With a Python scripting enabled GDB, store a reference to the
 637        Python object that has been associated with this breakpoint.
 638        This is always NULL for a GDB that is not script enabled.  It
 639        can sometimes be NULL for enabled GDBs as not all breakpoint
 640        types are tracked by the Python scripting API.  */
 641     struct breakpoint_object *py_bp_object;
 642   };
 643
 644 /* An instance of this type is used to represent a watchpoint.  It
 645    includes a "struct breakpoint" as a kind of base class; users
 646    downcast to "struct breakpoint *" when needed.  */
 647
 648 struct watchpoint
 649 {
 650   /* The base class.  */
 651   struct breakpoint base;
 652
 653   /* String form of exp to use for displaying to the user (malloc'd),
 654      or NULL if none.  */
 655   char *exp_string;
 656   /* String form to use for reparsing of EXP (malloc'd) or NULL.  */
 657   char *exp_string_reparse;
 658
 659   /* The expression we are watching, or NULL if not a watchpoint.  */
 660   struct expression *exp;
 661   /* The largest block within which it is valid, or NULL if it is
 662      valid anywhere (e.g. consists just of global symbols).  */
 663   struct block *exp_valid_block;
 664   /* The conditional expression if any.  */
 665   struct expression *cond_exp;
 666   /* The largest block within which it is valid, or NULL if it is
 667      valid anywhere (e.g. consists just of global symbols).  */
 668   struct block *cond_exp_valid_block;
 669   /* Value of the watchpoint the last time we checked it, or NULL when
 670      we do not know the value yet or the value was not readable.  VAL
 671      is never lazy.  */
 672   struct value *val;
 673   /* Nonzero if VAL is valid.  If VAL_VALID is set but VAL is NULL,
 674      then an error occurred reading the value.  */
 675   int val_valid;
 676
 677   /* Holds the frame address which identifies the frame this
 678      watchpoint should be evaluated in, or `null' if the watchpoint
 679      should be evaluated on the outermost frame.  */
 680   struct frame_id watchpoint_frame;
 681
 682   /* Holds the thread which identifies the frame this watchpoint
 683      should be considered in scope for, or `null_ptid' if the
 684      watchpoint should be evaluated in all threads.  */
 685   ptid_t watchpoint_thread;
 686
 687   /* For hardware watchpoints, the triggered status according to the
 688      hardware.  */
 689   enum watchpoint_triggered watchpoint_triggered;
 690
 691   /* Whether this watchpoint is exact (see
 692      target_exact_watchpoints).  */
 693   int exact;
 694
 695   /* The mask address for a masked hardware watchpoint.  */
 696   CORE_ADDR hw_wp_mask;
 697 };
 698
 699 /* Returns true if BPT is really a watchpoint.  */
 700
 701 extern int is_watchpoint (const struct breakpoint *bpt);
 702
 703 typedef struct breakpoint *breakpoint_p;
 704 DEF_VEC_P(breakpoint_p);
 705 \f
 706 /* The following stuff is an abstract data type "bpstat" ("breakpoint
 707    status").  This provides the ability to determine whether we have
 708    stopped at a breakpoint, and what we should do about it.  */
 709
 710 typedef struct bpstats *bpstat;
 711
 712 /* Clears a chain of bpstat, freeing storage
 713    of each.  */
 714 extern void bpstat_clear (bpstat *);
 715
 716 /* Return a copy of a bpstat.  Like "bs1 = bs2" but all storage that
 717    is part of the bpstat is copied as well.  */
 718 extern bpstat bpstat_copy (bpstat);
 719
 720 extern bpstat bpstat_stop_status (struct address_space *aspace,
 721                                   CORE_ADDR pc, ptid_t ptid);
 722 \f
 723 /* This bpstat_what stuff tells wait_for_inferior what to do with a
 724    breakpoint (a challenging task).
 725
 726    The enum values order defines priority-like order of the actions.
 727    Once you've decided that some action is appropriate, you'll never
 728    go back and decide something of a lower priority is better.  Each
 729    of these actions is mutually exclusive with the others.  That
 730    means, that if you find yourself adding a new action class here and
 731    wanting to tell GDB that you have two simultaneous actions to
 732    handle, something is wrong, and you probably don't actually need a
 733    new action type.
 734
 735    Note that a step resume breakpoint overrides another breakpoint of
 736    signal handling (see comment in wait_for_inferior at where we set
 737    the step_resume breakpoint).  */
 738
 739 enum bpstat_what_main_action
 740   {
 741     /* Perform various other tests; that is, this bpstat does not
 742        say to perform any action (e.g. failed watchpoint and nothing
 743        else).  */
 744     BPSTAT_WHAT_KEEP_CHECKING,
 745
 746     /* Remove breakpoints, single step once, then put them back in and
 747        go back to what we were doing.  It's possible that this should
 748        be removed from the main_action and put into a separate field,
 749        to more cleanly handle
 750        BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE.  */
 751     BPSTAT_WHAT_SINGLE,
 752
 753     /* Set longjmp_resume breakpoint, remove all other breakpoints,
 754        and continue.  The "remove all other breakpoints" part is
 755        required if we are also stepping over another breakpoint as
 756        well as doing the longjmp handling.  */
 757     BPSTAT_WHAT_SET_LONGJMP_RESUME,
 758
 759     /* Clear longjmp_resume breakpoint, then handle as
 760        BPSTAT_WHAT_KEEP_CHECKING.  */
 761     BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
 762
 763     /* Clear step resume breakpoint, and keep checking.  */
 764     BPSTAT_WHAT_STEP_RESUME,
 765
 766     /* Rather than distinguish between noisy and silent stops here, it
 767        might be cleaner to have bpstat_print make that decision (also
 768        taking into account stop_print_frame and source_only).  But the
 769        implications are a bit scary (interaction with auto-displays,
 770        etc.), so I won't try it.  */
 771
 772     /* Stop silently.  */
 773     BPSTAT_WHAT_STOP_SILENT,
 774
 775     /* Stop and print.  */
 776     BPSTAT_WHAT_STOP_NOISY,
 777
 778     /* Clear step resume breakpoint, and keep checking.  High-priority
 779        step-resume breakpoints are used when even if there's a user
 780        breakpoint at the current PC when we set the step-resume
 781        breakpoint, we don't want to re-handle any breakpoint other
 782        than the step-resume when it's hit; instead we want to move
 783        past the breakpoint.  This is used in the case of skipping
 784        signal handlers.  */
 785     BPSTAT_WHAT_HP_STEP_RESUME,
 786   };
 787
 788 /* An enum indicating the kind of "stack dummy" stop.  This is a bit
 789    of a misnomer because only one kind of truly a stack dummy.  */
 790 enum stop_stack_kind
 791   {
 792     /* We didn't stop at a stack dummy breakpoint.  */
 793     STOP_NONE = 0,
 794
 795     /* Stopped at a stack dummy.  */
 796     STOP_STACK_DUMMY,
 797
 798     /* Stopped at std::terminate.  */
 799     STOP_STD_TERMINATE
 800   };
 801
 802 struct bpstat_what
 803   {
 804     enum bpstat_what_main_action main_action;
 805
 806     /* Did we hit a call dummy breakpoint?  This only goes with a
 807        main_action of BPSTAT_WHAT_STOP_SILENT or
 808        BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
 809        dummy without popping the frame is not a useful one).  */
 810     enum stop_stack_kind call_dummy;
 811
 812     /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
 813        BPSTAT_WHAT_CLEAR_LONGJMP_RESUME.  True if we are handling a
 814        longjmp, false if we are handling an exception.  */
 815     int is_longjmp;
 816   };
 817
 818 /* The possible return values for print_bpstat, print_it_normal,
 819    print_it_done, print_it_noop.  */
 820 enum print_stop_action
 821   {
 822     /* We printed nothing or we need to do some more analysis.  */
 823     PRINT_UNKNOWN = -1,
 824
 825     /* We printed something, and we *do* desire that something to be
 826        followed by a location.  */
 827     PRINT_SRC_AND_LOC,
 828
 829     /* We printed something, and we do *not* desire that something to
 830        be followed by a location.  */
 831     PRINT_SRC_ONLY,
 832
 833     /* We already printed all we needed to print, don't print anything
 834        else.  */
 835     PRINT_NOTHING
 836   };
 837
 838 /* Tell what to do about this bpstat.  */
 839 struct bpstat_what bpstat_what (bpstat);
 840 \f
 841 /* Find the bpstat associated with a breakpoint.  NULL otherwise.  */
 842 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
 843
 844 /* Nonzero if a signal that we got in wait() was due to circumstances
 845    explained by the BS.  */
 846 /* Currently that is true if we have hit a breakpoint, or if there is
 847    a watchpoint enabled.  */
 848 #define bpstat_explains_signal(bs) ((bs) != NULL)
 849
 850 /* Nonzero is this bpstat causes a stop.  */
 851 extern int bpstat_causes_stop (bpstat);
 852
 853 /* Nonzero if we should step constantly (e.g. watchpoints on machines
 854    without hardware support).  This isn't related to a specific bpstat,
 855    just to things like whether watchpoints are set.  */
 856 extern int bpstat_should_step (void);
 857
 858 /* Print a message indicating what happened.  Returns nonzero to
 859    say that only the source line should be printed after this (zero
 860    return means print the frame as well as the source line).  */
 861 extern enum print_stop_action bpstat_print (bpstat);
 862
 863 /* Put in *NUM the breakpoint number of the first breakpoint we are
 864    stopped at.  *BSP upon return is a bpstat which points to the
 865    remaining breakpoints stopped at (but which is not guaranteed to be
 866    good for anything but further calls to bpstat_num).
 867
 868    Return 0 if passed a bpstat which does not indicate any breakpoints.
 869    Return -1 if stopped at a breakpoint that has been deleted since
 870    we set it.
 871    Return 1 otherwise.  */
 872 extern int bpstat_num (bpstat *, int *);
 873
 874 /* Perform actions associated with the stopped inferior.  Actually, we
 875    just use this for breakpoint commands.  Perhaps other actions will
 876    go here later, but this is executed at a late time (from the
 877    command loop).  */
 878 extern void bpstat_do_actions (void);
 879
 880 /* Modify BS so that the actions will not be performed.  */
 881 extern void bpstat_clear_actions (bpstat);
 882
 883 /* Implementation:  */
 884
 885 /* Values used to tell the printing routine how to behave for this
 886    bpstat.  */
 887 enum bp_print_how
 888   {
 889     /* This is used when we want to do a normal printing of the reason
 890        for stopping.  The output will depend on the type of eventpoint
 891        we are dealing with.  This is the default value, most commonly
 892        used.  */
 893     print_it_normal,
 894     /* This is used when nothing should be printed for this bpstat
 895        entry.  */
 896     print_it_noop,
 897     /* This is used when everything which needs to be printed has
 898        already been printed.  But we still want to print the frame.  */
 899     print_it_done
 900   };
 901
 902 struct bpstats
 903   {
 904     /* Linked list because there can be more than one breakpoint at
 905        the same place, and a bpstat reflects the fact that all have
 906        been hit.  */
 907     bpstat next;
 908
 909     /* Location that caused the stop.  Locations are refcounted, so
 910        this will never be NULL.  Note that this location may end up
 911        detached from a breakpoint, but that does not necessary mean
 912        that the struct breakpoint is gone.  E.g., consider a
 913        watchpoint with a condition that involves an inferior function
 914        call.  Watchpoint locations are recreated often (on resumes,
 915        hence on infcalls too).  Between creating the bpstat and after
 916        evaluating the watchpoint condition, this location may hence
 917        end up detached from its original owner watchpoint, even though
 918        the watchpoint is still listed.  If it's condition evaluates as
 919        true, we still want this location to cause a stop, and we will
 920        still need to know which watchpoint it was originally attached.
 921        What this means is that we should not (in most cases) follow
 922        the `bpstat->bp_location->owner' link, but instead use the
 923        `breakpoint_at' field below.  */
 924     struct bp_location *bp_location_at;
 925
 926     /* Breakpoint that caused the stop.  This is nullified if the
 927        breakpoint ends up being deleted.  See comments on
 928        `bp_location_at' above for why do we need this field instead of
 929        following the location's owner.  */
 930     struct breakpoint *breakpoint_at;
 931
 932     /* The associated command list.  */
 933     struct counted_command_line *commands;
 934
 935     /* Commands left to be done.  This points somewhere in
 936        base_command.  */
 937     struct command_line *commands_left;
 938
 939     /* Old value associated with a watchpoint.  */
 940     struct value *old_val;
 941
 942     /* Nonzero if this breakpoint tells us to print the frame.  */
 943     char print;
 944
 945     /* Nonzero if this breakpoint tells us to stop.  */
 946     char stop;
 947
 948     /* Tell bpstat_print and print_bp_stop_message how to print stuff
 949        associated with this element of the bpstat chain.  */
 950     enum bp_print_how print_it;
 951   };
 952
 953 enum inf_context
 954   {
 955     inf_starting,
 956     inf_running,
 957     inf_exited,
 958     inf_execd
 959   };
 960
 961 /* The possible return values for breakpoint_here_p.
 962    We guarantee that zero always means "no breakpoint here".  */
 963 enum breakpoint_here
 964   {
 965     no_breakpoint_here = 0,
 966     ordinary_breakpoint_here,
 967     permanent_breakpoint_here
 968   };
 969 \f
 970
 971 /* Prototypes for breakpoint-related functions.  */
 972
 973 extern enum breakpoint_here breakpoint_here_p (struct address_space *,
 974                                                CORE_ADDR);
 975
 976 extern int moribund_breakpoint_here_p (struct address_space *, CORE_ADDR);
 977
 978 extern int breakpoint_inserted_here_p (struct address_space *, CORE_ADDR);
 979
 980 extern int regular_breakpoint_inserted_here_p (struct address_space *,
 981                                                CORE_ADDR);
 982
 983 extern int software_breakpoint_inserted_here_p (struct address_space *,
 984                                                 CORE_ADDR);
 985
 986 /* Returns true if there's a hardware watchpoint or access watchpoint
 987    inserted in the range defined by ADDR and LEN.  */
 988 extern int hardware_watchpoint_inserted_in_range (struct address_space *,
 989                                                   CORE_ADDR addr,
 990                                                   ULONGEST len);
 991
 992 extern int breakpoint_thread_match (struct address_space *,
 993                                     CORE_ADDR, ptid_t);
 994
 995 extern void until_break_command (char *, int, int);
 996
 997 /* Initialize a struct bp_location.  */
 998
 999 extern void init_bp_location (struct bp_location *loc,
1000                               const struct bp_location_ops *ops,
1001                               struct breakpoint *owner);
1002
1003 extern void update_breakpoint_locations (struct breakpoint *b,
1004                                          struct symtabs_and_lines sals,
1005                                          struct symtabs_and_lines sals_end);
1006
1007 extern void breakpoint_re_set (void);
1008
1009 extern void breakpoint_re_set_thread (struct breakpoint *);
1010
1011 extern struct breakpoint *set_momentary_breakpoint
1012   (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype);
1013
1014 extern struct breakpoint *set_momentary_breakpoint_at_pc
1015   (struct gdbarch *, CORE_ADDR pc, enum bptype type);
1016
1017 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt);
1018
1019 extern void set_ignore_count (int, int, int);
1020
1021 extern void set_default_breakpoint (int, struct program_space *,
1022                                     CORE_ADDR, struct symtab *, int);
1023
1024 extern void breakpoint_init_inferior (enum inf_context);
1025
1026 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
1027
1028 extern void delete_breakpoint (struct breakpoint *);
1029
1030 extern void breakpoint_auto_delete (bpstat);
1031
1032 /* Return the chain of command lines to execute when this breakpoint
1033    is hit.  */
1034 extern struct command_line *breakpoint_commands (struct breakpoint *b);
1035
1036 /* Return a string image of DISP.  The string is static, and thus should
1037    NOT be deallocated after use.  */
1038 const char *bpdisp_text (enum bpdisp disp);
1039
1040 extern void break_command (char *, int);
1041
1042 extern void hbreak_command_wrapper (char *, int);
1043 extern void thbreak_command_wrapper (char *, int);
1044 extern void rbreak_command_wrapper (char *, int);
1045 extern void watch_command_wrapper (char *, int, int);
1046 extern void awatch_command_wrapper (char *, int, int);
1047 extern void rwatch_command_wrapper (char *, int, int);
1048 extern void tbreak_command (char *, int);
1049
1050 extern struct breakpoint_ops bkpt_breakpoint_ops;
1051
1052 extern void initialize_breakpoint_ops (void);
1053
1054 /* Arguments to pass as context to some catch command handlers.  */
1055 #define CATCH_PERMANENT ((void *) (uintptr_t) 0)
1056 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
1057
1058 /* Like add_cmd, but add the command to both the "catch" and "tcatch"
1059    lists, and pass some additional user data to the command
1060    function.  */
1061
1062 extern void
1063   add_catch_command (char *name, char *docstring,
1064                      void (*sfunc) (char *args, int from_tty,
1065                                     struct cmd_list_element *command),
1066                      char **(*completer) (struct cmd_list_element *cmd,
1067                                           char *text, char *word),
1068                      void *user_data_catch,
1069                      void *user_data_tcatch);
1070
1071 /* Initialize a breakpoint struct for Ada exception catchpoints.  */
1072
1073 extern void
1074   init_ada_exception_breakpoint (struct breakpoint *b,
1075                                  struct gdbarch *gdbarch,
1076                                  struct symtab_and_line sal,
1077                                  char *addr_string,
1078                                  struct breakpoint_ops *ops,
1079                                  int tempflag,
1080                                  int from_tty);
1081
1082 /* Add breakpoint B on the breakpoint list, and notify the user, the
1083    target and breakpoint_created observers of its existence.  If
1084    INTERNAL is non-zero, the breakpoint number will be allocated from
1085    the internal breakpoint count.  */
1086
1087 extern void install_breakpoint (int internal, struct breakpoint *b);
1088
1089 extern int create_breakpoint (struct gdbarch *gdbarch, char *arg,
1090                               char *cond_string, int thread,
1091                               int parse_condition_and_thread,
1092                               int tempflag, enum bptype wanted_type,
1093                               int ignore_count,
1094                               enum auto_boolean pending_break_support,
1095                               struct breakpoint_ops *ops,
1096                               int from_tty,
1097                               int enabled,
1098                               int internal);
1099
1100 extern void insert_breakpoints (void);
1101
1102 extern int remove_breakpoints (void);
1103
1104 extern int remove_breakpoints_pid (int pid);
1105
1106 /* This function can be used to physically insert eventpoints from the
1107    specified traced inferior process, without modifying the breakpoint
1108    package's state.  This can be useful for those targets which
1109    support following the processes of a fork() or vfork() system call,
1110    when both of the resulting two processes are to be followed.  */
1111 extern int reattach_breakpoints (int);
1112
1113 /* This function can be used to update the breakpoint package's state
1114    after an exec() system call has been executed.
1115
1116    This function causes the following:
1117
1118    - All eventpoints are marked "not inserted".
1119    - All eventpoints with a symbolic address are reset such that
1120    the symbolic address must be reevaluated before the eventpoints
1121    can be reinserted.
1122    - The solib breakpoints are explicitly removed from the breakpoint
1123    list.
1124    - A step-resume breakpoint, if any, is explicitly removed from the
1125    breakpoint list.
1126    - All eventpoints without a symbolic address are removed from the
1127    breakpoint list.  */
1128 extern void update_breakpoints_after_exec (void);
1129
1130 /* This function can be used to physically remove hardware breakpoints
1131    and watchpoints from the specified traced inferior process, without
1132    modifying the breakpoint package's state.  This can be useful for
1133    those targets which support following the processes of a fork() or
1134    vfork() system call, when one of the resulting two processes is to
1135    be detached and allowed to run free.
1136
1137    It is an error to use this function on the process whose id is
1138    inferior_ptid.  */
1139 extern int detach_breakpoints (int);
1140
1141 /* This function is called when program space PSPACE is about to be
1142    deleted.  It takes care of updating breakpoints to not reference
1143    this PSPACE anymore.  */
1144 extern void breakpoint_program_space_exit (struct program_space *pspace);
1145
1146 extern void set_longjmp_breakpoint (struct thread_info *tp,
1147                                     struct frame_id frame);
1148 extern void delete_longjmp_breakpoint (int thread);
1149
1150 extern void enable_overlay_breakpoints (void);
1151 extern void disable_overlay_breakpoints (void);
1152
1153 extern void set_std_terminate_breakpoint (void);
1154 extern void delete_std_terminate_breakpoint (void);
1155
1156 /* These functions respectively disable or reenable all currently
1157    enabled watchpoints.  When disabled, the watchpoints are marked
1158    call_disabled.  When re-enabled, they are marked enabled.
1159
1160    The intended client of these functions is call_function_by_hand.
1161
1162    The inferior must be stopped, and all breakpoints removed, when
1163    these functions are used.
1164
1165    The need for these functions is that on some targets (e.g., HP-UX),
1166    gdb is unable to unwind through the dummy frame that is pushed as
1167    part of the implementation of a call command.  Watchpoints can
1168    cause the inferior to stop in places where this frame is visible,
1169    and that can cause execution control to become very confused.
1170
1171    Note that if a user sets breakpoints in an interactively called
1172    function, the call_disabled watchpoints will have been re-enabled
1173    when the first such breakpoint is reached.  However, on targets
1174    that are unable to unwind through the call dummy frame, watches
1175    of stack-based storage may then be deleted, because gdb will
1176    believe that their watched storage is out of scope.  (Sigh.) */
1177 extern void disable_watchpoints_before_interactive_call_start (void);
1178
1179 extern void enable_watchpoints_after_interactive_call_stop (void);
1180
1181 /* These functions disable and re-enable all breakpoints during
1182    inferior startup.  They are intended to be called from solib
1183    code where necessary.  This is needed on platforms where the
1184    main executable is relocated at some point during startup
1185    processing, making breakpoint addresses invalid.
1186
1187    If additional breakpoints are created after the routine
1188    disable_breakpoints_before_startup but before the routine
1189    enable_breakpoints_after_startup was called, they will also
1190    be marked as disabled.  */
1191 extern void disable_breakpoints_before_startup (void);
1192 extern void enable_breakpoints_after_startup (void);
1193
1194 /* For script interpreters that need to define breakpoint commands
1195    after they've already read the commands into a struct
1196    command_line.  */
1197 extern enum command_control_type commands_from_control_command
1198   (char *arg, struct command_line *cmd);
1199
1200 extern void clear_breakpoint_hit_counts (void);
1201
1202 extern struct breakpoint *get_breakpoint (int num);
1203
1204 /* The following are for displays, which aren't really breakpoints,
1205    but here is as good a place as any for them.  */
1206
1207 extern void disable_current_display (void);
1208
1209 extern void do_displays (void);
1210
1211 extern void disable_display (int);
1212
1213 extern void clear_displays (void);
1214
1215 extern void disable_breakpoint (struct breakpoint *);
1216
1217 extern void enable_breakpoint (struct breakpoint *);
1218
1219 extern void breakpoint_set_commands (struct breakpoint *b,
1220                                      struct command_line *commands);
1221
1222 extern void breakpoint_set_silent (struct breakpoint *b, int silent);
1223
1224 extern void breakpoint_set_thread (struct breakpoint *b, int thread);
1225
1226 extern void breakpoint_set_task (struct breakpoint *b, int task);
1227
1228 /* Clear the "inserted" flag in all breakpoints.  */
1229 extern void mark_breakpoints_out (void);
1230
1231 extern void make_breakpoint_permanent (struct breakpoint *);
1232
1233 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *,
1234                                                        CORE_ADDR);
1235
1236 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *,
1237                                                          CORE_ADDR);
1238
1239 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *,
1240                                                           CORE_ADDR);
1241
1242 extern void remove_jit_event_breakpoints (void);
1243
1244 extern void remove_solib_event_breakpoints (void);
1245
1246 extern void remove_thread_event_breakpoints (void);
1247
1248 extern void disable_breakpoints_in_shlibs (void);
1249
1250 /* This function returns TRUE if ep is a catchpoint.  */
1251 extern int ep_is_catchpoint (struct breakpoint *);
1252
1253 /* Enable breakpoints and delete when hit.  Called with ARG == NULL
1254    deletes all breakpoints.  */
1255 extern void delete_command (char *arg, int from_tty);
1256
1257 /* Manage a software single step breakpoint (or two).  Insert may be
1258    called twice before remove is called.  */
1259 extern void insert_single_step_breakpoint (struct gdbarch *,
1260                                            struct address_space *,
1261                                            CORE_ADDR);
1262 extern int single_step_breakpoints_inserted (void);
1263 extern void remove_single_step_breakpoints (void);
1264 extern void cancel_single_step_breakpoints (void);
1265
1266 /* Manage manual breakpoints, separate from the normal chain of
1267    breakpoints.  These functions are used in murky target-specific
1268    ways.  Please do not add more uses!  */
1269 extern void *deprecated_insert_raw_breakpoint (struct gdbarch *,
1270                                                struct address_space *,
1271                                                CORE_ADDR);
1272 extern int deprecated_remove_raw_breakpoint (struct gdbarch *, void *);
1273
1274 /* Check if any hardware watchpoints have triggered, according to the
1275    target.  */
1276 int watchpoints_triggered (struct target_waitstatus *);
1277
1278 /* Update BUF, which is LEN bytes read from the target address MEMADDR,
1279    by replacing any memory breakpoints with their shadowed contents.  */
1280 void breakpoint_restore_shadows (gdb_byte *buf, ULONGEST memaddr,
1281                                  LONGEST len);
1282
1283 extern int breakpoints_always_inserted_mode (void);
1284
1285 /* Called each time new event from target is processed.
1286    Retires previously deleted breakpoint locations that
1287    in our opinion won't ever trigger.  */
1288 extern void breakpoint_retire_moribund (void);
1289
1290 /* Set break condition of breakpoint B to EXP.  */
1291 extern void set_breakpoint_condition (struct breakpoint *b, char *exp,
1292                                       int from_tty);
1293
1294 /* Checks if we are catching syscalls or not.
1295    Returns 0 if not, greater than 0 if we are.  */
1296 extern int catch_syscall_enabled (void);
1297
1298 /* Checks if we are catching syscalls with the specific
1299    syscall_number.  Used for "filtering" the catchpoints.
1300    Returns 0 if not, greater than 0 if we are.  */
1301 extern int catching_syscall_number (int syscall_number);
1302
1303 /* Return a tracepoint with the given number if found.  */
1304 extern struct breakpoint *get_tracepoint (int num);
1305
1306 extern struct breakpoint *get_tracepoint_by_number_on_target (int num);
1307
1308 /* Find a tracepoint by parsing a number in the supplied string.  */
1309 extern struct breakpoint *
1310      get_tracepoint_by_number (char **arg,
1311                                struct get_number_or_range_state *state,
1312                                int optional_p);
1313
1314 /* Return a vector of all tracepoints currently defined.  The vector
1315    is newly allocated; the caller should free when done with it.  */
1316 extern VEC(breakpoint_p) *all_tracepoints (void);
1317
1318 extern int is_tracepoint (const struct breakpoint *b);
1319
1320 /* Return a vector of all static tracepoints defined at ADDR.  The
1321    vector is newly allocated; the caller should free when done with
1322    it.  */
1323 extern VEC(breakpoint_p) *static_tracepoints_here (CORE_ADDR addr);
1324
1325 /* Function that can be passed to read_command_line to validate
1326    that each command is suitable for tracepoint command list.  */
1327 extern void check_tracepoint_command (char *line, void *closure);
1328
1329 /* Call at the start and end of an "rbreak" command to register
1330    breakpoint numbers for a later "commands" command.  */
1331 extern void start_rbreak_breakpoints (void);
1332 extern void end_rbreak_breakpoints (void);
1333
1334 /* Breakpoint iterator function.
1335
1336    Calls a callback function once for each breakpoint, so long as the
1337    callback function returns false.  If the callback function returns
1338    true, the iteration will end and the current breakpoint will be
1339    returned.  This can be useful for implementing a search for a
1340    breakpoint with arbitrary attributes, or for applying an operation
1341    to every breakpoint.  */
1342 extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *,
1343                                                              void *), void *);
1344
1345 extern int user_breakpoint_p (struct breakpoint *);
1346
1347 #endif /* !defined (BREAKPOINT_H) */