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