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