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