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