gdb/breakpoint.h

   1 /* Data structures associated with breakpoints in GDB.
   2    Copyright (C) 1992-2022 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #if !defined (BREAKPOINT_H)
  20 #define BREAKPOINT_H 1
  21
  22 #include "frame.h"
  23 #include "value.h"
  24 #include "ax.h"
  25 #include "command.h"
  26 #include "gdbsupport/break-common.h"
  27 #include "probe.h"
  28 #include "location.h"
  29 #include <vector>
  30 #include "gdbsupport/array-view.h"
  31 #include "gdbsupport/filtered-iterator.h"
  32 #include "gdbsupport/function-view.h"
  33 #include "gdbsupport/next-iterator.h"
  34 #include "gdbsupport/iterator-range.h"
  35 #include "gdbsupport/refcounted-object.h"
  36 #include "gdbsupport/safe-iterator.h"
  37 #include "cli/cli-script.h"
  38
  39 struct block;
  40 struct gdbpy_breakpoint_object;
  41 struct gdbscm_breakpoint_object;
  42 struct number_or_range_parser;
  43 struct thread_info;
  44 struct bpstat;
  45 struct bp_location;
  46 struct linespec_result;
  47 struct linespec_sals;
  48 struct inferior;
  49
  50 /* Enum for exception-handling support in 'catch throw', 'catch rethrow',
  51    'catch catch' and the MI equivalent.  */
  52
  53 enum exception_event_kind
  54 {
  55   EX_EVENT_THROW,
  56   EX_EVENT_RETHROW,
  57   EX_EVENT_CATCH
  58 };
  59
  60 /* Why are we removing the breakpoint from the target?  */
  61
  62 enum remove_bp_reason
  63 {
  64   /* A regular remove.  Remove the breakpoint and forget everything
  65      about it.  */
  66   REMOVE_BREAKPOINT,
  67
  68   /* Detach the breakpoints from a fork child.  */
  69   DETACH_BREAKPOINT,
  70 };
  71
  72 /* This is the maximum number of bytes a breakpoint instruction can
  73    take.  Feel free to increase it.  It's just used in a few places to
  74    size arrays that should be independent of the target
  75    architecture.  */
  76
  77 #define BREAKPOINT_MAX  16
  78 \f
  79
  80 /* Type of breakpoint.  */
  81
  82 enum bptype
  83   {
  84     bp_none = 0,                /* Eventpoint has been deleted */
  85     bp_breakpoint,              /* Normal breakpoint */
  86     bp_hardware_breakpoint,     /* Hardware assisted breakpoint */
  87     bp_single_step,             /* Software single-step */
  88     bp_until,                   /* used by until command */
  89     bp_finish,                  /* used by finish command */
  90     bp_watchpoint,              /* Watchpoint */
  91     bp_hardware_watchpoint,     /* Hardware assisted watchpoint */
  92     bp_read_watchpoint,         /* read watchpoint, (hardware assisted) */
  93     bp_access_watchpoint,       /* access watchpoint, (hardware assisted) */
  94     bp_longjmp,                 /* secret breakpoint to find longjmp() */
  95     bp_longjmp_resume,          /* secret breakpoint to escape longjmp() */
  96
  97     /* Breakpoint placed to the same location(s) like bp_longjmp but used to
  98        protect against stale DUMMY_FRAME.  Multiple bp_longjmp_call_dummy and
  99        one bp_call_dummy are chained together by related_breakpoint for each
 100        DUMMY_FRAME.  */
 101     bp_longjmp_call_dummy,
 102
 103     /* An internal breakpoint that is installed on the unwinder's
 104        debug hook.  */
 105     bp_exception,
 106     /* An internal breakpoint that is set at the point where an
 107        exception will land.  */
 108     bp_exception_resume,
 109
 110     /* Used by wait_for_inferior for stepping over subroutine calls,
 111        and for skipping prologues.  */
 112     bp_step_resume,
 113
 114     /* Used by wait_for_inferior for stepping over signal
 115        handlers.  */
 116     bp_hp_step_resume,
 117
 118     /* Used to detect when a watchpoint expression has gone out of
 119        scope.  These breakpoints are usually not visible to the user.
 120
 121        This breakpoint has some interesting properties:
 122
 123        1) There's always a 1:1 mapping between watchpoints
 124        on local variables and watchpoint_scope breakpoints.
 125
 126        2) It automatically deletes itself and the watchpoint it's
 127        associated with when hit.
 128
 129        3) It can never be disabled.  */
 130     bp_watchpoint_scope,
 131
 132     /* The breakpoint at the end of a call dummy.  See bp_longjmp_call_dummy it
 133        is chained with by related_breakpoint.  */
 134     bp_call_dummy,
 135
 136     /* A breakpoint set on std::terminate, that is used to catch
 137        otherwise uncaught exceptions thrown during an inferior call.  */
 138     bp_std_terminate,
 139
 140     /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
 141        code in the inferior to run when significant events occur in the
 142        dynamic linker (for example a library is loaded or unloaded).
 143
 144        By placing a breakpoint in this magic code GDB will get control
 145        when these significant events occur.  GDB can then re-examine
 146        the dynamic linker's data structures to discover any newly loaded
 147        dynamic libraries.  */
 148     bp_shlib_event,
 149
 150     /* Some multi-threaded systems can arrange for a location in the
 151        inferior to be executed when certain thread-related events occur
 152        (such as thread creation or thread death).
 153
 154        By placing a breakpoint at one of these locations, GDB will get
 155        control when these events occur.  GDB can then update its thread
 156        lists etc.  */
 157
 158     bp_thread_event,
 159
 160     /* On the same principal, an overlay manager can arrange to call a
 161        magic location in the inferior whenever there is an interesting
 162        change in overlay status.  GDB can update its overlay tables
 163        and fiddle with breakpoints in overlays when this breakpoint
 164        is hit.  */
 165
 166     bp_overlay_event,
 167
 168     /* Master copies of longjmp breakpoints.  These are always installed
 169        as soon as an objfile containing longjmp is loaded, but they are
 170        always disabled.  While necessary, temporary clones of bp_longjmp
 171        type will be created and enabled.  */
 172
 173     bp_longjmp_master,
 174
 175     /* Master copies of std::terminate breakpoints.  */
 176     bp_std_terminate_master,
 177
 178     /* Like bp_longjmp_master, but for exceptions.  */
 179     bp_exception_master,
 180
 181     bp_catchpoint,
 182
 183     bp_tracepoint,
 184     bp_fast_tracepoint,
 185     bp_static_tracepoint,
 186     /* Like bp_static_tracepoint but for static markers.  */
 187     bp_static_marker_tracepoint,
 188
 189     /* A dynamic printf stops at the given location, does a formatted
 190        print, then automatically continues.  (Although this is sort of
 191        like a macro packaging up standard breakpoint functionality,
 192        GDB doesn't have a way to construct types of breakpoint from
 193        elements of behavior.)  */
 194     bp_dprintf,
 195
 196     /* Event for JIT compiled code generation or deletion.  */
 197     bp_jit_event,
 198
 199     /* Breakpoint is placed at the STT_GNU_IFUNC resolver.  When hit GDB
 200        inserts new bp_gnu_ifunc_resolver_return at the caller.
 201        bp_gnu_ifunc_resolver is still being kept here as a different thread
 202        may still hit it before bp_gnu_ifunc_resolver_return is hit by the
 203        original thread.  */
 204     bp_gnu_ifunc_resolver,
 205
 206     /* On its hit GDB now know the resolved address of the target
 207        STT_GNU_IFUNC function.  Associated bp_gnu_ifunc_resolver can be
 208        deleted now and the breakpoint moved to the target function entry
 209        point.  */
 210     bp_gnu_ifunc_resolver_return,
 211   };
 212
 213 /* States of enablement of breakpoint.  */
 214
 215 enum enable_state
 216   {
 217     bp_disabled,         /* The eventpoint is inactive, and cannot
 218                             trigger.  */
 219     bp_enabled,          /* The eventpoint is active, and can
 220                             trigger.  */
 221     bp_call_disabled,    /* The eventpoint has been disabled while a
 222                             call into the inferior is "in flight",
 223                             because some eventpoints interfere with
 224                             the implementation of a call on some
 225                             targets.  The eventpoint will be
 226                             automatically enabled and reset when the
 227                             call "lands" (either completes, or stops
 228                             at another eventpoint).  */
 229   };
 230
 231
 232 /* Disposition of breakpoint.  Ie: what to do after hitting it.  */
 233
 234 enum bpdisp
 235   {
 236     disp_del,                   /* Delete it */
 237     disp_del_at_next_stop,      /* Delete at next stop,
 238                                    whether hit or not */
 239     disp_disable,               /* Disable it */
 240     disp_donttouch              /* Leave it alone */
 241   };
 242
 243 /* Status of breakpoint conditions used when synchronizing
 244    conditions with the target.  */
 245
 246 enum condition_status
 247   {
 248     condition_unchanged = 0,
 249     condition_modified,
 250     condition_updated
 251   };
 252
 253 /* Information used by targets to insert and remove breakpoints.  */
 254
 255 struct bp_target_info
 256 {
 257   /* Address space at which the breakpoint was placed.  */
 258   struct address_space *placed_address_space;
 259
 260   /* Address at which the breakpoint was placed.  This is normally
 261      the same as REQUESTED_ADDRESS, except when adjustment happens in
 262      gdbarch_breakpoint_from_pc.  The most common form of adjustment
 263      is stripping an alternate ISA marker from the PC which is used
 264      to determine the type of breakpoint to insert.  */
 265   CORE_ADDR placed_address;
 266
 267   /* Address at which the breakpoint was requested.  */
 268   CORE_ADDR reqstd_address;
 269
 270   /* If this is a ranged breakpoint, then this field contains the
 271      length of the range that will be watched for execution.  */
 272   int length;
 273
 274   /* If the breakpoint lives in memory and reading that memory would
 275      give back the breakpoint, instead of the original contents, then
 276      the original contents are cached here.  Only SHADOW_LEN bytes of
 277      this buffer are valid, and only when the breakpoint is inserted.  */
 278   gdb_byte shadow_contents[BREAKPOINT_MAX];
 279
 280   /* The length of the data cached in SHADOW_CONTENTS.  */
 281   int shadow_len;
 282
 283   /* The breakpoint's kind.  It is used in 'kind' parameter in Z
 284      packets.  */
 285   int kind;
 286
 287   /* Conditions the target should evaluate if it supports target-side
 288      breakpoint conditions.  These are non-owning pointers.  */
 289   std::vector<agent_expr *> conditions;
 290
 291   /* Commands the target should evaluate if it supports target-side
 292      breakpoint commands.  These are non-owning pointers.  */
 293   std::vector<agent_expr *> tcommands;
 294
 295   /* Flag that is true if the breakpoint should be left in place even
 296      when GDB is not connected.  */
 297   int persist;
 298 };
 299
 300 /* GDB maintains two types of information about each breakpoint (or
 301    watchpoint, or other related event).  The first type corresponds
 302    to struct breakpoint; this is a relatively high-level structure
 303    which contains the source location(s), stopping conditions, user
 304    commands to execute when the breakpoint is hit, and so forth.
 305
 306    The second type of information corresponds to struct bp_location.
 307    Each breakpoint has one or (eventually) more locations associated
 308    with it, which represent target-specific and machine-specific
 309    mechanisms for stopping the program.  For instance, a watchpoint
 310    expression may require multiple hardware watchpoints in order to
 311    catch all changes in the value of the expression being watched.  */
 312
 313 enum bp_loc_type
 314 {
 315   bp_loc_software_breakpoint,
 316   bp_loc_hardware_breakpoint,
 317   bp_loc_software_watchpoint,
 318   bp_loc_hardware_watchpoint,
 319   bp_loc_other                  /* Miscellaneous...  */
 320 };
 321
 322 class bp_location : public refcounted_object
 323 {
 324 public:
 325   bp_location () = default;
 326
 327   /* Construct a bp_location with the type inferred from OWNER's
 328      type.  */
 329   explicit bp_location (breakpoint *owner);
 330
 331   /* Construct a bp_location with type TYPE.  */
 332   bp_location (breakpoint *owner, bp_loc_type type);
 333
 334   virtual ~bp_location () = default;
 335
 336   /* Chain pointer to the next breakpoint location for
 337      the same parent breakpoint.  */
 338   bp_location *next = NULL;
 339
 340   /* Type of this breakpoint location.  */
 341   bp_loc_type loc_type {};
 342
 343   /* Each breakpoint location must belong to exactly one higher-level
 344      breakpoint.  This pointer is NULL iff this bp_location is no
 345      longer attached to a breakpoint.  For example, when a breakpoint
 346      is deleted, its locations may still be found in the
 347      moribund_locations list, or if we had stopped for it, in
 348      bpstats.  */
 349   breakpoint *owner = NULL;
 350
 351   /* Conditional.  Break only if this expression's value is nonzero.
 352      Unlike string form of condition, which is associated with
 353      breakpoint, this is associated with location, since if breakpoint
 354      has several locations, the evaluation of expression can be
 355      different for different locations.  Only valid for real
 356      breakpoints; a watchpoint's conditional expression is stored in
 357      the owner breakpoint object.  */
 358   expression_up cond;
 359
 360   /* Conditional expression in agent expression
 361      bytecode form.  This is used for stub-side breakpoint
 362      condition evaluation.  */
 363   agent_expr_up cond_bytecode;
 364
 365   /* Signals that the condition has changed since the last time
 366      we updated the global location list.  This means the condition
 367      needs to be sent to the target again.  This is used together
 368      with target-side breakpoint conditions.
 369
 370      condition_unchanged: It means there has been no condition changes.
 371
 372      condition_modified: It means this location had its condition modified.
 373
 374      condition_updated: It means we already marked all the locations that are
 375      duplicates of this location and thus we don't need to call
 376      force_breakpoint_reinsertion (...) for this location.  */
 377
 378   condition_status condition_changed {};
 379
 380   agent_expr_up cmd_bytecode;
 381
 382   /* Signals that breakpoint conditions and/or commands need to be
 383      re-synced with the target.  This has no use other than
 384      target-side breakpoints.  */
 385   bool needs_update = false;
 386
 387   /* This location's address is in an unloaded solib, and so this
 388      location should not be inserted.  It will be automatically
 389      enabled when that solib is loaded.  */
 390   bool shlib_disabled = false;
 391
 392   /* Is this particular location enabled.  */
 393   bool enabled = false;
 394
 395   /* Is this particular location disabled because the condition
 396      expression is invalid at this location.  For a location to be
 397      reported as enabled, the ENABLED field above has to be true *and*
 398      the DISABLED_BY_COND field has to be false.  */
 399   bool disabled_by_cond = false;
 400
 401   /* True if this breakpoint is now inserted.  */
 402   bool inserted = false;
 403
 404   /* True if this is a permanent breakpoint.  There is a breakpoint
 405      instruction hard-wired into the target's code.  Don't try to
 406      write another breakpoint instruction on top of it, or restore its
 407      value.  Step over it using the architecture's
 408      gdbarch_skip_permanent_breakpoint method.  */
 409   bool permanent = false;
 410
 411   /* True if this is not the first breakpoint in the list
 412      for the given address.  location of tracepoint can _never_
 413      be duplicated with other locations of tracepoints and other
 414      kinds of breakpoints, because two locations at the same
 415      address may have different actions, so both of these locations
 416      should be downloaded and so that `tfind N' always works.  */
 417   bool duplicate = false;
 418
 419   /* If we someday support real thread-specific breakpoints, then
 420      the breakpoint location will need a thread identifier.  */
 421
 422   /* Data for specific breakpoint types.  These could be a union, but
 423      simplicity is more important than memory usage for breakpoints.  */
 424
 425   /* Architecture associated with this location's address.  May be
 426      different from the breakpoint architecture.  */
 427   struct gdbarch *gdbarch = NULL;
 428
 429   /* The program space associated with this breakpoint location
 430      address.  Note that an address space may be represented in more
 431      than one program space (e.g. each uClinux program will be given
 432      its own program space, but there will only be one address space
 433      for all of them), but we must not insert more than one location
 434      at the same address in the same address space.  */
 435   program_space *pspace = NULL;
 436
 437   /* Note that zero is a perfectly valid code address on some platforms
 438      (for example, the mn10200 (OBSOLETE) and mn10300 simulators).  NULL
 439      is not a special value for this field.  Valid for all types except
 440      bp_loc_other.  */
 441   CORE_ADDR address = 0;
 442
 443   /* For hardware watchpoints, the size of the memory region being
 444      watched.  For hardware ranged breakpoints, the size of the
 445      breakpoint range.  */
 446   int length = 0;
 447
 448   /* Type of hardware watchpoint.  */
 449   target_hw_bp_type watchpoint_type {};
 450
 451   /* For any breakpoint type with an address, this is the section
 452      associated with the address.  Used primarily for overlay
 453      debugging.  */
 454   obj_section *section = NULL;
 455
 456   /* Address at which breakpoint was requested, either by the user or
 457      by GDB for internal breakpoints.  This will usually be the same
 458      as ``address'' (above) except for cases in which
 459      ADJUST_BREAKPOINT_ADDRESS has computed a different address at
 460      which to place the breakpoint in order to comply with a
 461      processor's architectual constraints.  */
 462   CORE_ADDR requested_address = 0;
 463
 464   /* An additional address assigned with this location.  This is currently
 465      only used by STT_GNU_IFUNC resolver breakpoints to hold the address
 466      of the resolver function.  */
 467   CORE_ADDR related_address = 0;
 468
 469   /* If the location comes from a probe point, this is the probe associated
 470      with it.  */
 471   bound_probe probe {};
 472
 473   gdb::unique_xmalloc_ptr<char> function_name;
 474
 475   /* Details of the placed breakpoint, when inserted.  */
 476   bp_target_info target_info {};
 477
 478   /* Similarly, for the breakpoint at an overlay's LMA, if necessary.  */
 479   bp_target_info overlay_target_info {};
 480
 481   /* In a non-stop mode, it's possible that we delete a breakpoint,
 482      but as we do that, some still running thread hits that breakpoint.
 483      For that reason, we need to keep locations belonging to deleted
 484      breakpoints for a bit, so that don't report unexpected SIGTRAP.
 485      We can't keep such locations forever, so we use a heuristic --
 486      after we process certain number of inferior events since
 487      breakpoint was deleted, we retire all locations of that breakpoint.
 488      This variable keeps a number of events still to go, when
 489      it becomes 0 this location is retired.  */
 490   int events_till_retirement = 0;
 491
 492   /* Line number which was used to place this location.
 493
 494      Breakpoint placed into a comment keeps it's user specified line number
 495      despite ADDRESS resolves into a different line number.  */
 496
 497   int line_number = 0;
 498
 499   /* Symtab which was used to place this location.  This is used
 500      to find the corresponding source file name.  */
 501
 502   struct symtab *symtab = NULL;
 503
 504   /* The symbol found by the location parser, if any.  This may be used to
 505      ascertain when a location spec was set at a different location than
 506      the one originally selected by parsing, e.g., inlined symbols.  */
 507   const struct symbol *symbol = NULL;
 508
 509   /* Similarly, the minimal symbol found by the location parser, if
 510      any.  This may be used to ascertain if the location was
 511      originally set on a GNU ifunc symbol.  */
 512   const minimal_symbol *msymbol = NULL;
 513
 514   /* The objfile the symbol or minimal symbol were found in.  */
 515   const struct objfile *objfile = NULL;
 516 };
 517
 518 /* A policy class for bp_location reference counting.  */
 519 struct bp_location_ref_policy
 520 {
 521   static void incref (bp_location *loc)
 522   {
 523     loc->incref ();
 524   }
 525
 526   static void decref (bp_location *loc)
 527   {
 528     gdb_assert (loc->refcount () > 0);
 529     loc->decref ();
 530     if (loc->refcount () == 0)
 531       delete loc;
 532   }
 533 };
 534
 535 /* A gdb::ref_ptr that has been specialized for bp_location.  */
 536 typedef gdb::ref_ptr<bp_location, bp_location_ref_policy>
 537      bp_location_ref_ptr;
 538
 539 /* The possible return values for print_bpstat, print_it_normal,
 540    print_it_done, print_it_noop.  */
 541 enum print_stop_action
 542 {
 543   /* We printed nothing or we need to do some more analysis.  */
 544   PRINT_UNKNOWN = -1,
 545
 546   /* We printed something, and we *do* desire that something to be
 547      followed by a location.  */
 548   PRINT_SRC_AND_LOC,
 549
 550   /* We printed something, and we do *not* desire that something to be
 551      followed by a location.  */
 552   PRINT_SRC_ONLY,
 553
 554   /* We already printed all we needed to print, don't print anything
 555      else.  */
 556   PRINT_NOTHING
 557 };
 558
 559 /* This structure is a collection of function pointers that, if available,
 560    will be called instead of the performing the default action for this
 561    bptype.  */
 562
 563 struct breakpoint_ops
 564 {
 565   /* Create SALs from location spec, storing the result in
 566      linespec_result.
 567
 568      For an explanation about the arguments, see the function
 569      `create_sals_from_location_spec_default'.
 570
 571      This function is called inside `create_breakpoint'.  */
 572   void (*create_sals_from_location_spec) (location_spec *locspec,
 573                                           struct linespec_result *canonical);
 574
 575   /* This method will be responsible for creating a breakpoint given its SALs.
 576      Usually, it just calls `create_breakpoints_sal' (for ordinary
 577      breakpoints).  However, there may be some special cases where we might
 578      need to do some tweaks, e.g., see
 579      `strace_marker_create_breakpoints_sal'.
 580
 581      This function is called inside `create_breakpoint'.  */
 582   void (*create_breakpoints_sal) (struct gdbarch *,
 583                                   struct linespec_result *,
 584                                   gdb::unique_xmalloc_ptr<char>,
 585                                   gdb::unique_xmalloc_ptr<char>,
 586                                   enum bptype, enum bpdisp, int, int,
 587                                   int, int, int, int, unsigned);
 588 };
 589
 590 enum watchpoint_triggered
 591 {
 592   /* This watchpoint definitely did not trigger.  */
 593   watch_triggered_no = 0,
 594
 595   /* Some hardware watchpoint triggered, and it might have been this
 596      one, but we do not know which it was.  */
 597   watch_triggered_unknown,
 598
 599   /* This hardware watchpoint definitely did trigger.  */
 600   watch_triggered_yes
 601 };
 602
 603 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
 604    a watchpoint over a memory region.  If this flag is true, GDB will use
 605    only one register per watchpoint, thus assuming that all accesses that
 606    modify a memory location happen at its starting address. */
 607
 608 extern bool target_exact_watchpoints;
 609
 610 /* bp_location linked list range.  */
 611
 612 using bp_location_range = next_range<bp_location>;
 613
 614 /* Note that the ->silent field is not currently used by any commands
 615    (though the code is in there if it was to be, and set_raw_breakpoint
 616    does set it to 0).  I implemented it because I thought it would be
 617    useful for a hack I had to put in; I'm going to leave it in because
 618    I can see how there might be times when it would indeed be useful */
 619
 620 /* Abstract base class representing all kinds of breakpoints.  */
 621
 622 struct breakpoint
 623 {
 624   breakpoint (struct gdbarch *gdbarch_, enum bptype bptype,
 625               bool temp = true, const char *cond_string = nullptr);
 626
 627   DISABLE_COPY_AND_ASSIGN (breakpoint);
 628
 629   virtual ~breakpoint () = 0;
 630
 631   /* Allocate a location for this breakpoint.  */
 632   virtual struct bp_location *allocate_location ();
 633
 634   /* Reevaluate a breakpoint.  This is necessary after symbols change
 635      (e.g., an executable or DSO was loaded, or the inferior just
 636      started).  */
 637   virtual void re_set ()
 638   {
 639     /* Nothing to re-set.  */
 640   }
 641
 642   /* Insert the breakpoint or watchpoint or activate the catchpoint.
 643      Return 0 for success, 1 if the breakpoint, watchpoint or
 644      catchpoint type is not supported, -1 for failure.  */
 645   virtual int insert_location (struct bp_location *);
 646
 647   /* Remove the breakpoint/catchpoint that was previously inserted
 648      with the "insert" method above.  Return 0 for success, 1 if the
 649      breakpoint, watchpoint or catchpoint type is not supported,
 650      -1 for failure.  */
 651   virtual int remove_location (struct bp_location *,
 652                                enum remove_bp_reason reason);
 653
 654   /* Return true if it the target has stopped due to hitting
 655      breakpoint location BL.  This function does not check if we
 656      should stop, only if BL explains the stop.  ASPACE is the address
 657      space in which the event occurred, BP_ADDR is the address at
 658      which the inferior stopped, and WS is the target_waitstatus
 659      describing the event.  */
 660   virtual int breakpoint_hit (const struct bp_location *bl,
 661                               const address_space *aspace,
 662                               CORE_ADDR bp_addr,
 663                               const target_waitstatus &ws);
 664
 665   /* Check internal conditions of the breakpoint referred to by BS.
 666      If we should not stop for this breakpoint, set BS->stop to 0.  */
 667   virtual void check_status (struct bpstat *bs)
 668   {
 669     /* Always stop.  */
 670   }
 671
 672   /* Tell how many hardware resources (debug registers) are needed
 673      for this breakpoint.  If this function is not provided, then
 674      the breakpoint or watchpoint needs one debug register.  */
 675   virtual int resources_needed (const struct bp_location *);
 676
 677   /* The normal print routine for this breakpoint, called when we
 678      hit it.  */
 679   virtual enum print_stop_action print_it (const bpstat *bs) const;
 680
 681   /* Display information about this breakpoint, for "info
 682      breakpoints".  Returns false if this method should use the
 683      default behavior.  */
 684   virtual bool print_one (bp_location **) const
 685   {
 686     return false;
 687   }
 688
 689   /* Display extra information about this breakpoint, below the normal
 690      breakpoint description in "info breakpoints".
 691
 692      In the example below, the "address range" line was printed
 693      by print_one_detail_ranged_breakpoint.
 694
 695      (gdb) info breakpoints
 696      Num     Type           Disp Enb Address    What
 697      2       hw breakpoint  keep y              in main at test-watch.c:70
 698              address range: [0x10000458, 0x100004c7]
 699
 700    */
 701   virtual void print_one_detail (struct ui_out *) const
 702   {
 703     /* Nothing.  */
 704   }
 705
 706   /* Display information about this breakpoint after setting it
 707      (roughly speaking; this is called from "mention").  */
 708   virtual void print_mention () const;
 709
 710   /* Print to FP the CLI command that recreates this breakpoint.  */
 711   virtual void print_recreate (struct ui_file *fp) const;
 712
 713   /* Given the location spec (second parameter), this method decodes
 714      it and returns the SAL locations related to it.  For ordinary
 715      breakpoints, it calls `decode_line_full'.  If SEARCH_PSPACE is
 716      not NULL, symbol search is restricted to just that program space.
 717
 718      This function is called inside `location_spec_to_sals'.  */
 719   virtual std::vector<symtab_and_line> decode_location_spec
 720     (location_spec *locspec,
 721      struct program_space *search_pspace);
 722
 723   /* Return true if this breakpoint explains a signal.  See
 724      bpstat_explains_signal.  */
 725   virtual bool explains_signal (enum gdb_signal)
 726   {
 727     return true;
 728   }
 729
 730   /* Called after evaluating the breakpoint's condition,
 731      and only if it evaluated true.  */
 732   virtual void after_condition_true (struct bpstat *bs)
 733   {
 734     /* Nothing to do.  */
 735   }
 736
 737   /* Return a range of this breakpoint's locations.  */
 738   bp_location_range locations () const;
 739
 740   breakpoint *next = NULL;
 741   /* Type of breakpoint.  */
 742   bptype type = bp_none;
 743   /* Zero means disabled; remember the info but don't break here.  */
 744   enum enable_state enable_state = bp_enabled;
 745   /* What to do with this breakpoint after we hit it.  */
 746   bpdisp disposition = disp_del;
 747   /* Number assigned to distinguish breakpoints.  */
 748   int number = 0;
 749
 750   /* Location(s) associated with this high-level breakpoint.  */
 751   bp_location *loc = NULL;
 752
 753   /* True means a silent breakpoint (don't print frame info if we stop
 754      here).  */
 755   bool silent = false;
 756   /* True means display ADDR_STRING to the user verbatim.  */
 757   bool display_canonical = false;
 758   /* Number of stops at this breakpoint that should be continued
 759      automatically before really stopping.  */
 760   int ignore_count = 0;
 761
 762   /* Number of stops at this breakpoint before it will be
 763      disabled.  */
 764   int enable_count = 0;
 765
 766   /* Chain of command lines to execute when this breakpoint is
 767      hit.  */
 768   counted_command_line commands;
 769   /* Stack depth (address of frame).  If nonzero, break only if fp
 770      equals this.  */
 771   struct frame_id frame_id = null_frame_id;
 772
 773   /* The program space used to set the breakpoint.  This is only set
 774      for breakpoints which are specific to a program space; for
 775      non-thread-specific ordinary breakpoints this is NULL.  */
 776   program_space *pspace = NULL;
 777
 778   /* The location specification we used to set the breakpoint.  */
 779   location_spec_up locspec;
 780
 781   /* The filter that should be passed to decode_line_full when
 782      re-setting this breakpoint.  This may be NULL.  */
 783   gdb::unique_xmalloc_ptr<char> filter;
 784
 785   /* For a ranged breakpoint, the location specification we used to
 786      find the end of the range.  */
 787   location_spec_up locspec_range_end;
 788
 789   /* Architecture we used to set the breakpoint.  */
 790   struct gdbarch *gdbarch;
 791   /* Language we used to set the breakpoint.  */
 792   enum language language;
 793   /* Input radix we used to set the breakpoint.  */
 794   int input_radix;
 795   /* String form of the breakpoint condition (malloc'd), or NULL if
 796      there is no condition.  */
 797   gdb::unique_xmalloc_ptr<char> cond_string;
 798
 799   /* String form of extra parameters, or NULL if there are none.
 800      Malloc'd.  */
 801   gdb::unique_xmalloc_ptr<char> extra_string;
 802
 803   /* Holds the address of the related watchpoint_scope breakpoint when
 804      using watchpoints on local variables (might the concept of a
 805      related breakpoint be useful elsewhere, if not just call it the
 806      watchpoint_scope breakpoint or something like that.  FIXME).  */
 807   breakpoint *related_breakpoint;
 808
 809   /* Thread number for thread-specific breakpoint, or -1 if don't
 810      care.  */
 811   int thread = -1;
 812
 813   /* Ada task number for task-specific breakpoint, or 0 if don't
 814      care.  */
 815   int task = 0;
 816
 817   /* Count of the number of times this breakpoint was taken, dumped
 818      with the info, but not used for anything else.  Useful for seeing
 819      how many times you hit a break prior to the program aborting, so
 820      you can back up to just before the abort.  */
 821   int hit_count = 0;
 822
 823   /* Is breakpoint's condition not yet parsed because we found no
 824      location initially so had no context to parse the condition
 825      in.  */
 826   int condition_not_parsed = 0;
 827
 828   /* With a Python scripting enabled GDB, store a reference to the
 829      Python object that has been associated with this breakpoint.
 830      This is always NULL for a GDB that is not script enabled.  It can
 831      sometimes be NULL for enabled GDBs as not all breakpoint types
 832      are tracked by the scripting language API.  */
 833   gdbpy_breakpoint_object *py_bp_object = NULL;
 834
 835   /* Same as py_bp_object, but for Scheme.  */
 836   gdbscm_breakpoint_object *scm_bp_object = NULL;
 837
 838 protected:
 839
 840   /* Helper for breakpoint_ops->print_recreate implementations.  Prints
 841      the "thread" or "task" condition of B, and then a newline.
 842
 843      Necessary because most breakpoint implementations accept
 844      thread/task conditions at the end of the spec line, like "break foo
 845      thread 1", which needs outputting before any breakpoint-type
 846      specific extra command necessary for B's recreation.  */
 847   void print_recreate_thread (struct ui_file *fp) const;
 848 };
 849
 850 /* Abstract base class representing code breakpoints.  User "break"
 851    breakpoints, internal and momentary breakpoints, etc.  IOW, any
 852    kind of breakpoint whose locations are created from SALs.  */
 853 struct code_breakpoint : public breakpoint
 854 {
 855   using breakpoint::breakpoint;
 856
 857   /* Create a breakpoint with SALS as locations.  Use LOCATION as a
 858      description of the location, and COND_STRING as condition
 859      expression.  If LOCATION is NULL then create an "address
 860      location" from the address in the SAL.  */
 861   code_breakpoint (struct gdbarch *gdbarch, bptype type,
 862                    gdb::array_view<const symtab_and_line> sals,
 863                    location_spec_up &&locspec,
 864                    gdb::unique_xmalloc_ptr<char> filter,
 865                    gdb::unique_xmalloc_ptr<char> cond_string,
 866                    gdb::unique_xmalloc_ptr<char> extra_string,
 867                    enum bpdisp disposition,
 868                    int thread, int task, int ignore_count,
 869                    int from_tty,
 870                    int enabled, unsigned flags,
 871                    int display_canonical);
 872
 873   ~code_breakpoint () override = 0;
 874
 875   /* Add a location for SAL to this breakpoint.  */
 876   bp_location *add_location (const symtab_and_line &sal);
 877
 878   void re_set () override;
 879   int insert_location (struct bp_location *) override;
 880   int remove_location (struct bp_location *,
 881                        enum remove_bp_reason reason) override;
 882   int breakpoint_hit (const struct bp_location *bl,
 883                       const address_space *aspace,
 884                       CORE_ADDR bp_addr,
 885                       const target_waitstatus &ws) override;
 886   std::vector<symtab_and_line> decode_location_spec
 887        (struct location_spec *locspec,
 888         struct program_space *search_pspace) override;
 889 };
 890
 891 /* An instance of this type is used to represent a watchpoint,
 892    a.k.a. a data breakpoint.  */
 893
 894 struct watchpoint : public breakpoint
 895 {
 896   using breakpoint::breakpoint;
 897
 898   void re_set () override;
 899   int insert_location (struct bp_location *) override;
 900   int remove_location (struct bp_location *,
 901                        enum remove_bp_reason reason) override;
 902   int breakpoint_hit (const struct bp_location *bl,
 903                       const address_space *aspace,
 904                       CORE_ADDR bp_addr,
 905                       const target_waitstatus &ws) override;
 906   void check_status (struct bpstat *bs) override;
 907   int resources_needed (const struct bp_location *) override;
 908
 909   /* Tell whether we can downgrade from a hardware watchpoint to a software
 910      one.  If not, the user will not be able to enable the watchpoint when
 911      there are not enough hardware resources available.  */
 912   virtual bool works_in_software_mode () const;
 913
 914   enum print_stop_action print_it (const bpstat *bs) const override;
 915   void print_mention () const override;
 916   void print_recreate (struct ui_file *fp) const override;
 917   bool explains_signal (enum gdb_signal) override;
 918
 919   /* String form of exp to use for displaying to the user (malloc'd),
 920      or NULL if none.  */
 921   gdb::unique_xmalloc_ptr<char> exp_string;
 922   /* String form to use for reparsing of EXP (malloc'd) or NULL.  */
 923   gdb::unique_xmalloc_ptr<char> exp_string_reparse;
 924
 925   /* The expression we are watching, or NULL if not a watchpoint.  */
 926   expression_up exp;
 927   /* The largest block within which it is valid, or NULL if it is
 928      valid anywhere (e.g. consists just of global symbols).  */
 929   const struct block *exp_valid_block;
 930   /* The conditional expression if any.  */
 931   expression_up cond_exp;
 932   /* The largest block within which it is valid, or NULL if it is
 933      valid anywhere (e.g. consists just of global symbols).  */
 934   const struct block *cond_exp_valid_block;
 935   /* Value of the watchpoint the last time we checked it, or NULL when
 936      we do not know the value yet or the value was not readable.  VAL
 937      is never lazy.  */
 938   value_ref_ptr val;
 939
 940   /* True if VAL is valid.  If VAL_VALID is set but VAL is NULL,
 941      then an error occurred reading the value.  */
 942   bool val_valid;
 943
 944   /* When watching the location of a bitfield, contains the offset and size of
 945      the bitfield.  Otherwise contains 0.  */
 946   int val_bitpos;
 947   int val_bitsize;
 948
 949   /* Holds the frame address which identifies the frame this
 950      watchpoint should be evaluated in, or `null' if the watchpoint
 951      should be evaluated on the outermost frame.  */
 952   struct frame_id watchpoint_frame;
 953
 954   /* Holds the thread which identifies the frame this watchpoint
 955      should be considered in scope for, or `null_ptid' if the
 956      watchpoint should be evaluated in all threads.  */
 957   ptid_t watchpoint_thread;
 958
 959   /* For hardware watchpoints, the triggered status according to the
 960      hardware.  */
 961   enum watchpoint_triggered watchpoint_triggered;
 962
 963   /* Whether this watchpoint is exact (see
 964      target_exact_watchpoints).  */
 965   int exact;
 966
 967   /* The mask address for a masked hardware watchpoint.  */
 968   CORE_ADDR hw_wp_mask;
 969 };
 970
 971 /* Return true if BPT is either a software breakpoint or a hardware
 972    breakpoint.  */
 973
 974 extern bool is_breakpoint (const struct breakpoint *bpt);
 975
 976 /* Return true if BPT is of any watchpoint kind, hardware or
 977    software.  */
 978
 979 extern bool is_watchpoint (const struct breakpoint *bpt);
 980
 981 /* Return true if BPT is a C++ exception catchpoint (catch
 982    catch/throw/rethrow).  */
 983
 984 extern bool is_exception_catchpoint (breakpoint *bp);
 985
 986 /* An instance of this type is used to represent all kinds of
 987    tracepoints.  */
 988
 989 struct tracepoint : public code_breakpoint
 990 {
 991   using code_breakpoint::code_breakpoint;
 992
 993   int breakpoint_hit (const struct bp_location *bl,
 994                       const address_space *aspace, CORE_ADDR bp_addr,
 995                       const target_waitstatus &ws) override;
 996   void print_one_detail (struct ui_out *uiout) const override;
 997   void print_mention () const override;
 998   void print_recreate (struct ui_file *fp) const override;
 999
1000   /* Number of times this tracepoint should single-step and collect
1001      additional data.  */
1002   long step_count = 0;
1003
1004   /* Number of times this tracepoint should be hit before
1005      disabling/ending.  */
1006   int pass_count = 0;
1007
1008   /* The number of the tracepoint on the target.  */
1009   int number_on_target = 0;
1010
1011   /* The total space taken by all the trace frames for this
1012      tracepoint.  */
1013   ULONGEST traceframe_usage = 0;
1014
1015   /* The static tracepoint marker id, if known.  */
1016   std::string static_trace_marker_id;
1017
1018   /* LTTng/UST allow more than one marker with the same ID string,
1019      although it unadvised because it confuses tools.  When setting
1020      static tracepoints by marker ID, this will record the index in
1021      the array of markers we found for the given marker ID for which
1022      this static tracepoint corresponds.  When resetting breakpoints,
1023      we will use this index to try to find the same marker again.  */
1024   int static_trace_marker_id_idx = 0;
1025 };
1026
1027 /* The abstract base class for catchpoints.  */
1028
1029 struct catchpoint : public breakpoint
1030 {
1031   /* If TEMP is true, then make the breakpoint temporary.  If
1032      COND_STRING is not NULL, then store it in the breakpoint.  */
1033   catchpoint (struct gdbarch *gdbarch, bool temp, const char *cond_string);
1034
1035   ~catchpoint () override = 0;
1036 };
1037
1038 \f
1039 /* The following stuff is an abstract data type "bpstat" ("breakpoint
1040    status").  This provides the ability to determine whether we have
1041    stopped at a breakpoint, and what we should do about it.  */
1042
1043 /* Clears a chain of bpstat, freeing storage
1044    of each.  */
1045 extern void bpstat_clear (bpstat **);
1046
1047 /* Return a copy of a bpstat.  Like "bs1 = bs2" but all storage that
1048    is part of the bpstat is copied as well.  */
1049 extern bpstat *bpstat_copy (bpstat *);
1050
1051 /* Build the (raw) bpstat chain for the stop information given by ASPACE,
1052    BP_ADDR, and WS.  Returns the head of the bpstat chain.  */
1053
1054 extern bpstat *build_bpstat_chain (const address_space *aspace,
1055                                   CORE_ADDR bp_addr,
1056                                   const target_waitstatus &ws);
1057
1058 /* Get a bpstat associated with having just stopped at address
1059    BP_ADDR in thread PTID.  STOP_CHAIN may be supplied as a previously
1060    computed stop chain or NULL, in which case the stop chain will be
1061    computed using build_bpstat_chain.
1062
1063    Determine whether we stopped at a breakpoint, etc, or whether we
1064    don't understand this stop.  Result is a chain of bpstat's such
1065    that:
1066
1067    if we don't understand the stop, the result is a null pointer.
1068
1069    if we understand why we stopped, the result is not null.
1070
1071    Each element of the chain refers to a particular breakpoint or
1072    watchpoint at which we have stopped.  (We may have stopped for
1073    several reasons concurrently.)
1074
1075    Each element of the chain has valid next, breakpoint_at,
1076    commands, FIXME??? fields.
1077
1078    watchpoints_triggered must be called beforehand to set up each
1079    watchpoint's watchpoint_triggered value.
1080
1081 */
1082
1083 extern bpstat *bpstat_stop_status (const address_space *aspace,
1084                                   CORE_ADDR pc, thread_info *thread,
1085                                   const target_waitstatus &ws,
1086                                   bpstat *stop_chain = nullptr);
1087
1088 /* Like bpstat_stop_status, but clears all watchpoints'
1089    watchpoint_triggered flag.  Unlike with bpstat_stop_status, there's
1090    no need to call watchpoint_triggered beforehand.  You'll typically
1091    use this variant when handling a known-non-watchpoint event, like a
1092    fork or exec event.  */
1093
1094 extern bpstat *bpstat_stop_status_nowatch (const address_space *aspace,
1095                                            CORE_ADDR bp_addr,
1096                                            thread_info *thread,
1097                                            const target_waitstatus &ws);
1098 \f
1099
1100
1101 /* This bpstat_what stuff tells wait_for_inferior what to do with a
1102    breakpoint (a challenging task).
1103
1104    The enum values order defines priority-like order of the actions.
1105    Once you've decided that some action is appropriate, you'll never
1106    go back and decide something of a lower priority is better.  Each
1107    of these actions is mutually exclusive with the others.  That
1108    means, that if you find yourself adding a new action class here and
1109    wanting to tell GDB that you have two simultaneous actions to
1110    handle, something is wrong, and you probably don't actually need a
1111    new action type.
1112
1113    Note that a step resume breakpoint overrides another breakpoint of
1114    signal handling (see comment in wait_for_inferior at where we set
1115    the step_resume breakpoint).  */
1116
1117 enum bpstat_what_main_action
1118   {
1119     /* Perform various other tests; that is, this bpstat does not
1120        say to perform any action (e.g. failed watchpoint and nothing
1121        else).  */
1122     BPSTAT_WHAT_KEEP_CHECKING,
1123
1124     /* Remove breakpoints, single step once, then put them back in and
1125        go back to what we were doing.  It's possible that this should
1126        be removed from the main_action and put into a separate field,
1127        to more cleanly handle
1128        BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE.  */
1129     BPSTAT_WHAT_SINGLE,
1130
1131     /* Set longjmp_resume breakpoint, remove all other breakpoints,
1132        and continue.  The "remove all other breakpoints" part is
1133        required if we are also stepping over another breakpoint as
1134        well as doing the longjmp handling.  */
1135     BPSTAT_WHAT_SET_LONGJMP_RESUME,
1136
1137     /* Clear longjmp_resume breakpoint, then handle as
1138        BPSTAT_WHAT_KEEP_CHECKING.  */
1139     BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
1140
1141     /* Clear step resume breakpoint, and keep checking.  */
1142     BPSTAT_WHAT_STEP_RESUME,
1143
1144     /* Rather than distinguish between noisy and silent stops here, it
1145        might be cleaner to have bpstat_print make that decision (also
1146        taking into account stop_print_frame and source_only).  But the
1147        implications are a bit scary (interaction with auto-displays,
1148        etc.), so I won't try it.  */
1149
1150     /* Stop silently.  */
1151     BPSTAT_WHAT_STOP_SILENT,
1152
1153     /* Stop and print.  */
1154     BPSTAT_WHAT_STOP_NOISY,
1155
1156     /* Clear step resume breakpoint, and keep checking.  High-priority
1157        step-resume breakpoints are used when even if there's a user
1158        breakpoint at the current PC when we set the step-resume
1159        breakpoint, we don't want to re-handle any breakpoint other
1160        than the step-resume when it's hit; instead we want to move
1161        past the breakpoint.  This is used in the case of skipping
1162        signal handlers.  */
1163     BPSTAT_WHAT_HP_STEP_RESUME,
1164   };
1165
1166 /* An enum indicating the kind of "stack dummy" stop.  This is a bit
1167    of a misnomer because only one kind of truly a stack dummy.  */
1168 enum stop_stack_kind
1169   {
1170     /* We didn't stop at a stack dummy breakpoint.  */
1171     STOP_NONE = 0,
1172
1173     /* Stopped at a stack dummy.  */
1174     STOP_STACK_DUMMY,
1175
1176     /* Stopped at std::terminate.  */
1177     STOP_STD_TERMINATE
1178   };
1179
1180 struct bpstat_what
1181   {
1182     enum bpstat_what_main_action main_action;
1183
1184     /* Did we hit a call dummy breakpoint?  This only goes with a
1185        main_action of BPSTAT_WHAT_STOP_SILENT or
1186        BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
1187        dummy without popping the frame is not a useful one).  */
1188     enum stop_stack_kind call_dummy;
1189
1190     /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
1191        BPSTAT_WHAT_CLEAR_LONGJMP_RESUME.  True if we are handling a
1192        longjmp, false if we are handling an exception.  */
1193     bool is_longjmp;
1194   };
1195
1196 /* Tell what to do about this bpstat.  */
1197 struct bpstat_what bpstat_what (bpstat *);
1198
1199 /* Run breakpoint event callbacks associated with the breakpoints that
1200    triggered.  */
1201 extern void bpstat_run_callbacks (bpstat *bs_head);
1202
1203 /* Find the bpstat associated with a breakpoint.  NULL otherwise.  */
1204 bpstat *bpstat_find_breakpoint (bpstat *, struct breakpoint *);
1205
1206 /* True if a signal that we got in target_wait() was due to
1207    circumstances explained by the bpstat; the signal is therefore not
1208    random.  */
1209 extern bool bpstat_explains_signal (bpstat *, enum gdb_signal);
1210
1211 /* True if this bpstat causes a stop.  */
1212 extern bool bpstat_causes_stop (bpstat *);
1213
1214 /* True if we should step constantly (e.g. watchpoints on machines
1215    without hardware support).  This isn't related to a specific bpstat,
1216    just to things like whether watchpoints are set.  */
1217 extern bool bpstat_should_step ();
1218
1219 /* Print a message indicating what happened.  Returns nonzero to
1220    say that only the source line should be printed after this (zero
1221    return means print the frame as well as the source line).  */
1222 extern enum print_stop_action bpstat_print (bpstat *, int);
1223
1224 /* Put in *NUM the breakpoint number of the first breakpoint we are
1225    stopped at.  *BSP upon return is a bpstat which points to the
1226    remaining breakpoints stopped at (but which is not guaranteed to be
1227    good for anything but further calls to bpstat_num).
1228
1229    Return 0 if passed a bpstat which does not indicate any breakpoints.
1230    Return -1 if stopped at a breakpoint that has been deleted since
1231    we set it.
1232    Return 1 otherwise.  */
1233 extern int bpstat_num (bpstat **, int *);
1234
1235 /* Perform actions associated with the stopped inferior.  Actually, we
1236    just use this for breakpoint commands.  Perhaps other actions will
1237    go here later, but this is executed at a late time (from the
1238    command loop).  */
1239 extern void bpstat_do_actions (void);
1240
1241 /* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will
1242    not be performed.  */
1243 extern void bpstat_clear_actions (void);
1244
1245 /* Implementation:  */
1246
1247 /* Values used to tell the printing routine how to behave for this
1248    bpstat.  */
1249 enum bp_print_how
1250   {
1251     /* This is used when we want to do a normal printing of the reason
1252        for stopping.  The output will depend on the type of eventpoint
1253        we are dealing with.  This is the default value, most commonly
1254        used.  */
1255     print_it_normal,
1256     /* This is used when nothing should be printed for this bpstat
1257        entry.  */
1258     print_it_noop,
1259     /* This is used when everything which needs to be printed has
1260        already been printed.  But we still want to print the frame.  */
1261     print_it_done
1262   };
1263
1264 struct bpstat
1265   {
1266     bpstat ();
1267     bpstat (struct bp_location *bl, bpstat ***bs_link_pointer);
1268
1269     bpstat (const bpstat &);
1270     bpstat &operator= (const bpstat &) = delete;
1271
1272     /* Linked list because there can be more than one breakpoint at
1273        the same place, and a bpstat reflects the fact that all have
1274        been hit.  */
1275     bpstat *next;
1276
1277     /* Location that caused the stop.  Locations are refcounted, so
1278        this will never be NULL.  Note that this location may end up
1279        detached from a breakpoint, but that does not necessary mean
1280        that the struct breakpoint is gone.  E.g., consider a
1281        watchpoint with a condition that involves an inferior function
1282        call.  Watchpoint locations are recreated often (on resumes,
1283        hence on infcalls too).  Between creating the bpstat and after
1284        evaluating the watchpoint condition, this location may hence
1285        end up detached from its original owner watchpoint, even though
1286        the watchpoint is still listed.  If it's condition evaluates as
1287        true, we still want this location to cause a stop, and we will
1288        still need to know which watchpoint it was originally attached.
1289        What this means is that we should not (in most cases) follow
1290        the `bpstat->bp_location->owner' link, but instead use the
1291        `breakpoint_at' field below.  */
1292     bp_location_ref_ptr bp_location_at;
1293
1294     /* Breakpoint that caused the stop.  This is nullified if the
1295        breakpoint ends up being deleted.  See comments on
1296        `bp_location_at' above for why do we need this field instead of
1297        following the location's owner.  */
1298     struct breakpoint *breakpoint_at;
1299
1300     /* The associated command list.  */
1301     counted_command_line commands;
1302
1303     /* Old value associated with a watchpoint.  */
1304     value_ref_ptr old_val;
1305
1306     /* Nonzero if this breakpoint tells us to print the frame.  */
1307     char print;
1308
1309     /* Nonzero if this breakpoint tells us to stop.  */
1310     char stop;
1311
1312     /* Tell bpstat_print and print_bp_stop_message how to print stuff
1313        associated with this element of the bpstat chain.  */
1314     enum bp_print_how print_it;
1315   };
1316
1317 enum inf_context
1318   {
1319     inf_starting,
1320     inf_running,
1321     inf_exited,
1322     inf_execd
1323   };
1324
1325 /* The possible return values for breakpoint_here_p.
1326    We guarantee that zero always means "no breakpoint here".  */
1327 enum breakpoint_here
1328   {
1329     no_breakpoint_here = 0,
1330     ordinary_breakpoint_here,
1331     permanent_breakpoint_here
1332   };
1333 \f
1334
1335 /* Prototypes for breakpoint-related functions.  */
1336
1337 extern enum breakpoint_here breakpoint_here_p (const address_space *,
1338                                                CORE_ADDR);
1339
1340 /* Return true if an enabled breakpoint exists in the range defined by
1341    ADDR and LEN, in ASPACE.  */
1342 extern int breakpoint_in_range_p (const address_space *aspace,
1343                                   CORE_ADDR addr, ULONGEST len);
1344
1345 extern int moribund_breakpoint_here_p (const address_space *, CORE_ADDR);
1346
1347 extern int breakpoint_inserted_here_p (const address_space *,
1348                                        CORE_ADDR);
1349
1350 extern int software_breakpoint_inserted_here_p (const address_space *,
1351                                                 CORE_ADDR);
1352
1353 /* Return non-zero iff there is a hardware breakpoint inserted at
1354    PC.  */
1355 extern int hardware_breakpoint_inserted_here_p (const address_space *,
1356                                                 CORE_ADDR);
1357
1358 /* Check whether any location of BP is inserted at PC.  */
1359
1360 extern int breakpoint_has_location_inserted_here (struct breakpoint *bp,
1361                                                   const address_space *aspace,
1362                                                   CORE_ADDR pc);
1363
1364 extern int single_step_breakpoint_inserted_here_p (const address_space *,
1365                                                    CORE_ADDR);
1366
1367 /* Returns true if there's a hardware watchpoint or access watchpoint
1368    inserted in the range defined by ADDR and LEN.  */
1369 extern int hardware_watchpoint_inserted_in_range (const address_space *,
1370                                                   CORE_ADDR addr,
1371                                                   ULONGEST len);
1372
1373 /* Returns true if {ASPACE1,ADDR1} and {ASPACE2,ADDR2} represent the
1374    same breakpoint location.  In most targets, this can only be true
1375    if ASPACE1 matches ASPACE2.  On targets that have global
1376    breakpoints, the address space doesn't really matter.  */
1377
1378 extern int breakpoint_address_match (const address_space *aspace1,
1379                                      CORE_ADDR addr1,
1380                                      const address_space *aspace2,
1381                                      CORE_ADDR addr2);
1382
1383 extern void until_break_command (const char *, int, int);
1384
1385 /* Initialize a struct bp_location.  */
1386
1387 extern void update_breakpoint_locations
1388   (code_breakpoint *b,
1389    struct program_space *filter_pspace,
1390    gdb::array_view<const symtab_and_line> sals,
1391    gdb::array_view<const symtab_and_line> sals_end);
1392
1393 extern void breakpoint_re_set (void);
1394
1395 extern void breakpoint_re_set_thread (struct breakpoint *);
1396
1397 extern void delete_breakpoint (struct breakpoint *);
1398
1399 struct breakpoint_deleter
1400 {
1401   void operator() (struct breakpoint *b) const
1402   {
1403     delete_breakpoint (b);
1404   }
1405 };
1406
1407 typedef std::unique_ptr<struct breakpoint, breakpoint_deleter> breakpoint_up;
1408
1409 extern breakpoint_up set_momentary_breakpoint
1410   (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype);
1411
1412 extern breakpoint_up set_momentary_breakpoint_at_pc
1413   (struct gdbarch *, CORE_ADDR pc, enum bptype type);
1414
1415 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt);
1416
1417 extern void set_ignore_count (int, int, int);
1418
1419 extern void breakpoint_init_inferior (enum inf_context);
1420
1421 extern void breakpoint_auto_delete (bpstat *);
1422
1423 /* Return the chain of command lines to execute when this breakpoint
1424    is hit.  */
1425 extern struct command_line *breakpoint_commands (struct breakpoint *b);
1426
1427 /* Return a string image of DISP.  The string is static, and thus should
1428    NOT be deallocated after use.  */
1429 const char *bpdisp_text (enum bpdisp disp);
1430
1431 extern void break_command (const char *, int);
1432
1433 extern void watch_command_wrapper (const char *, int, bool);
1434 extern void awatch_command_wrapper (const char *, int, bool);
1435 extern void rwatch_command_wrapper (const char *, int, bool);
1436 extern void tbreak_command (const char *, int);
1437
1438 extern const struct breakpoint_ops code_breakpoint_ops;
1439
1440 /* Arguments to pass as context to some catch command handlers.  */
1441 #define CATCH_PERMANENT ((void *) (uintptr_t) 0)
1442 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
1443
1444 /* Like add_cmd, but add the command to both the "catch" and "tcatch"
1445    lists, and pass some additional user data to the command
1446    function.  */
1447
1448 extern void
1449   add_catch_command (const char *name, const char *docstring,
1450                      cmd_func_ftype *func,
1451                      completer_ftype *completer,
1452                      void *user_data_catch,
1453                      void *user_data_tcatch);
1454
1455 /* Add breakpoint B on the breakpoint list, and notify the user, the
1456    target and breakpoint_created observers of its existence.  If
1457    INTERNAL is non-zero, the breakpoint number will be allocated from
1458    the internal breakpoint count.  If UPDATE_GLL is non-zero,
1459    update_global_location_list will be called.  */
1460
1461 extern void install_breakpoint (int internal, std::unique_ptr<breakpoint> &&b,
1462                                 int update_gll);
1463
1464 /* Returns the breakpoint ops appropriate for use with with LOCSPEC
1465    and according to IS_TRACEPOINT.  Use this to ensure, for example,
1466    that you pass the correct ops to create_breakpoint for probe
1467    location specs.  If LOCSPEC is NULL, returns
1468    code_breakpoint_ops.  */
1469
1470 extern const struct breakpoint_ops *breakpoint_ops_for_location_spec
1471   (const location_spec *locspec, bool is_tracepoint);
1472
1473 /* Flags that can be passed down to create_breakpoint, etc., to affect
1474    breakpoint creation in several ways.  */
1475
1476 enum breakpoint_create_flags
1477   {
1478     /* We're adding a breakpoint to our tables that is already
1479        inserted in the target.  */
1480     CREATE_BREAKPOINT_FLAGS_INSERTED = 1 << 0
1481   };
1482
1483 /* Set a breakpoint.  This function is shared between CLI and MI
1484    functions for setting a breakpoint at LOCSPEC.
1485
1486    This function has two major modes of operations, selected by the
1487    PARSE_EXTRA parameter.
1488
1489    If PARSE_EXTRA is zero, LOCSPEC is just the breakpoint's location
1490    spec, with condition, thread, and extra string specified by the
1491    COND_STRING, THREAD, and EXTRA_STRING parameters.
1492
1493    If PARSE_EXTRA is non-zero, this function will attempt to extract
1494    the condition, thread, and extra string from EXTRA_STRING, ignoring
1495    the similarly named parameters.
1496
1497    If FORCE_CONDITION is true, the condition is accepted even when it is
1498    invalid at all of the locations.  However, if PARSE_EXTRA is non-zero,
1499    the FORCE_CONDITION parameter is ignored and the corresponding argument
1500    is parsed from EXTRA_STRING.
1501
1502    If INTERNAL is non-zero, the breakpoint number will be allocated
1503    from the internal breakpoint count.
1504
1505    Returns true if any breakpoint was created; false otherwise.  */
1506
1507 extern int create_breakpoint (struct gdbarch *gdbarch,
1508                               struct location_spec *locspec,
1509                               const char *cond_string, int thread,
1510                               const char *extra_string,
1511                               bool force_condition,
1512                               int parse_extra,
1513                               int tempflag, enum bptype wanted_type,
1514                               int ignore_count,
1515                               enum auto_boolean pending_break_support,
1516                               const struct breakpoint_ops *ops,
1517                               int from_tty,
1518                               int enabled,
1519                               int internal, unsigned flags);
1520
1521 extern void insert_breakpoints (void);
1522
1523 extern int remove_breakpoints (void);
1524
1525 /* Remove breakpoints of inferior INF.  */
1526
1527 extern void remove_breakpoints_inf (inferior *inf);
1528
1529 /* This function can be used to update the breakpoint package's state
1530    after an exec() system call has been executed.
1531
1532    This function causes the following:
1533
1534    - All eventpoints are marked "not inserted".
1535    - All eventpoints with a symbolic address are reset such that
1536    the symbolic address must be reevaluated before the eventpoints
1537    can be reinserted.
1538    - The solib breakpoints are explicitly removed from the breakpoint
1539    list.
1540    - A step-resume breakpoint, if any, is explicitly removed from the
1541    breakpoint list.
1542    - All eventpoints without a symbolic address are removed from the
1543    breakpoint list.  */
1544 extern void update_breakpoints_after_exec (void);
1545
1546 /* This function can be used to physically remove hardware breakpoints
1547    and watchpoints from the specified traced inferior process, without
1548    modifying the breakpoint package's state.  This can be useful for
1549    those targets which support following the processes of a fork() or
1550    vfork() system call, when one of the resulting two processes is to
1551    be detached and allowed to run free.
1552
1553    It is an error to use this function on the process whose id is
1554    inferior_ptid.  */
1555 extern int detach_breakpoints (ptid_t ptid);
1556
1557 /* This function is called when program space PSPACE is about to be
1558    deleted.  It takes care of updating breakpoints to not reference
1559    this PSPACE anymore.  */
1560 extern void breakpoint_program_space_exit (struct program_space *pspace);
1561
1562 extern void set_longjmp_breakpoint (struct thread_info *tp,
1563                                     struct frame_id frame);
1564 extern void delete_longjmp_breakpoint (int thread);
1565
1566 /* Mark all longjmp breakpoints from THREAD for later deletion.  */
1567 extern void delete_longjmp_breakpoint_at_next_stop (int thread);
1568
1569 extern struct breakpoint *set_longjmp_breakpoint_for_call_dummy (void);
1570 extern void check_longjmp_breakpoint_for_call_dummy (struct thread_info *tp);
1571
1572 extern void enable_overlay_breakpoints (void);
1573 extern void disable_overlay_breakpoints (void);
1574
1575 extern void set_std_terminate_breakpoint (void);
1576 extern void delete_std_terminate_breakpoint (void);
1577
1578 /* These functions respectively disable or reenable all currently
1579    enabled watchpoints.  When disabled, the watchpoints are marked
1580    call_disabled.  When re-enabled, they are marked enabled.
1581
1582    The intended client of these functions is call_function_by_hand.
1583
1584    The inferior must be stopped, and all breakpoints removed, when
1585    these functions are used.
1586
1587    The need for these functions is that on some targets (e.g., HP-UX),
1588    gdb is unable to unwind through the dummy frame that is pushed as
1589    part of the implementation of a call command.  Watchpoints can
1590    cause the inferior to stop in places where this frame is visible,
1591    and that can cause execution control to become very confused.
1592
1593    Note that if a user sets breakpoints in an interactively called
1594    function, the call_disabled watchpoints will have been re-enabled
1595    when the first such breakpoint is reached.  However, on targets
1596    that are unable to unwind through the call dummy frame, watches
1597    of stack-based storage may then be deleted, because gdb will
1598    believe that their watched storage is out of scope.  (Sigh.) */
1599 extern void disable_watchpoints_before_interactive_call_start (void);
1600
1601 extern void enable_watchpoints_after_interactive_call_stop (void);
1602
1603 /* These functions disable and re-enable all breakpoints during
1604    inferior startup.  They are intended to be called from solib
1605    code where necessary.  This is needed on platforms where the
1606    main executable is relocated at some point during startup
1607    processing, making breakpoint addresses invalid.
1608
1609    If additional breakpoints are created after the routine
1610    disable_breakpoints_before_startup but before the routine
1611    enable_breakpoints_after_startup was called, they will also
1612    be marked as disabled.  */
1613 extern void disable_breakpoints_before_startup (void);
1614 extern void enable_breakpoints_after_startup (void);
1615
1616 /* For script interpreters that need to define breakpoint commands
1617    after they've already read the commands into a struct
1618    command_line.  */
1619 extern enum command_control_type commands_from_control_command
1620   (const char *arg, struct command_line *cmd);
1621
1622 extern void clear_breakpoint_hit_counts (void);
1623
1624 extern struct breakpoint *get_breakpoint (int num);
1625
1626 /* The following are for displays, which aren't really breakpoints,
1627    but here is as good a place as any for them.  */
1628
1629 extern void disable_current_display (void);
1630
1631 extern void do_displays (void);
1632
1633 extern void disable_display (int);
1634
1635 extern void clear_displays (void);
1636
1637 extern void disable_breakpoint (struct breakpoint *);
1638
1639 extern void enable_breakpoint (struct breakpoint *);
1640
1641 extern void breakpoint_set_commands (struct breakpoint *b,
1642                                      counted_command_line &&commands);
1643
1644 extern void breakpoint_set_silent (struct breakpoint *b, int silent);
1645
1646 extern void breakpoint_set_thread (struct breakpoint *b, int thread);
1647
1648 extern void breakpoint_set_task (struct breakpoint *b, int task);
1649
1650 /* Clear the "inserted" flag in all breakpoints.  */
1651 extern void mark_breakpoints_out (void);
1652
1653 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *,
1654                                                        CORE_ADDR);
1655
1656 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *,
1657                                                          CORE_ADDR);
1658
1659 /* Create an solib event breakpoint at ADDRESS in the current program
1660    space, and immediately try to insert it.  Returns a pointer to the
1661    breakpoint on success.  Deletes the new breakpoint and returns NULL
1662    if inserting the breakpoint fails.  */
1663 extern struct breakpoint *create_and_insert_solib_event_breakpoint
1664   (struct gdbarch *gdbarch, CORE_ADDR address);
1665
1666 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *,
1667                                                           CORE_ADDR);
1668
1669 extern void remove_jit_event_breakpoints (void);
1670
1671 extern void remove_solib_event_breakpoints (void);
1672
1673 /* Mark solib event breakpoints of the current program space with
1674    delete at next stop disposition.  */
1675 extern void remove_solib_event_breakpoints_at_next_stop (void);
1676
1677 extern void disable_breakpoints_in_shlibs (void);
1678
1679 /* This function returns true if B is a catchpoint.  */
1680
1681 extern bool is_catchpoint (struct breakpoint *b);
1682
1683 /* Shared helper function (MI and CLI) for creating and installing
1684    a shared object event catchpoint.  If IS_LOAD is true then
1685    the events to be caught are load events, otherwise they are
1686    unload events.  If IS_TEMP is true the catchpoint is a
1687    temporary one.  If ENABLED is true the catchpoint is
1688    created in an enabled state.  */
1689
1690 extern void add_solib_catchpoint (const char *arg, bool is_load, bool is_temp,
1691                                   bool enabled);
1692
1693 /* Create and insert a new software single step breakpoint for the
1694    current thread.  May be called multiple times; each time will add a
1695    new location to the set of potential addresses the next instruction
1696    is at.  */
1697 extern void insert_single_step_breakpoint (struct gdbarch *,
1698                                            const address_space *,
1699                                            CORE_ADDR);
1700
1701 /* Insert all software single step breakpoints for the current frame.
1702    Return true if any software single step breakpoints are inserted,
1703    otherwise, return false.  */
1704 extern int insert_single_step_breakpoints (struct gdbarch *);
1705
1706 /* Check whether any hardware watchpoints have triggered or not,
1707    according to the target, and record it in each watchpoint's
1708    'watchpoint_triggered' field.  */
1709 int watchpoints_triggered (const target_waitstatus &);
1710
1711 /* Helper for transparent breakpoint hiding for memory read and write
1712    routines.
1713
1714    Update one of READBUF or WRITEBUF with either the shadows
1715    (READBUF), or the breakpoint instructions (WRITEBUF) of inserted
1716    breakpoints at the memory range defined by MEMADDR and extending
1717    for LEN bytes.  If writing, then WRITEBUF is a copy of WRITEBUF_ORG
1718    on entry.*/
1719 extern void breakpoint_xfer_memory (gdb_byte *readbuf, gdb_byte *writebuf,
1720                                     const gdb_byte *writebuf_org,
1721                                     ULONGEST memaddr, LONGEST len);
1722
1723 /* Return true if breakpoints should be inserted now.  That'll be the
1724    case if either:
1725
1726     - the target has global breakpoints.
1727
1728     - "breakpoint always-inserted" is on, and the target has
1729       execution.
1730
1731     - threads are executing.
1732 */
1733 extern int breakpoints_should_be_inserted_now (void);
1734
1735 /* Called each time new event from target is processed.
1736    Retires previously deleted breakpoint locations that
1737    in our opinion won't ever trigger.  */
1738 extern void breakpoint_retire_moribund (void);
1739
1740 /* Set break condition of breakpoint B to EXP.
1741    If FORCE, define the condition even if it is invalid in
1742    all of the breakpoint locations.  */
1743 extern void set_breakpoint_condition (struct breakpoint *b, const char *exp,
1744                                       int from_tty, bool force);
1745
1746 /* Set break condition for the breakpoint with number BPNUM to EXP.
1747    Raise an error if no breakpoint with the given number is found.
1748    Also raise an error if the breakpoint already has stop conditions.
1749    If FORCE, define the condition even if it is invalid in
1750    all of the breakpoint locations.  */
1751 extern void set_breakpoint_condition (int bpnum, const char *exp,
1752                                       int from_tty, bool force);
1753
1754 /* Checks if we are catching syscalls or not.
1755    Returns 0 if not, greater than 0 if we are.  */
1756 extern int catch_syscall_enabled (void);
1757
1758 /* Checks if we are catching syscalls with the specific
1759    syscall_number.  Used for "filtering" the catchpoints.
1760    Returns false if not, true if we are.  */
1761 extern bool catching_syscall_number (int syscall_number);
1762
1763 /* Return a tracepoint with the given number if found.  */
1764 extern struct tracepoint *get_tracepoint (int num);
1765
1766 extern struct tracepoint *get_tracepoint_by_number_on_target (int num);
1767
1768 /* Find a tracepoint by parsing a number in the supplied string.  */
1769 extern struct tracepoint *
1770   get_tracepoint_by_number (const char **arg,
1771                             number_or_range_parser *parser);
1772
1773 /* Return true if B is of tracepoint kind.  */
1774
1775 extern bool is_tracepoint (const struct breakpoint *b);
1776
1777 /* Return a vector of all static tracepoints defined at ADDR.  */
1778 extern std::vector<breakpoint *> static_tracepoints_here (CORE_ADDR addr);
1779
1780 /* Create an instance of this to start registering breakpoint numbers
1781    for a later "commands" command.  */
1782
1783 class scoped_rbreak_breakpoints
1784 {
1785 public:
1786
1787   scoped_rbreak_breakpoints ();
1788   ~scoped_rbreak_breakpoints ();
1789
1790   DISABLE_COPY_AND_ASSIGN (scoped_rbreak_breakpoints);
1791 };
1792
1793 /* Breakpoint linked list iterator.  */
1794
1795 using breakpoint_iterator = next_iterator<breakpoint>;
1796
1797 /* Breakpoint linked list range.  */
1798
1799 using breakpoint_range = iterator_range<breakpoint_iterator>;
1800
1801 /* Return a range to iterate over all breakpoints.  */
1802
1803 breakpoint_range all_breakpoints ();
1804
1805 /* Breakpoint linked list range, safe against deletion of the current
1806    breakpoint while iterating.  */
1807
1808 using breakpoint_safe_range = basic_safe_range<breakpoint_range>;
1809
1810 /* Return a range to iterate over all breakpoints.  This range is safe against
1811    deletion of the current breakpoint while iterating.  */
1812
1813 breakpoint_safe_range all_breakpoints_safe ();
1814
1815 /* Breakpoint filter to only keep tracepoints.  */
1816
1817 struct tracepoint_filter
1818 {
1819   bool operator() (breakpoint *b)
1820   { return is_tracepoint (b); }
1821 };
1822
1823 /* Breakpoint linked list iterator, filtering to only keep tracepoints.  */
1824
1825 using tracepoint_iterator
1826   = filtered_iterator<breakpoint_iterator, tracepoint_filter>;
1827
1828 /* Breakpoint linked list range, filtering to only keep tracepoints.  */
1829
1830 using tracepoint_range = iterator_range<tracepoint_iterator>;
1831
1832 /* Return a range to iterate over all tracepoints.  */
1833
1834 tracepoint_range all_tracepoints ();
1835
1836 /* Return a range to iterate over all breakpoint locations.  */
1837
1838 const std::vector<bp_location *> &all_bp_locations ();
1839
1840 /* Nonzero if the specified PC cannot be a location where functions
1841    have been inlined.  */
1842
1843 extern int pc_at_non_inline_function (const address_space *aspace,
1844                                       CORE_ADDR pc,
1845                                       const target_waitstatus &ws);
1846
1847 extern int user_breakpoint_p (struct breakpoint *);
1848
1849 /* Return true if this breakpoint is pending, false if not.  */
1850 extern int pending_breakpoint_p (struct breakpoint *);
1851
1852 /* Attempt to determine architecture of location identified by SAL.  */
1853 extern struct gdbarch *get_sal_arch (struct symtab_and_line sal);
1854
1855 extern void breakpoint_free_objfile (struct objfile *objfile);
1856
1857 extern const char *ep_parse_optional_if_clause (const char **arg);
1858
1859 /* Print the "Thread ID hit" part of "Thread ID hit Breakpoint N" to
1860    UIOUT iff debugging multiple threads.  */
1861 extern void maybe_print_thread_hit_breakpoint (struct ui_out *uiout);
1862
1863 /* Print the specified breakpoint.  */
1864 extern void print_breakpoint (breakpoint *bp);
1865
1866 /* Command element for the 'commands' command.  */
1867 extern cmd_list_element *commands_cmd_element;
1868
1869 /* Whether to use the fixed output when printing information about a
1870    multi-location breakpoint (see PR 9659).  */
1871
1872 extern bool fix_multi_location_breakpoint_output_globally;
1873
1874 /* Deal with "catch catch", "catch throw", and "catch rethrow" commands and
1875    the MI equivalents.  Sets up to catch events of type EX_EVENT.  When
1876    TEMPFLAG is true only the next matching event is caught after which the
1877    catch-point is deleted.  If REGEX is not NULL then only exceptions whose
1878    type name matches REGEX will trigger the event.  */
1879
1880 extern void catch_exception_event (enum exception_event_kind ex_event,
1881                                    const char *regex, bool tempflag,
1882                                    int from_tty);
1883
1884 /* A helper function that prints a shared library stopped event.
1885    IS_CATCHPOINT is true if the event is due to a "catch load"
1886    catchpoint, false otherwise.  */
1887
1888 extern void print_solib_event (bool is_catchpoint);
1889
1890 /* Print a message describing any user-breakpoints set at PC.  This
1891    concerns with logical breakpoints, so we match program spaces, not
1892    address spaces.  */
1893
1894 extern void describe_other_breakpoints (struct gdbarch *,
1895                                         struct program_space *, CORE_ADDR,
1896                                         struct obj_section *, int);
1897
1898 #endif /* !defined (BREAKPOINT_H) */