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 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #if !defined (BREAKPOINT_H)
  21 #define BREAKPOINT_H 1
  22
  23 #include "frame.h"
  24 #include "value.h"
  25 #include "vec.h"
  26
  27 struct value;
  28 struct block;
  29
  30 /* This is the maximum number of bytes a breakpoint instruction can take.
  31    Feel free to increase it.  It's just used in a few places to size
  32    arrays that should be independent of the target architecture.  */
  33
  34 #define BREAKPOINT_MAX  16
  35 \f
  36 /* Type of breakpoint. */
  37 /* FIXME In the future, we should fold all other breakpoint-like things into
  38    here.  This includes:
  39
  40    * single-step (for machines where we have to simulate single stepping)
  41    (probably, though perhaps it is better for it to look as much as
  42    possible like a single-step to wait_for_inferior).  */
  43
  44 enum bptype
  45   {
  46     bp_none = 0,                /* Eventpoint has been deleted. */
  47     bp_breakpoint,              /* Normal breakpoint */
  48     bp_hardware_breakpoint,     /* Hardware assisted breakpoint */
  49     bp_until,                   /* used by until command */
  50     bp_finish,                  /* used by finish command */
  51     bp_watchpoint,              /* Watchpoint */
  52     bp_hardware_watchpoint,     /* Hardware assisted watchpoint */
  53     bp_read_watchpoint,         /* read watchpoint, (hardware assisted) */
  54     bp_access_watchpoint,       /* access watchpoint, (hardware assisted) */
  55     bp_longjmp,                 /* secret breakpoint to find longjmp() */
  56     bp_longjmp_resume,          /* secret breakpoint to escape longjmp() */
  57
  58     /* Used by wait_for_inferior for stepping over subroutine calls, for
  59        stepping over signal handlers, and for skipping prologues.  */
  60     bp_step_resume,
  61
  62     /* Used to detect when a watchpoint expression has gone out of
  63        scope.  These breakpoints are usually not visible to the user.
  64
  65        This breakpoint has some interesting properties:
  66
  67        1) There's always a 1:1 mapping between watchpoints
  68        on local variables and watchpoint_scope breakpoints.
  69
  70        2) It automatically deletes itself and the watchpoint it's
  71        associated with when hit.
  72
  73        3) It can never be disabled.  */
  74     bp_watchpoint_scope,
  75
  76     /* The breakpoint at the end of a call dummy.  */
  77     /* FIXME: What if the function we are calling longjmp()s out of the
  78        call, or the user gets out with the "return" command?  We currently
  79        have no way of cleaning up the breakpoint in these (obscure) situations.
  80        (Probably can solve this by noticing longjmp, "return", etc., it's
  81        similar to noticing when a watchpoint on a local variable goes out
  82        of scope (with hardware support for watchpoints)).  */
  83     bp_call_dummy,
  84
  85     /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
  86        code in the inferior to run when significant events occur in the
  87        dynamic linker (for example a library is loaded or unloaded).
  88
  89        By placing a breakpoint in this magic code GDB will get control
  90        when these significant events occur.  GDB can then re-examine
  91        the dynamic linker's data structures to discover any newly loaded
  92        dynamic libraries.  */
  93     bp_shlib_event,
  94
  95     /* Some multi-threaded systems can arrange for a location in the
  96        inferior to be executed when certain thread-related events occur
  97        (such as thread creation or thread death).
  98
  99        By placing a breakpoint at one of these locations, GDB will get
 100        control when these events occur.  GDB can then update its thread
 101        lists etc.  */
 102
 103     bp_thread_event,
 104
 105     /* On the same principal, an overlay manager can arrange to call a
 106        magic location in the inferior whenever there is an interesting
 107        change in overlay status.  GDB can update its overlay tables
 108        and fiddle with breakpoints in overlays when this breakpoint
 109        is hit.  */
 110
 111     bp_overlay_event,
 112
 113     bp_catchpoint,
 114   };
 115
 116 /* States of enablement of breakpoint. */
 117
 118 enum enable_state
 119   {
 120     bp_disabled,        /* The eventpoint is inactive, and cannot trigger. */
 121     bp_enabled,         /* The eventpoint is active, and can trigger. */
 122     bp_call_disabled,   /* The eventpoint has been disabled while a call
 123                            into the inferior is "in flight", because some
 124                            eventpoints interfere with the implementation of
 125                            a call on some targets.  The eventpoint will be
 126                            automatically enabled and reset when the call
 127                            "lands" (either completes, or stops at another
 128                            eventpoint). */
 129     bp_permanent        /* There is a breakpoint instruction hard-wired into
 130                            the target's code.  Don't try to write another
 131                            breakpoint instruction on top of it, or restore
 132                            its value.  Step over it using the architecture's
 133                            SKIP_INSN macro.  */
 134   };
 135
 136
 137 /* Disposition of breakpoint.  Ie: what to do after hitting it. */
 138
 139 enum bpdisp
 140   {
 141     disp_del,                   /* Delete it */
 142     disp_del_at_next_stop,      /* Delete at next stop, whether hit or not */
 143     disp_disable,               /* Disable it */
 144     disp_donttouch              /* Leave it alone */
 145   };
 146
 147 enum target_hw_bp_type
 148   {
 149     hw_write   = 0,             /* Common  HW watchpoint */
 150     hw_read    = 1,             /* Read    HW watchpoint */
 151     hw_access  = 2,             /* Access  HW watchpoint */
 152     hw_execute = 3              /* Execute HW breakpoint */
 153   };
 154
 155
 156 /* Information used by targets to insert and remove breakpoints.  */
 157
 158 struct bp_target_info
 159 {
 160   /* Address at which the breakpoint was placed.  This is normally the
 161      same as ADDRESS from the bp_location, except when adjustment
 162      happens in gdbarch_breakpoint_from_pc.  The most common form of
 163      adjustment is stripping an alternate ISA marker from the PC which
 164      is used to determine the type of breakpoint to insert.  */
 165   CORE_ADDR placed_address;
 166
 167   /* If the breakpoint lives in memory and reading that memory would
 168      give back the breakpoint, instead of the original contents, then
 169      the original contents are cached here.  Only SHADOW_LEN bytes of
 170      this buffer are valid, and only when the breakpoint is inserted.  */
 171   gdb_byte shadow_contents[BREAKPOINT_MAX];
 172
 173   /* The length of the data cached in SHADOW_CONTENTS.  */
 174   int shadow_len;
 175
 176   /* The size of the placed breakpoint, according to
 177      gdbarch_breakpoint_from_pc, when the breakpoint was inserted.  This is
 178      generally the same as SHADOW_LEN, unless we did not need
 179      to read from the target to implement the memory breakpoint
 180      (e.g. if a remote stub handled the details).  We may still
 181      need the size to remove the breakpoint safely.  */
 182   int placed_size;
 183 };
 184
 185 /* GDB maintains two types of information about each breakpoint (or
 186    watchpoint, or other related event).  The first type corresponds
 187    to struct breakpoint; this is a relatively high-level structure
 188    which contains the source location(s), stopping conditions, user
 189    commands to execute when the breakpoint is hit, and so forth.
 190
 191    The second type of information corresponds to struct bp_location.
 192    Each breakpoint has one or (eventually) more locations associated
 193    with it, which represent target-specific and machine-specific
 194    mechanisms for stopping the program.  For instance, a watchpoint
 195    expression may require multiple hardware watchpoints in order to
 196    catch all changes in the value of the expression being watched.  */
 197
 198 enum bp_loc_type
 199 {
 200   bp_loc_software_breakpoint,
 201   bp_loc_hardware_breakpoint,
 202   bp_loc_hardware_watchpoint,
 203   bp_loc_other                  /* Miscellaneous...  */
 204 };
 205
 206 struct bp_location
 207 {
 208   /* Chain pointer to the next breakpoint location for
 209      the same parent breakpoint.  */
 210   struct bp_location *next;
 211
 212   /* Pointer to the next breakpoint location, in a global
 213      list of all breakpoint locations.  */
 214   struct bp_location *global_next;
 215
 216   /* Type of this breakpoint location.  */
 217   enum bp_loc_type loc_type;
 218
 219   /* Each breakpoint location must belong to exactly one higher-level
 220      breakpoint.  This and the DUPLICATE flag are more straightforward
 221      than reference counting.  */
 222   struct breakpoint *owner;
 223
 224   /* Conditional.  Break only if this expression's value is nonzero.
 225      Unlike string form of condition, which is associated with breakpoint,
 226      this is associated with location, since if breakpoint has several
 227      locations,  the evaluation of expression can be different for
 228      different locations.  */
 229   struct expression *cond;
 230
 231   /* This location's address is in an unloaded solib, and so this
 232      location should not be inserted.  It will be automatically
 233      enabled when that solib is loaded.  */
 234   char shlib_disabled;
 235
 236   /* Is this particular location enabled.  */
 237   char enabled;
 238
 239   /* Nonzero if this breakpoint is now inserted.  */
 240   char inserted;
 241
 242   /* Nonzero if this is not the first breakpoint in the list
 243      for the given address.  */
 244   char duplicate;
 245
 246   /* If we someday support real thread-specific breakpoints, then
 247      the breakpoint location will need a thread identifier.  */
 248
 249   /* Data for specific breakpoint types.  These could be a union, but
 250      simplicity is more important than memory usage for breakpoints.  */
 251
 252   /* Note that zero is a perfectly valid code address on some platforms
 253      (for example, the mn10200 (OBSOLETE) and mn10300 simulators).  NULL
 254      is not a special value for this field.  Valid for all types except
 255      bp_loc_other.  */
 256   CORE_ADDR address;
 257
 258   /* For hardware watchpoints, the size of data ad ADDRESS being watches.  */
 259   int length;
 260
 261   /* Type of hardware watchpoint. */
 262   enum target_hw_bp_type watchpoint_type;
 263
 264   /* For any breakpoint type with an address, this is the section
 265      associated with the address.  Used primarily for overlay debugging.  */
 266   struct obj_section *section;
 267
 268   /* Address at which breakpoint was requested, either by the user or
 269      by GDB for internal breakpoints.  This will usually be the same
 270      as ``address'' (above) except for cases in which
 271      ADJUST_BREAKPOINT_ADDRESS has computed a different address at
 272      which to place the breakpoint in order to comply with a
 273      processor's architectual constraints.  */
 274   CORE_ADDR requested_address;
 275
 276   char *function_name;
 277
 278   /* Details of the placed breakpoint, when inserted.  */
 279   struct bp_target_info target_info;
 280
 281   /* Similarly, for the breakpoint at an overlay's LMA, if necessary.  */
 282   struct bp_target_info overlay_target_info;
 283
 284   /* In a non-stop mode, it's possible that we delete a breakpoint,
 285      but as we do that, some still running thread hits that breakpoint.
 286      For that reason, we need to keep locations belonging to deleted
 287      breakpoints for a bit, so that don't report unexpected SIGTRAP.
 288      We can't keep such locations forever, so we use a heuristic --
 289      after we process certain number of inferior events since
 290      breakpoint was deleted, we retire all locations of that breakpoint.
 291      This variable keeps a number of events still to go, when
 292      it becomes 0 this location is retired.  */
 293   int events_till_retirement;
 294 };
 295
 296 /* This structure is a collection of function pointers that, if available,
 297    will be called instead of the performing the default action for this
 298    bptype.  */
 299
 300 struct breakpoint_ops
 301 {
 302   /* Insert the breakpoint or activate the catchpoint.  Should raise
 303      an exception if the operation failed.  */
 304   void (*insert) (struct breakpoint *);
 305
 306   /* Remove the breakpoint/catchpoint that was previously inserted
 307      with the "insert" method above.  Return non-zero if the operation
 308      succeeded.  */
 309   int (*remove) (struct breakpoint *);
 310
 311   /* Return non-zero if the debugger should tell the user that this
 312      breakpoint was hit.  */
 313   int (*breakpoint_hit) (struct breakpoint *);
 314
 315   /* The normal print routine for this breakpoint, called when we
 316      hit it.  */
 317   enum print_stop_action (*print_it) (struct breakpoint *);
 318
 319   /* Display information about this breakpoint, for "info breakpoints".  */
 320   void (*print_one) (struct breakpoint *, CORE_ADDR *);
 321
 322   /* Display information about this breakpoint after setting it (roughly
 323      speaking; this is called from "mention").  */
 324   void (*print_mention) (struct breakpoint *);
 325 };
 326
 327 enum watchpoint_triggered
 328 {
 329   /* This watchpoint definitely did not trigger.  */
 330   watch_triggered_no = 0,
 331
 332   /* Some hardware watchpoint triggered, and it might have been this
 333      one, but we do not know which it was.  */
 334   watch_triggered_unknown,
 335
 336   /* This hardware watchpoint definitely did trigger.  */
 337   watch_triggered_yes
 338 };
 339
 340 typedef struct bp_location *bp_location_p;
 341 DEF_VEC_P(bp_location_p);
 342
 343 /* Note that the ->silent field is not currently used by any commands
 344    (though the code is in there if it was to be, and set_raw_breakpoint
 345    does set it to 0).  I implemented it because I thought it would be
 346    useful for a hack I had to put in; I'm going to leave it in because
 347    I can see how there might be times when it would indeed be useful */
 348
 349 /* This is for a breakpoint or a watchpoint.  */
 350
 351 struct breakpoint
 352   {
 353     struct breakpoint *next;
 354     /* Type of breakpoint. */
 355     enum bptype type;
 356     /* Zero means disabled; remember the info but don't break here.  */
 357     enum enable_state enable_state;
 358     /* What to do with this breakpoint after we hit it. */
 359     enum bpdisp disposition;
 360     /* Number assigned to distinguish breakpoints.  */
 361     int number;
 362
 363     /* Location(s) associated with this high-level breakpoint.  */
 364     struct bp_location *loc;
 365
 366     /* Line number of this address.  */
 367
 368     int line_number;
 369
 370     /* Source file name of this address.  */
 371
 372     char *source_file;
 373
 374     /* Non-zero means a silent breakpoint (don't print frame info
 375        if we stop here). */
 376     unsigned char silent;
 377     /* Number of stops at this breakpoint that should
 378        be continued automatically before really stopping.  */
 379     int ignore_count;
 380     /* Chain of command lines to execute when this breakpoint is hit.  */
 381     struct command_line *commands;
 382     /* Stack depth (address of frame).  If nonzero, break only if fp
 383        equals this.  */
 384     struct frame_id frame_id;
 385
 386     /* String we used to set the breakpoint (malloc'd).  */
 387     char *addr_string;
 388     /* Language we used to set the breakpoint.  */
 389     enum language language;
 390     /* Input radix we used to set the breakpoint.  */
 391     int input_radix;
 392     /* String form of the breakpoint condition (malloc'd), or NULL if there
 393        is no condition.  */
 394     char *cond_string;
 395     /* String form of exp (malloc'd), or NULL if none.  */
 396     char *exp_string;
 397
 398     /* The expression we are watching, or NULL if not a watchpoint.  */
 399     struct expression *exp;
 400     /* The largest block within which it is valid, or NULL if it is
 401        valid anywhere (e.g. consists just of global symbols).  */
 402     struct block *exp_valid_block;
 403     /* Value of the watchpoint the last time we checked it, or NULL
 404        when we do not know the value yet or the value was not
 405        readable.  VAL is never lazy.  */
 406     struct value *val;
 407     /* Nonzero if VAL is valid.  If VAL_VALID is set but VAL is NULL,
 408        then an error occurred reading the value.  */
 409     int val_valid;
 410
 411     /* Holds the address of the related watchpoint_scope breakpoint
 412        when using watchpoints on local variables (might the concept
 413        of a related breakpoint be useful elsewhere, if not just call
 414        it the watchpoint_scope breakpoint or something like that. FIXME).  */
 415     struct breakpoint *related_breakpoint;
 416
 417     /* Holds the frame address which identifies the frame this
 418        watchpoint should be evaluated in, or `null' if the watchpoint
 419        should be evaluated on the outermost frame.  */
 420     struct frame_id watchpoint_frame;
 421
 422     /* For hardware watchpoints, the triggered status according to the
 423        hardware.  */
 424     enum watchpoint_triggered watchpoint_triggered;
 425
 426     /* Thread number for thread-specific breakpoint, or -1 if don't care */
 427     int thread;
 428
 429     /* Count of the number of times this breakpoint was taken, dumped
 430        with the info, but not used for anything else.  Useful for
 431        seeing how many times you hit a break prior to the program
 432        aborting, so you can back up to just before the abort.  */
 433     int hit_count;
 434
 435     /* Process id of a child process whose forking triggered this
 436        catchpoint.  This field is only valid immediately after this
 437        catchpoint has triggered.  */
 438     ptid_t forked_inferior_pid;
 439
 440     /* Filename of a program whose exec triggered this catchpoint.
 441        This field is only valid immediately after this catchpoint has
 442        triggered.  */
 443     char *exec_pathname;
 444
 445     /* Methods associated with this breakpoint.  */
 446     struct breakpoint_ops *ops;
 447
 448     /* Is breakpoint's condition not yet parsed because we found
 449        no location initially so had no context to parse
 450        the condition in.  */
 451     int condition_not_parsed;
 452   };
 453
 454 typedef struct breakpoint *breakpoint_p;
 455 DEF_VEC_P(breakpoint_p);
 456 \f
 457 /* The following stuff is an abstract data type "bpstat" ("breakpoint
 458    status").  This provides the ability to determine whether we have
 459    stopped at a breakpoint, and what we should do about it.  */
 460
 461 typedef struct bpstats *bpstat;
 462
 463 /* Frees any storage that is part of a bpstat.
 464    Does not walk the 'next' chain.  */
 465 extern void bpstat_free (bpstat);
 466
 467 /* Clears a chain of bpstat, freeing storage
 468    of each.  */
 469 extern void bpstat_clear (bpstat *);
 470
 471 /* Return a copy of a bpstat.  Like "bs1 = bs2" but all storage that
 472    is part of the bpstat is copied as well.  */
 473 extern bpstat bpstat_copy (bpstat);
 474
 475 extern bpstat bpstat_stop_status (CORE_ADDR pc, ptid_t ptid);
 476 \f
 477 /* This bpstat_what stuff tells wait_for_inferior what to do with a
 478    breakpoint (a challenging task).  */
 479
 480 enum bpstat_what_main_action
 481   {
 482     /* Perform various other tests; that is, this bpstat does not
 483        say to perform any action (e.g. failed watchpoint and nothing
 484        else).  */
 485     BPSTAT_WHAT_KEEP_CHECKING,
 486
 487     /* Rather than distinguish between noisy and silent stops here, it
 488        might be cleaner to have bpstat_print make that decision (also
 489        taking into account stop_print_frame and source_only).  But the
 490        implications are a bit scary (interaction with auto-displays, etc.),
 491        so I won't try it.  */
 492
 493     /* Stop silently.  */
 494     BPSTAT_WHAT_STOP_SILENT,
 495
 496     /* Stop and print.  */
 497     BPSTAT_WHAT_STOP_NOISY,
 498
 499     /* Remove breakpoints, single step once, then put them back in and
 500        go back to what we were doing.  It's possible that this should be
 501        removed from the main_action and put into a separate field, to more
 502        cleanly handle BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE.  */
 503     BPSTAT_WHAT_SINGLE,
 504
 505     /* Set longjmp_resume breakpoint, remove all other breakpoints,
 506        and continue.  The "remove all other breakpoints" part is required
 507        if we are also stepping over another breakpoint as well as doing
 508        the longjmp handling.  */
 509     BPSTAT_WHAT_SET_LONGJMP_RESUME,
 510
 511     /* Clear longjmp_resume breakpoint, then handle as
 512        BPSTAT_WHAT_KEEP_CHECKING.  */
 513     BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
 514
 515     /* Clear step resume breakpoint, and keep checking.  */
 516     BPSTAT_WHAT_STEP_RESUME,
 517
 518     /* Check the dynamic linker's data structures for new libraries, then
 519        keep checking.  */
 520     BPSTAT_WHAT_CHECK_SHLIBS,
 521
 522     /* This is just used to keep track of how many enums there are.  */
 523     BPSTAT_WHAT_LAST
 524   };
 525
 526 struct bpstat_what
 527   {
 528     enum bpstat_what_main_action main_action;
 529
 530     /* Did we hit a call dummy breakpoint?  This only goes with a main_action
 531        of BPSTAT_WHAT_STOP_SILENT or BPSTAT_WHAT_STOP_NOISY (the concept of
 532        continuing from a call dummy without popping the frame is not a
 533        useful one).  */
 534     int call_dummy;
 535   };
 536
 537 /* The possible return values for print_bpstat, print_it_normal,
 538    print_it_done, print_it_noop. */
 539 enum print_stop_action
 540   {
 541     PRINT_UNKNOWN = -1,
 542     PRINT_SRC_AND_LOC,
 543     PRINT_SRC_ONLY,
 544     PRINT_NOTHING
 545   };
 546
 547 /* Tell what to do about this bpstat.  */
 548 struct bpstat_what bpstat_what (bpstat);
 549 \f
 550 /* Find the bpstat associated with a breakpoint.  NULL otherwise. */
 551 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
 552
 553 /* Find a step_resume breakpoint associated with this bpstat.
 554    (If there are multiple step_resume bp's on the list, this function
 555    will arbitrarily pick one.)
 556
 557    It is an error to use this function if BPSTAT doesn't contain a
 558    step_resume breakpoint.
 559
 560    See wait_for_inferior's use of this function.
 561  */
 562 extern struct breakpoint *bpstat_find_step_resume_breakpoint (bpstat);
 563
 564 /* Nonzero if a signal that we got in wait() was due to circumstances
 565    explained by the BS.  */
 566 /* Currently that is true if we have hit a breakpoint, or if there is
 567    a watchpoint enabled.  */
 568 #define bpstat_explains_signal(bs) ((bs) != NULL)
 569
 570 /* Nonzero if we should step constantly (e.g. watchpoints on machines
 571    without hardware support).  This isn't related to a specific bpstat,
 572    just to things like whether watchpoints are set.  */
 573 extern int bpstat_should_step (void);
 574
 575 /* Print a message indicating what happened.  Returns nonzero to
 576    say that only the source line should be printed after this (zero
 577    return means print the frame as well as the source line).  */
 578 extern enum print_stop_action bpstat_print (bpstat);
 579
 580 /* Put in *NUM the breakpoint number of the first breakpoint we are stopped
 581    at.  *BSP upon return is a bpstat which points to the remaining
 582    breakpoints stopped at (but which is not guaranteed to be good for
 583    anything but further calls to bpstat_num).
 584    Return 0 if passed a bpstat which does not indicate any breakpoints.
 585    Return -1 if stopped at a breakpoint that has been deleted since
 586    we set it.
 587    Return 1 otherwise.  */
 588 extern int bpstat_num (bpstat *, int *);
 589
 590 /* Perform actions associated with the stopped inferior.  Actually, we
 591    just use this for breakpoint commands.  Perhaps other actions will
 592    go here later, but this is executed at a late time (from the
 593    command loop).  */
 594 extern void bpstat_do_actions (void);
 595
 596 /* Modify BS so that the actions will not be performed.  */
 597 extern void bpstat_clear_actions (bpstat);
 598
 599 /* Implementation:  */
 600
 601 /* Values used to tell the printing routine how to behave for this bpstat. */
 602 enum bp_print_how
 603   {
 604     /* This is used when we want to do a normal printing of the reason
 605        for stopping. The output will depend on the type of eventpoint
 606        we are dealing with. This is the default value, most commonly
 607        used. */
 608     print_it_normal,
 609     /* This is used when nothing should be printed for this bpstat entry.  */
 610     print_it_noop,
 611     /* This is used when everything which needs to be printed has
 612        already been printed.  But we still want to print the frame.  */
 613     print_it_done
 614   };
 615
 616 struct bpstats
 617   {
 618     /* Linked list because there can be two breakpoints at the same
 619        place, and a bpstat reflects the fact that both have been hit.  */
 620     bpstat next;
 621     /* Breakpoint that we are at.  */
 622     const struct bp_location *breakpoint_at;
 623     /* Commands left to be done.  */
 624     struct command_line *commands;
 625     /* Old value associated with a watchpoint.  */
 626     struct value *old_val;
 627
 628     /* Nonzero if this breakpoint tells us to print the frame.  */
 629     char print;
 630
 631     /* Nonzero if this breakpoint tells us to stop.  */
 632     char stop;
 633
 634     /* Tell bpstat_print and print_bp_stop_message how to print stuff
 635        associated with this element of the bpstat chain.  */
 636     enum bp_print_how print_it;
 637   };
 638
 639 enum inf_context
 640   {
 641     inf_starting,
 642     inf_running,
 643     inf_exited,
 644     inf_execd
 645   };
 646
 647 /* The possible return values for breakpoint_here_p.
 648    We guarantee that zero always means "no breakpoint here".  */
 649 enum breakpoint_here
 650   {
 651     no_breakpoint_here = 0,
 652     ordinary_breakpoint_here,
 653     permanent_breakpoint_here
 654   };
 655 \f
 656
 657 /* Prototypes for breakpoint-related functions.  */
 658
 659 extern enum breakpoint_here breakpoint_here_p (CORE_ADDR);
 660
 661 extern int moribund_breakpoint_here_p (CORE_ADDR);
 662
 663 extern int breakpoint_inserted_here_p (CORE_ADDR);
 664
 665 extern int regular_breakpoint_inserted_here_p (CORE_ADDR);
 666
 667 extern int software_breakpoint_inserted_here_p (CORE_ADDR);
 668
 669 extern int breakpoint_thread_match (CORE_ADDR, ptid_t);
 670
 671 extern void until_break_command (char *, int, int);
 672
 673 extern void breakpoint_re_set (void);
 674
 675 extern void breakpoint_re_set_thread (struct breakpoint *);
 676
 677 extern struct breakpoint *set_momentary_breakpoint
 678   (struct symtab_and_line, struct frame_id, enum bptype);
 679
 680 extern struct breakpoint *set_momentary_breakpoint_at_pc
 681   (CORE_ADDR pc, enum bptype type);
 682
 683 extern void set_ignore_count (int, int, int);
 684
 685 extern void set_default_breakpoint (int, CORE_ADDR, struct symtab *, int);
 686
 687 extern void breakpoint_init_inferior (enum inf_context);
 688
 689 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
 690
 691 extern void delete_breakpoint (struct breakpoint *);
 692
 693 extern void breakpoint_auto_delete (bpstat);
 694
 695 extern void break_command (char *, int);
 696
 697 extern void hbreak_command_wrapper (char *, int);
 698 extern void thbreak_command_wrapper (char *, int);
 699 extern void rbreak_command_wrapper (char *, int);
 700 extern void watch_command_wrapper (char *, int);
 701 extern void awatch_command_wrapper (char *, int);
 702 extern void rwatch_command_wrapper (char *, int);
 703 extern void tbreak_command (char *, int);
 704
 705 extern void set_breakpoint (char *address, char *condition,
 706                             int hardwareflag, int tempflag,
 707                             int thread, int ignore_count,
 708                             int pending,
 709                             int enabled);
 710
 711 extern void insert_breakpoints (void);
 712
 713 extern int remove_breakpoints (void);
 714
 715 /* This function can be used to physically insert eventpoints from the
 716    specified traced inferior process, without modifying the breakpoint
 717    package's state.  This can be useful for those targets which support
 718    following the processes of a fork() or vfork() system call, when both
 719    of the resulting two processes are to be followed.  */
 720 extern int reattach_breakpoints (int);
 721
 722 /* This function can be used to update the breakpoint package's state
 723    after an exec() system call has been executed.
 724
 725    This function causes the following:
 726
 727    - All eventpoints are marked "not inserted".
 728    - All eventpoints with a symbolic address are reset such that
 729    the symbolic address must be reevaluated before the eventpoints
 730    can be reinserted.
 731    - The solib breakpoints are explicitly removed from the breakpoint
 732    list.
 733    - A step-resume breakpoint, if any, is explicitly removed from the
 734    breakpoint list.
 735    - All eventpoints without a symbolic address are removed from the
 736    breakpoint list. */
 737 extern void update_breakpoints_after_exec (void);
 738
 739 /* This function can be used to physically remove hardware breakpoints
 740    and watchpoints from the specified traced inferior process, without
 741    modifying the breakpoint package's state.  This can be useful for
 742    those targets which support following the processes of a fork() or
 743    vfork() system call, when one of the resulting two processes is to
 744    be detached and allowed to run free.
 745
 746    It is an error to use this function on the process whose id is
 747    inferior_ptid.  */
 748 extern int detach_breakpoints (int);
 749
 750 extern void set_longjmp_breakpoint (void);
 751 extern void delete_longjmp_breakpoint (int thread);
 752
 753 extern void enable_overlay_breakpoints (void);
 754 extern void disable_overlay_breakpoints (void);
 755
 756 /* These functions respectively disable or reenable all currently
 757    enabled watchpoints.  When disabled, the watchpoints are marked
 758    call_disabled.  When reenabled, they are marked enabled.
 759
 760    The intended client of these functions is call_function_by_hand.
 761
 762    The inferior must be stopped, and all breakpoints removed, when
 763    these functions are used.
 764
 765    The need for these functions is that on some targets (e.g., HP-UX),
 766    gdb is unable to unwind through the dummy frame that is pushed as
 767    part of the implementation of a call command.  Watchpoints can
 768    cause the inferior to stop in places where this frame is visible,
 769    and that can cause execution control to become very confused.
 770
 771    Note that if a user sets breakpoints in an interactively called
 772    function, the call_disabled watchpoints will have been reenabled
 773    when the first such breakpoint is reached.  However, on targets
 774    that are unable to unwind through the call dummy frame, watches
 775    of stack-based storage may then be deleted, because gdb will
 776    believe that their watched storage is out of scope.  (Sigh.) */
 777 extern void disable_watchpoints_before_interactive_call_start (void);
 778
 779 extern void enable_watchpoints_after_interactive_call_stop (void);
 780
 781 /* For script interpreters that need to define breakpoint commands
 782    after they've already read the commands into a struct command_line.  */
 783 extern enum command_control_type commands_from_control_command
 784   (char *arg, struct command_line *cmd);
 785
 786 extern void clear_breakpoint_hit_counts (void);
 787
 788 extern int get_number (char **);
 789
 790 extern int get_number_or_range (char **);
 791
 792 /* The following are for displays, which aren't really breakpoints, but
 793    here is as good a place as any for them.  */
 794
 795 extern void disable_current_display (void);
 796
 797 extern void do_displays (void);
 798
 799 extern void disable_display (int);
 800
 801 extern void clear_displays (void);
 802
 803 extern void disable_breakpoint (struct breakpoint *);
 804
 805 extern void enable_breakpoint (struct breakpoint *);
 806
 807 /* Clear the "inserted" flag in all breakpoints.  */
 808 extern void mark_breakpoints_out (void);
 809
 810 extern void make_breakpoint_permanent (struct breakpoint *);
 811
 812 extern struct breakpoint *create_solib_event_breakpoint (CORE_ADDR);
 813
 814 extern struct breakpoint *create_thread_event_breakpoint (CORE_ADDR);
 815
 816 extern void remove_solib_event_breakpoints (void);
 817
 818 extern void remove_thread_event_breakpoints (void);
 819
 820 extern void disable_breakpoints_in_shlibs (void);
 821
 822 /* This function returns TRUE if ep is a catchpoint. */
 823 extern int ep_is_catchpoint (struct breakpoint *);
 824
 825 /* Enable breakpoints and delete when hit.  Called with ARG == NULL
 826    deletes all breakpoints. */
 827 extern void delete_command (char *arg, int from_tty);
 828
 829 /* Pull all H/W watchpoints from the target. Return non-zero if the
 830    remove fails. */
 831 extern int remove_hw_watchpoints (void);
 832
 833 /* Manage a software single step breakpoint (or two).  Insert may be called
 834    twice before remove is called.  */
 835 extern void insert_single_step_breakpoint (CORE_ADDR);
 836 extern void remove_single_step_breakpoints (void);
 837
 838 /* Manage manual breakpoints, separate from the normal chain of
 839    breakpoints.  These functions are used in murky target-specific
 840    ways.  Please do not add more uses!  */
 841 extern void *deprecated_insert_raw_breakpoint (CORE_ADDR);
 842 extern int deprecated_remove_raw_breakpoint (void *);
 843
 844 /* Check if any hardware watchpoints have triggered, according to the
 845    target.  */
 846 int watchpoints_triggered (struct target_waitstatus *);
 847
 848 /* Update BUF, which is LEN bytes read from the target address MEMADDR,
 849    by replacing any memory breakpoints with their shadowed contents.  */
 850 void breakpoint_restore_shadows (gdb_byte *buf, ULONGEST memaddr,
 851                                  LONGEST len);
 852
 853 extern int breakpoints_always_inserted_mode (void);
 854
 855 /* Called each time new event from target is processed.
 856    Retires previously deleted breakpoint locations that
 857    in our opinion won't ever trigger.  */
 858 extern void breakpoint_retire_moribund (void);
 859
 860 /* Tell a breakpoint to be quiet.  */
 861 extern void make_breakpoint_silent (struct breakpoint *);
 862
 863 #endif /* !defined (BREAKPOINT_H) */