gdb/breakpoint.h

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