gdb/breakpoint.h

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