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