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