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