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