1 /* Data structures associated with breakpoints in GDB.
2 Copyright (C) 1992-2017 Free Software Foundation, Inc.
4 This file is part of GDB.
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.
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.
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/>. */
19 #if !defined (BREAKPOINT_H)
20 #define BREAKPOINT_H 1
27 #include "break-common.h"
31 #include "common/array-view.h"
35 struct gdbpy_breakpoint_object;
36 struct gdbscm_breakpoint_object;
37 struct number_or_range_parser;
41 struct linespec_result;
44 /* Why are we removing the breakpoint from the target? */
48 /* A regular remove. Remove the breakpoint and forget everything
52 /* Detach the breakpoints from a fork child. */
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
61 #define BREAKPOINT_MAX 16
64 /* Type of breakpoint. */
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() */
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
85 bp_longjmp_call_dummy,
87 /* An internal breakpoint that is installed on the unwinder's
90 /* An internal breakpoint that is set at the point where an
91 exception will land. */
94 /* Used by wait_for_inferior for stepping over subroutine calls,
95 and for skipping prologues. */
98 /* Used by wait_for_inferior for stepping over signal
102 /* Used to detect when a watchpoint expression has gone out of
103 scope. These breakpoints are usually not visible to the user.
105 This breakpoint has some interesting properties:
107 1) There's always a 1:1 mapping between watchpoints
108 on local variables and watchpoint_scope breakpoints.
110 2) It automatically deletes itself and the watchpoint it's
111 associated with when hit.
113 3) It can never be disabled. */
116 /* The breakpoint at the end of a call dummy. See bp_longjmp_call_dummy it
117 is chained with by related_breakpoint. */
120 /* A breakpoint set on std::terminate, that is used to catch
121 otherwise uncaught exceptions thrown during an inferior call. */
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).
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. */
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).
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
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
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. */
159 /* Master copies of std::terminate breakpoints. */
160 bp_std_terminate_master,
162 /* Like bp_longjmp_master, but for exceptions. */
169 bp_static_tracepoint,
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.) */
178 /* Event for JIT compiled code generation or deletion. */
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
186 bp_gnu_ifunc_resolver,
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
192 bp_gnu_ifunc_resolver_return,
195 /* States of enablement of breakpoint. */
199 bp_disabled, /* The eventpoint is inactive, and cannot
201 bp_enabled, /* The eventpoint is active, and can
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). */
214 /* Disposition of breakpoint. Ie: what to do after hitting it. */
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 */
225 /* Status of breakpoint conditions used when synchronizing
226 conditions with the target. */
228 enum condition_status
230 condition_unchanged = 0,
235 /* Information used by targets to insert and remove breakpoints. */
237 struct bp_target_info
239 /* Address space at which the breakpoint was placed. */
240 struct address_space *placed_address_space;
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;
249 /* Address at which the breakpoint was requested. */
250 CORE_ADDR reqstd_address;
252 /* If this is a ranged breakpoint, then this field contains the
253 length of the range that will be watched for execution. */
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];
262 /* The length of the data cached in SHADOW_CONTENTS. */
265 /* The breakpoint's kind. It is used in 'kind' parameter in Z
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;
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;
277 /* Flag that is true if the breakpoint should be left in place even
278 when GDB is not connected. */
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.
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. */
297 bp_loc_software_breakpoint,
298 bp_loc_hardware_breakpoint,
299 bp_loc_hardware_watchpoint,
300 bp_loc_other /* Miscellaneous... */
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. */
307 struct bp_location_ops
309 /* Destructor. Releases everything from SELF (but not SELF
311 void (*dtor) (struct bp_location *self);
317 bp_location () = default;
319 bp_location (const bp_location_ops *ops, breakpoint *owner);
321 /* Chain pointer to the next breakpoint location for
322 the same parent breakpoint. */
323 bp_location *next = NULL;
325 /* Methods associated with this location. */
326 const bp_location_ops *ops = NULL;
328 /* The reference count. */
331 /* Type of this breakpoint location. */
332 bp_loc_type loc_type {};
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
340 breakpoint *owner = NULL;
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. */
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;
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.
361 condition_unchanged: It means there has been no condition changes.
363 condition_modified: It means this location had its condition modified.
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. */
369 condition_status condition_changed {};
371 agent_expr_up cmd_bytecode;
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;
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;
383 /* Is this particular location enabled. */
384 bool enabled = false;
386 /* Nonzero if this breakpoint is now inserted. */
387 bool inserted = false;
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;
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;
404 /* If we someday support real thread-specific breakpoints, then
405 the breakpoint location will need a thread identifier. */
407 /* Data for specific breakpoint types. These could be a union, but
408 simplicity is more important than memory usage for breakpoints. */
410 /* Architecture associated with this location's address. May be
411 different from the breakpoint architecture. */
412 struct gdbarch *gdbarch = NULL;
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;
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
426 CORE_ADDR address = 0;
428 /* For hardware watchpoints, the size of the memory region being
429 watched. For hardware ranged breakpoints, the size of the
433 /* Type of hardware watchpoint. */
434 target_hw_bp_type watchpoint_type {};
436 /* For any breakpoint type with an address, this is the section
437 associated with the address. Used primarily for overlay
439 obj_section *section = NULL;
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;
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;
454 /* If the location comes from a probe point, this is the probe associated
456 bound_probe probe {};
458 char *function_name = NULL;
460 /* Details of the placed breakpoint, when inserted. */
461 bp_target_info target_info {};
463 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
464 bp_target_info overlay_target_info {};
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;
477 /* Line number which was used to place this location.
479 Breakpoint placed into a comment keeps it's user specified line number
480 despite ADDRESS resolves into a different line number. */
484 /* Symtab which was used to place this location. This is used
485 to find the corresponding source file name. */
487 struct symtab *symtab = NULL;
490 /* The possible return values for print_bpstat, print_it_normal,
491 print_it_done, print_it_noop. */
492 enum print_stop_action
494 /* We printed nothing or we need to do some more analysis. */
497 /* We printed something, and we *do* desire that something to be
498 followed by a location. */
501 /* We printed something, and we do *not* desire that something to be
502 followed by a location. */
505 /* We already printed all we needed to print, don't print anything
510 /* This structure is a collection of function pointers that, if available,
511 will be called instead of the performing the default action for this
514 struct breakpoint_ops
516 /* Allocate a location for this breakpoint. */
517 struct bp_location * (*allocate_location) (struct breakpoint *);
519 /* Reevaluate a breakpoint. This is necessary after symbols change
520 (e.g., an executable or DSO was loaded, or the inferior just
522 void (*re_set) (struct breakpoint *self);
524 /* Insert the breakpoint or watchpoint or activate the catchpoint.
525 Return 0 for success, 1 if the breakpoint, watchpoint or
526 catchpoint type is not supported, -1 for failure. */
527 int (*insert_location) (struct bp_location *);
529 /* Remove the breakpoint/catchpoint that was previously inserted
530 with the "insert" method above. Return 0 for success, 1 if the
531 breakpoint, watchpoint or catchpoint type is not supported,
533 int (*remove_location) (struct bp_location *, enum remove_bp_reason reason);
535 /* Return true if it the target has stopped due to hitting
536 breakpoint location BL. This function does not check if we
537 should stop, only if BL explains the stop. ASPACE is the address
538 space in which the event occurred, BP_ADDR is the address at
539 which the inferior stopped, and WS is the target_waitstatus
540 describing the event. */
541 int (*breakpoint_hit) (const struct bp_location *bl,
542 struct address_space *aspace,
544 const struct target_waitstatus *ws);
546 /* Check internal conditions of the breakpoint referred to by BS.
547 If we should not stop for this breakpoint, set BS->stop to 0. */
548 void (*check_status) (struct bpstats *bs);
550 /* Tell how many hardware resources (debug registers) are needed
551 for this breakpoint. If this function is not provided, then
552 the breakpoint or watchpoint needs one debug register. */
553 int (*resources_needed) (const struct bp_location *);
555 /* Tell whether we can downgrade from a hardware watchpoint to a software
556 one. If not, the user will not be able to enable the watchpoint when
557 there are not enough hardware resources available. */
558 int (*works_in_software_mode) (const struct breakpoint *);
560 /* The normal print routine for this breakpoint, called when we
562 enum print_stop_action (*print_it) (struct bpstats *bs);
564 /* Display information about this breakpoint, for "info
566 void (*print_one) (struct breakpoint *, struct bp_location **);
568 /* Display extra information about this breakpoint, below the normal
569 breakpoint description in "info breakpoints".
571 In the example below, the "address range" line was printed
572 by print_one_detail_ranged_breakpoint.
574 (gdb) info breakpoints
575 Num Type Disp Enb Address What
576 2 hw breakpoint keep y in main at test-watch.c:70
577 address range: [0x10000458, 0x100004c7]
580 void (*print_one_detail) (const struct breakpoint *, struct ui_out *);
582 /* Display information about this breakpoint after setting it
583 (roughly speaking; this is called from "mention"). */
584 void (*print_mention) (struct breakpoint *);
586 /* Print to FP the CLI command that recreates this breakpoint. */
587 void (*print_recreate) (struct breakpoint *, struct ui_file *fp);
589 /* Create SALs from location, storing the result in linespec_result.
591 For an explanation about the arguments, see the function
592 `create_sals_from_location_default'.
594 This function is called inside `create_breakpoint'. */
595 void (*create_sals_from_location) (const struct event_location *location,
596 struct linespec_result *canonical,
597 enum bptype type_wanted);
599 /* This method will be responsible for creating a breakpoint given its SALs.
600 Usually, it just calls `create_breakpoints_sal' (for ordinary
601 breakpoints). However, there may be some special cases where we might
602 need to do some tweaks, e.g., see
603 `strace_marker_create_breakpoints_sal'.
605 This function is called inside `create_breakpoint'. */
606 void (*create_breakpoints_sal) (struct gdbarch *,
607 struct linespec_result *,
608 gdb::unique_xmalloc_ptr<char>,
609 gdb::unique_xmalloc_ptr<char>,
610 enum bptype, enum bpdisp, int, int,
611 int, const struct breakpoint_ops *,
612 int, int, int, unsigned);
614 /* Given the location (second parameter), this method decodes it and
615 returns the SAL locations related to it. For ordinary
616 breakpoints, it calls `decode_line_full'. If SEARCH_PSPACE is
617 not NULL, symbol search is restricted to just that program space.
619 This function is called inside `location_to_sals'. */
620 std::vector<symtab_and_line> (*decode_location)
621 (struct breakpoint *b,
622 const struct event_location *location,
623 struct program_space *search_pspace);
625 /* Return true if this breakpoint explains a signal. See
626 bpstat_explains_signal. */
627 int (*explains_signal) (struct breakpoint *, enum gdb_signal);
629 /* Called after evaluating the breakpoint's condition,
630 and only if it evaluated true. */
631 void (*after_condition_true) (struct bpstats *bs);
634 /* Helper for breakpoint_ops->print_recreate implementations. Prints
635 the "thread" or "task" condition of B, and then a newline.
637 Necessary because most breakpoint implementations accept
638 thread/task conditions at the end of the spec line, like "break foo
639 thread 1", which needs outputting before any breakpoint-type
640 specific extra command necessary for B's recreation. */
641 extern void print_recreate_thread (struct breakpoint *b, struct ui_file *fp);
643 enum watchpoint_triggered
645 /* This watchpoint definitely did not trigger. */
646 watch_triggered_no = 0,
648 /* Some hardware watchpoint triggered, and it might have been this
649 one, but we do not know which it was. */
650 watch_triggered_unknown,
652 /* This hardware watchpoint definitely did trigger. */
656 typedef struct bp_location *bp_location_p;
657 DEF_VEC_P(bp_location_p);
659 /* A reference-counted struct command_line. This lets multiple
660 breakpoints share a single command list. This is an implementation
661 detail to the breakpoints module. */
662 struct counted_command_line;
664 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
665 a watchpoint over a memory region. If this flag is true, GDB will use
666 only one register per watchpoint, thus assuming that all acesses that
667 modify a memory location happen at its starting address. */
669 extern int target_exact_watchpoints;
671 /* Note that the ->silent field is not currently used by any commands
672 (though the code is in there if it was to be, and set_raw_breakpoint
673 does set it to 0). I implemented it because I thought it would be
674 useful for a hack I had to put in; I'm going to leave it in because
675 I can see how there might be times when it would indeed be useful */
677 /* This is for all kinds of breakpoints. */
681 virtual ~breakpoint ();
683 /* Methods associated with this breakpoint. */
684 const breakpoint_ops *ops = NULL;
686 breakpoint *next = NULL;
687 /* Type of breakpoint. */
688 bptype type = bp_none;
689 /* Zero means disabled; remember the info but don't break here. */
690 enum enable_state enable_state = bp_enabled;
691 /* What to do with this breakpoint after we hit it. */
692 bpdisp disposition = disp_del;
693 /* Number assigned to distinguish breakpoints. */
696 /* Location(s) associated with this high-level breakpoint. */
697 bp_location *loc = NULL;
699 /* True means a silent breakpoint (don't print frame info if we stop
702 /* True means display ADDR_STRING to the user verbatim. */
703 bool display_canonical = false;
704 /* Number of stops at this breakpoint that should be continued
705 automatically before really stopping. */
706 int ignore_count = 0;
708 /* Number of stops at this breakpoint before it will be
710 int enable_count = 0;
712 /* Chain of command lines to execute when this breakpoint is
714 counted_command_line *commands = NULL;
715 /* Stack depth (address of frame). If nonzero, break only if fp
717 struct frame_id frame_id = null_frame_id;
719 /* The program space used to set the breakpoint. This is only set
720 for breakpoints which are specific to a program space; for
721 non-thread-specific ordinary breakpoints this is NULL. */
722 program_space *pspace = NULL;
724 /* Location we used to set the breakpoint. */
725 event_location_up location;
727 /* The filter that should be passed to decode_line_full when
728 re-setting this breakpoint. This may be NULL, but otherwise is
729 allocated with xmalloc. */
732 /* For a ranged breakpoint, the location we used to find the end of
734 event_location_up location_range_end;
736 /* Architecture we used to set the breakpoint. */
737 struct gdbarch *gdbarch = NULL;
738 /* Language we used to set the breakpoint. */
739 enum language language = language_unknown;
740 /* Input radix we used to set the breakpoint. */
742 /* String form of the breakpoint condition (malloc'd), or NULL if
743 there is no condition. */
744 char *cond_string = NULL;
746 /* String form of extra parameters, or NULL if there are none.
748 char *extra_string = NULL;
750 /* Holds the address of the related watchpoint_scope breakpoint when
751 using watchpoints on local variables (might the concept of a
752 related breakpoint be useful elsewhere, if not just call it the
753 watchpoint_scope breakpoint or something like that. FIXME). */
754 breakpoint *related_breakpoint = NULL;
756 /* Thread number for thread-specific breakpoint, or -1 if don't
760 /* Ada task number for task-specific breakpoint, or 0 if don't
764 /* Count of the number of times this breakpoint was taken, dumped
765 with the info, but not used for anything else. Useful for seeing
766 how many times you hit a break prior to the program aborting, so
767 you can back up to just before the abort. */
770 /* Is breakpoint's condition not yet parsed because we found no
771 location initially so had no context to parse the condition
773 int condition_not_parsed = 0;
775 /* With a Python scripting enabled GDB, store a reference to the
776 Python object that has been associated with this breakpoint.
777 This is always NULL for a GDB that is not script enabled. It can
778 sometimes be NULL for enabled GDBs as not all breakpoint types
779 are tracked by the scripting language API. */
780 gdbpy_breakpoint_object *py_bp_object = NULL;
782 /* Same as py_bp_object, but for Scheme. */
783 gdbscm_breakpoint_object *scm_bp_object = NULL;
786 /* An instance of this type is used to represent a watchpoint. */
788 struct watchpoint : public breakpoint
790 ~watchpoint () override;
792 /* String form of exp to use for displaying to the user (malloc'd),
795 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
796 char *exp_string_reparse;
798 /* The expression we are watching, or NULL if not a watchpoint. */
800 /* The largest block within which it is valid, or NULL if it is
801 valid anywhere (e.g. consists just of global symbols). */
802 const struct block *exp_valid_block;
803 /* The conditional expression if any. */
804 expression_up cond_exp;
805 /* The largest block within which it is valid, or NULL if it is
806 valid anywhere (e.g. consists just of global symbols). */
807 const struct block *cond_exp_valid_block;
808 /* Value of the watchpoint the last time we checked it, or NULL when
809 we do not know the value yet or the value was not readable. VAL
812 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
813 then an error occurred reading the value. */
816 /* When watching the location of a bitfield, contains the offset and size of
817 the bitfield. Otherwise contains 0. */
821 /* Holds the frame address which identifies the frame this
822 watchpoint should be evaluated in, or `null' if the watchpoint
823 should be evaluated on the outermost frame. */
824 struct frame_id watchpoint_frame;
826 /* Holds the thread which identifies the frame this watchpoint
827 should be considered in scope for, or `null_ptid' if the
828 watchpoint should be evaluated in all threads. */
829 ptid_t watchpoint_thread;
831 /* For hardware watchpoints, the triggered status according to the
833 enum watchpoint_triggered watchpoint_triggered;
835 /* Whether this watchpoint is exact (see
836 target_exact_watchpoints). */
839 /* The mask address for a masked hardware watchpoint. */
840 CORE_ADDR hw_wp_mask;
843 /* Given a function FUNC (struct breakpoint *B, void *DATA) and
844 USER_DATA, call FUNC for every known breakpoint passing USER_DATA
847 If FUNC returns 1, the loop stops and the current
848 'struct breakpoint' being processed is returned. If FUNC returns
849 zero, the loop continues.
851 This function returns either a 'struct breakpoint' pointer or NULL.
852 It was based on BFD's bfd_sections_find_if function. */
854 extern struct breakpoint *breakpoint_find_if
855 (int (*func) (struct breakpoint *b, void *d), void *user_data);
857 /* Return true if BPT is either a software breakpoint or a hardware
860 extern int is_breakpoint (const struct breakpoint *bpt);
862 /* Returns true if BPT is really a watchpoint. */
864 extern int is_watchpoint (const struct breakpoint *bpt);
866 /* An instance of this type is used to represent all kinds of
869 struct tracepoint : public breakpoint
871 /* Number of times this tracepoint should single-step and collect
875 /* Number of times this tracepoint should be hit before
879 /* The number of the tracepoint on the target. */
880 int number_on_target;
882 /* The total space taken by all the trace frames for this
884 ULONGEST traceframe_usage;
886 /* The static tracepoint marker id, if known. */
887 char *static_trace_marker_id;
889 /* LTTng/UST allow more than one marker with the same ID string,
890 although it unadvised because it confuses tools. When setting
891 static tracepoints by marker ID, this will record the index in
892 the array of markers we found for the given marker ID for which
893 this static tracepoint corresponds. When resetting breakpoints,
894 we will use this index to try to find the same marker again. */
895 int static_trace_marker_id_idx;
898 typedef struct breakpoint *breakpoint_p;
899 DEF_VEC_P(breakpoint_p);
901 /* The following stuff is an abstract data type "bpstat" ("breakpoint
902 status"). This provides the ability to determine whether we have
903 stopped at a breakpoint, and what we should do about it. */
905 typedef struct bpstats *bpstat;
907 /* Clears a chain of bpstat, freeing storage
909 extern void bpstat_clear (bpstat *);
911 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
912 is part of the bpstat is copied as well. */
913 extern bpstat bpstat_copy (bpstat);
915 extern bpstat bpstat_stop_status (struct address_space *aspace,
916 CORE_ADDR pc, ptid_t ptid,
917 const struct target_waitstatus *ws);
919 /* This bpstat_what stuff tells wait_for_inferior what to do with a
920 breakpoint (a challenging task).
922 The enum values order defines priority-like order of the actions.
923 Once you've decided that some action is appropriate, you'll never
924 go back and decide something of a lower priority is better. Each
925 of these actions is mutually exclusive with the others. That
926 means, that if you find yourself adding a new action class here and
927 wanting to tell GDB that you have two simultaneous actions to
928 handle, something is wrong, and you probably don't actually need a
931 Note that a step resume breakpoint overrides another breakpoint of
932 signal handling (see comment in wait_for_inferior at where we set
933 the step_resume breakpoint). */
935 enum bpstat_what_main_action
937 /* Perform various other tests; that is, this bpstat does not
938 say to perform any action (e.g. failed watchpoint and nothing
940 BPSTAT_WHAT_KEEP_CHECKING,
942 /* Remove breakpoints, single step once, then put them back in and
943 go back to what we were doing. It's possible that this should
944 be removed from the main_action and put into a separate field,
945 to more cleanly handle
946 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
949 /* Set longjmp_resume breakpoint, remove all other breakpoints,
950 and continue. The "remove all other breakpoints" part is
951 required if we are also stepping over another breakpoint as
952 well as doing the longjmp handling. */
953 BPSTAT_WHAT_SET_LONGJMP_RESUME,
955 /* Clear longjmp_resume breakpoint, then handle as
956 BPSTAT_WHAT_KEEP_CHECKING. */
957 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
959 /* Clear step resume breakpoint, and keep checking. */
960 BPSTAT_WHAT_STEP_RESUME,
962 /* Rather than distinguish between noisy and silent stops here, it
963 might be cleaner to have bpstat_print make that decision (also
964 taking into account stop_print_frame and source_only). But the
965 implications are a bit scary (interaction with auto-displays,
966 etc.), so I won't try it. */
969 BPSTAT_WHAT_STOP_SILENT,
971 /* Stop and print. */
972 BPSTAT_WHAT_STOP_NOISY,
974 /* Clear step resume breakpoint, and keep checking. High-priority
975 step-resume breakpoints are used when even if there's a user
976 breakpoint at the current PC when we set the step-resume
977 breakpoint, we don't want to re-handle any breakpoint other
978 than the step-resume when it's hit; instead we want to move
979 past the breakpoint. This is used in the case of skipping
981 BPSTAT_WHAT_HP_STEP_RESUME,
984 /* An enum indicating the kind of "stack dummy" stop. This is a bit
985 of a misnomer because only one kind of truly a stack dummy. */
988 /* We didn't stop at a stack dummy breakpoint. */
991 /* Stopped at a stack dummy. */
994 /* Stopped at std::terminate. */
1000 enum bpstat_what_main_action main_action;
1002 /* Did we hit a call dummy breakpoint? This only goes with a
1003 main_action of BPSTAT_WHAT_STOP_SILENT or
1004 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
1005 dummy without popping the frame is not a useful one). */
1006 enum stop_stack_kind call_dummy;
1008 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
1009 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
1010 longjmp, false if we are handling an exception. */
1014 /* Tell what to do about this bpstat. */
1015 struct bpstat_what bpstat_what (bpstat);
1017 /* Run breakpoint event callbacks associated with the breakpoints that
1019 extern void bpstat_run_callbacks (bpstat bs_head);
1021 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
1022 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
1024 /* Nonzero if a signal that we got in target_wait() was due to
1025 circumstances explained by the bpstat; the signal is therefore not
1027 extern int bpstat_explains_signal (bpstat, enum gdb_signal);
1029 /* Nonzero is this bpstat causes a stop. */
1030 extern int bpstat_causes_stop (bpstat);
1032 /* Nonzero if we should step constantly (e.g. watchpoints on machines
1033 without hardware support). This isn't related to a specific bpstat,
1034 just to things like whether watchpoints are set. */
1035 extern int bpstat_should_step (void);
1037 /* Print a message indicating what happened. Returns nonzero to
1038 say that only the source line should be printed after this (zero
1039 return means print the frame as well as the source line). */
1040 extern enum print_stop_action bpstat_print (bpstat, int);
1042 /* Put in *NUM the breakpoint number of the first breakpoint we are
1043 stopped at. *BSP upon return is a bpstat which points to the
1044 remaining breakpoints stopped at (but which is not guaranteed to be
1045 good for anything but further calls to bpstat_num).
1047 Return 0 if passed a bpstat which does not indicate any breakpoints.
1048 Return -1 if stopped at a breakpoint that has been deleted since
1050 Return 1 otherwise. */
1051 extern int bpstat_num (bpstat *, int *);
1053 /* Perform actions associated with the stopped inferior. Actually, we
1054 just use this for breakpoint commands. Perhaps other actions will
1055 go here later, but this is executed at a late time (from the
1057 extern void bpstat_do_actions (void);
1059 /* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will
1060 not be performed. */
1061 extern void bpstat_clear_actions (void);
1063 /* Implementation: */
1065 /* Values used to tell the printing routine how to behave for this
1069 /* This is used when we want to do a normal printing of the reason
1070 for stopping. The output will depend on the type of eventpoint
1071 we are dealing with. This is the default value, most commonly
1074 /* This is used when nothing should be printed for this bpstat
1077 /* This is used when everything which needs to be printed has
1078 already been printed. But we still want to print the frame. */
1084 /* Linked list because there can be more than one breakpoint at
1085 the same place, and a bpstat reflects the fact that all have
1089 /* Location that caused the stop. Locations are refcounted, so
1090 this will never be NULL. Note that this location may end up
1091 detached from a breakpoint, but that does not necessary mean
1092 that the struct breakpoint is gone. E.g., consider a
1093 watchpoint with a condition that involves an inferior function
1094 call. Watchpoint locations are recreated often (on resumes,
1095 hence on infcalls too). Between creating the bpstat and after
1096 evaluating the watchpoint condition, this location may hence
1097 end up detached from its original owner watchpoint, even though
1098 the watchpoint is still listed. If it's condition evaluates as
1099 true, we still want this location to cause a stop, and we will
1100 still need to know which watchpoint it was originally attached.
1101 What this means is that we should not (in most cases) follow
1102 the `bpstat->bp_location->owner' link, but instead use the
1103 `breakpoint_at' field below. */
1104 struct bp_location *bp_location_at;
1106 /* Breakpoint that caused the stop. This is nullified if the
1107 breakpoint ends up being deleted. See comments on
1108 `bp_location_at' above for why do we need this field instead of
1109 following the location's owner. */
1110 struct breakpoint *breakpoint_at;
1112 /* The associated command list. */
1113 struct counted_command_line *commands;
1115 /* Old value associated with a watchpoint. */
1116 struct value *old_val;
1118 /* Nonzero if this breakpoint tells us to print the frame. */
1121 /* Nonzero if this breakpoint tells us to stop. */
1124 /* Tell bpstat_print and print_bp_stop_message how to print stuff
1125 associated with this element of the bpstat chain. */
1126 enum bp_print_how print_it;
1137 /* The possible return values for breakpoint_here_p.
1138 We guarantee that zero always means "no breakpoint here". */
1139 enum breakpoint_here
1141 no_breakpoint_here = 0,
1142 ordinary_breakpoint_here,
1143 permanent_breakpoint_here
1147 /* Prototypes for breakpoint-related functions. */
1149 /* Return 1 if there's a program/permanent breakpoint planted in
1150 memory at ADDRESS, return 0 otherwise. */
1152 extern int program_breakpoint_here_p (struct gdbarch *gdbarch, CORE_ADDR address);
1154 extern enum breakpoint_here breakpoint_here_p (struct address_space *,
1157 /* Return true if an enabled breakpoint exists in the range defined by
1158 ADDR and LEN, in ASPACE. */
1159 extern int breakpoint_in_range_p (struct address_space *aspace,
1160 CORE_ADDR addr, ULONGEST len);
1162 extern int moribund_breakpoint_here_p (struct address_space *, CORE_ADDR);
1164 extern int breakpoint_inserted_here_p (struct address_space *, CORE_ADDR);
1166 extern int regular_breakpoint_inserted_here_p (struct address_space *,
1169 extern int software_breakpoint_inserted_here_p (struct address_space *,
1172 /* Return non-zero iff there is a hardware breakpoint inserted at
1174 extern int hardware_breakpoint_inserted_here_p (struct address_space *,
1177 /* Check whether any location of BP is inserted at PC. */
1179 extern int breakpoint_has_location_inserted_here (struct breakpoint *bp,
1180 struct address_space *aspace,
1183 extern int single_step_breakpoint_inserted_here_p (struct address_space *,
1186 /* Returns true if there's a hardware watchpoint or access watchpoint
1187 inserted in the range defined by ADDR and LEN. */
1188 extern int hardware_watchpoint_inserted_in_range (struct address_space *,
1192 /* Returns true if {ASPACE1,ADDR1} and {ASPACE2,ADDR2} represent the
1193 same breakpoint location. In most targets, this can only be true
1194 if ASPACE1 matches ASPACE2. On targets that have global
1195 breakpoints, the address space doesn't really matter. */
1197 extern int breakpoint_address_match (struct address_space *aspace1,
1199 struct address_space *aspace2,
1202 extern void until_break_command (char *, int, int);
1204 /* Initialize a struct bp_location. */
1206 extern void update_breakpoint_locations
1207 (struct breakpoint *b,
1208 struct program_space *filter_pspace,
1209 gdb::array_view<const symtab_and_line> sals,
1210 gdb::array_view<const symtab_and_line> sals_end);
1212 extern void breakpoint_re_set (void);
1214 extern void breakpoint_re_set_thread (struct breakpoint *);
1216 extern struct breakpoint *set_momentary_breakpoint
1217 (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype);
1219 extern struct breakpoint *set_momentary_breakpoint_at_pc
1220 (struct gdbarch *, CORE_ADDR pc, enum bptype type);
1222 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt);
1224 extern void set_ignore_count (int, int, int);
1226 extern void breakpoint_init_inferior (enum inf_context);
1228 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
1230 extern void delete_breakpoint (struct breakpoint *);
1232 extern void breakpoint_auto_delete (bpstat);
1234 typedef void (*walk_bp_location_callback) (struct bp_location *, void *);
1236 extern void iterate_over_bp_locations (walk_bp_location_callback);
1238 /* Return the chain of command lines to execute when this breakpoint
1240 extern struct command_line *breakpoint_commands (struct breakpoint *b);
1242 /* Return a string image of DISP. The string is static, and thus should
1243 NOT be deallocated after use. */
1244 const char *bpdisp_text (enum bpdisp disp);
1246 extern void break_command (char *, int);
1248 extern void hbreak_command_wrapper (char *, int);
1249 extern void thbreak_command_wrapper (char *, int);
1250 extern void rbreak_command_wrapper (char *, int);
1251 extern void watch_command_wrapper (char *, int, int);
1252 extern void awatch_command_wrapper (char *, int, int);
1253 extern void rwatch_command_wrapper (char *, int, int);
1254 extern void tbreak_command (char *, int);
1256 extern struct breakpoint_ops base_breakpoint_ops;
1257 extern struct breakpoint_ops bkpt_breakpoint_ops;
1258 extern struct breakpoint_ops tracepoint_breakpoint_ops;
1259 extern struct breakpoint_ops dprintf_breakpoint_ops;
1261 extern void initialize_breakpoint_ops (void);
1263 /* Arguments to pass as context to some catch command handlers. */
1264 #define CATCH_PERMANENT ((void *) (uintptr_t) 0)
1265 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
1267 /* Like add_cmd, but add the command to both the "catch" and "tcatch"
1268 lists, and pass some additional user data to the command
1272 add_catch_command (const char *name, const char *docstring,
1273 cmd_sfunc_ftype *sfunc,
1274 completer_ftype *completer,
1275 void *user_data_catch,
1276 void *user_data_tcatch);
1278 /* Initialize a breakpoint struct for Ada exception catchpoints. */
1281 init_ada_exception_breakpoint (struct breakpoint *b,
1282 struct gdbarch *gdbarch,
1283 struct symtab_and_line sal,
1285 const struct breakpoint_ops *ops,
1290 extern void init_catchpoint (struct breakpoint *b,
1291 struct gdbarch *gdbarch, int tempflag,
1292 const char *cond_string,
1293 const struct breakpoint_ops *ops);
1295 /* Add breakpoint B on the breakpoint list, and notify the user, the
1296 target and breakpoint_created observers of its existence. If
1297 INTERNAL is non-zero, the breakpoint number will be allocated from
1298 the internal breakpoint count. If UPDATE_GLL is non-zero,
1299 update_global_location_list will be called. */
1301 extern void install_breakpoint (int internal, std::unique_ptr<breakpoint> &&b,
1304 /* Flags that can be passed down to create_breakpoint, etc., to affect
1305 breakpoint creation in several ways. */
1307 enum breakpoint_create_flags
1309 /* We're adding a breakpoint to our tables that is already
1310 inserted in the target. */
1311 CREATE_BREAKPOINT_FLAGS_INSERTED = 1 << 0
1314 /* Set a breakpoint. This function is shared between CLI and MI functions
1315 for setting a breakpoint at LOCATION.
1317 This function has two major modes of operations, selected by the
1318 PARSE_EXTRA parameter.
1320 If PARSE_EXTRA is zero, LOCATION is just the breakpoint's location,
1321 with condition, thread, and extra string specified by the COND_STRING,
1322 THREAD, and EXTRA_STRING parameters.
1324 If PARSE_EXTRA is non-zero, this function will attempt to extract
1325 the condition, thread, and extra string from EXTRA_STRING, ignoring
1326 the similarly named parameters.
1328 If INTERNAL is non-zero, the breakpoint number will be allocated
1329 from the internal breakpoint count.
1331 Returns true if any breakpoint was created; false otherwise. */
1333 extern int create_breakpoint (struct gdbarch *gdbarch,
1334 const struct event_location *location,
1335 const char *cond_string, int thread,
1336 const char *extra_string,
1338 int tempflag, enum bptype wanted_type,
1340 enum auto_boolean pending_break_support,
1341 const struct breakpoint_ops *ops,
1344 int internal, unsigned flags);
1346 extern void insert_breakpoints (void);
1348 extern int remove_breakpoints (void);
1350 extern int remove_breakpoints_pid (int pid);
1352 /* This function can be used to physically insert eventpoints from the
1353 specified traced inferior process, without modifying the breakpoint
1354 package's state. This can be useful for those targets which
1355 support following the processes of a fork() or vfork() system call,
1356 when both of the resulting two processes are to be followed. */
1357 extern int reattach_breakpoints (int);
1359 /* This function can be used to update the breakpoint package's state
1360 after an exec() system call has been executed.
1362 This function causes the following:
1364 - All eventpoints are marked "not inserted".
1365 - All eventpoints with a symbolic address are reset such that
1366 the symbolic address must be reevaluated before the eventpoints
1368 - The solib breakpoints are explicitly removed from the breakpoint
1370 - A step-resume breakpoint, if any, is explicitly removed from the
1372 - All eventpoints without a symbolic address are removed from the
1374 extern void update_breakpoints_after_exec (void);
1376 /* This function can be used to physically remove hardware breakpoints
1377 and watchpoints from the specified traced inferior process, without
1378 modifying the breakpoint package's state. This can be useful for
1379 those targets which support following the processes of a fork() or
1380 vfork() system call, when one of the resulting two processes is to
1381 be detached and allowed to run free.
1383 It is an error to use this function on the process whose id is
1385 extern int detach_breakpoints (ptid_t ptid);
1387 /* This function is called when program space PSPACE is about to be
1388 deleted. It takes care of updating breakpoints to not reference
1389 this PSPACE anymore. */
1390 extern void breakpoint_program_space_exit (struct program_space *pspace);
1392 extern void set_longjmp_breakpoint (struct thread_info *tp,
1393 struct frame_id frame);
1394 extern void delete_longjmp_breakpoint (int thread);
1396 /* Mark all longjmp breakpoints from THREAD for later deletion. */
1397 extern void delete_longjmp_breakpoint_at_next_stop (int thread);
1399 extern struct breakpoint *set_longjmp_breakpoint_for_call_dummy (void);
1400 extern void check_longjmp_breakpoint_for_call_dummy (struct thread_info *tp);
1402 extern void enable_overlay_breakpoints (void);
1403 extern void disable_overlay_breakpoints (void);
1405 extern void set_std_terminate_breakpoint (void);
1406 extern void delete_std_terminate_breakpoint (void);
1408 /* These functions respectively disable or reenable all currently
1409 enabled watchpoints. When disabled, the watchpoints are marked
1410 call_disabled. When re-enabled, they are marked enabled.
1412 The intended client of these functions is call_function_by_hand.
1414 The inferior must be stopped, and all breakpoints removed, when
1415 these functions are used.
1417 The need for these functions is that on some targets (e.g., HP-UX),
1418 gdb is unable to unwind through the dummy frame that is pushed as
1419 part of the implementation of a call command. Watchpoints can
1420 cause the inferior to stop in places where this frame is visible,
1421 and that can cause execution control to become very confused.
1423 Note that if a user sets breakpoints in an interactively called
1424 function, the call_disabled watchpoints will have been re-enabled
1425 when the first such breakpoint is reached. However, on targets
1426 that are unable to unwind through the call dummy frame, watches
1427 of stack-based storage may then be deleted, because gdb will
1428 believe that their watched storage is out of scope. (Sigh.) */
1429 extern void disable_watchpoints_before_interactive_call_start (void);
1431 extern void enable_watchpoints_after_interactive_call_stop (void);
1433 /* These functions disable and re-enable all breakpoints during
1434 inferior startup. They are intended to be called from solib
1435 code where necessary. This is needed on platforms where the
1436 main executable is relocated at some point during startup
1437 processing, making breakpoint addresses invalid.
1439 If additional breakpoints are created after the routine
1440 disable_breakpoints_before_startup but before the routine
1441 enable_breakpoints_after_startup was called, they will also
1442 be marked as disabled. */
1443 extern void disable_breakpoints_before_startup (void);
1444 extern void enable_breakpoints_after_startup (void);
1446 /* For script interpreters that need to define breakpoint commands
1447 after they've already read the commands into a struct
1449 extern enum command_control_type commands_from_control_command
1450 (const char *arg, struct command_line *cmd);
1452 extern void clear_breakpoint_hit_counts (void);
1454 extern struct breakpoint *get_breakpoint (int num);
1456 /* The following are for displays, which aren't really breakpoints,
1457 but here is as good a place as any for them. */
1459 extern void disable_current_display (void);
1461 extern void do_displays (void);
1463 extern void disable_display (int);
1465 extern void clear_displays (void);
1467 extern void disable_breakpoint (struct breakpoint *);
1469 extern void enable_breakpoint (struct breakpoint *);
1471 extern void breakpoint_set_commands (struct breakpoint *b,
1472 command_line_up &&commands);
1474 extern void breakpoint_set_silent (struct breakpoint *b, int silent);
1476 extern void breakpoint_set_thread (struct breakpoint *b, int thread);
1478 extern void breakpoint_set_task (struct breakpoint *b, int task);
1480 /* Clear the "inserted" flag in all breakpoints. */
1481 extern void mark_breakpoints_out (void);
1483 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *,
1486 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *,
1489 /* Create an solib event breakpoint at ADDRESS in the current program
1490 space, and immediately try to insert it. Returns a pointer to the
1491 breakpoint on success. Deletes the new breakpoint and returns NULL
1492 if inserting the breakpoint fails. */
1493 extern struct breakpoint *create_and_insert_solib_event_breakpoint
1494 (struct gdbarch *gdbarch, CORE_ADDR address);
1496 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *,
1499 extern void remove_jit_event_breakpoints (void);
1501 extern void remove_solib_event_breakpoints (void);
1503 /* Mark solib event breakpoints of the current program space with
1504 delete at next stop disposition. */
1505 extern void remove_solib_event_breakpoints_at_next_stop (void);
1507 extern void disable_breakpoints_in_shlibs (void);
1509 /* This function returns TRUE if ep is a catchpoint. */
1510 extern int is_catchpoint (struct breakpoint *);
1512 /* Shared helper function (MI and CLI) for creating and installing
1513 a shared object event catchpoint. */
1514 extern void add_solib_catchpoint (const char *arg, int is_load, int is_temp,
1517 /* Enable breakpoints and delete when hit. Called with ARG == NULL
1518 deletes all breakpoints. */
1519 extern void delete_command (char *arg, int from_tty);
1521 /* Create and insert a new software single step breakpoint for the
1522 current thread. May be called multiple times; each time will add a
1523 new location to the set of potential addresses the next instruction
1525 extern void insert_single_step_breakpoint (struct gdbarch *,
1526 struct address_space *,
1529 /* Insert all software single step breakpoints for the current frame.
1530 Return true if any software single step breakpoints are inserted,
1531 otherwise, return false. */
1532 extern int insert_single_step_breakpoints (struct gdbarch *);
1534 /* Check if any hardware watchpoints have triggered, according to the
1536 int watchpoints_triggered (struct target_waitstatus *);
1538 /* Helper for transparent breakpoint hiding for memory read and write
1541 Update one of READBUF or WRITEBUF with either the shadows
1542 (READBUF), or the breakpoint instructions (WRITEBUF) of inserted
1543 breakpoints at the memory range defined by MEMADDR and extending
1544 for LEN bytes. If writing, then WRITEBUF is a copy of WRITEBUF_ORG
1546 extern void breakpoint_xfer_memory (gdb_byte *readbuf, gdb_byte *writebuf,
1547 const gdb_byte *writebuf_org,
1548 ULONGEST memaddr, LONGEST len);
1550 /* Return true if breakpoints should be inserted now. That'll be the
1553 - the target has global breakpoints.
1555 - "breakpoint always-inserted" is on, and the target has
1558 - threads are executing.
1560 extern int breakpoints_should_be_inserted_now (void);
1562 /* Called each time new event from target is processed.
1563 Retires previously deleted breakpoint locations that
1564 in our opinion won't ever trigger. */
1565 extern void breakpoint_retire_moribund (void);
1567 /* Set break condition of breakpoint B to EXP. */
1568 extern void set_breakpoint_condition (struct breakpoint *b, const char *exp,
1571 /* Checks if we are catching syscalls or not.
1572 Returns 0 if not, greater than 0 if we are. */
1573 extern int catch_syscall_enabled (void);
1575 /* Checks if we are catching syscalls with the specific
1576 syscall_number. Used for "filtering" the catchpoints.
1577 Returns 0 if not, greater than 0 if we are. */
1578 extern int catching_syscall_number (int syscall_number);
1580 /* Return a tracepoint with the given number if found. */
1581 extern struct tracepoint *get_tracepoint (int num);
1583 extern struct tracepoint *get_tracepoint_by_number_on_target (int num);
1585 /* Find a tracepoint by parsing a number in the supplied string. */
1586 extern struct tracepoint *
1587 get_tracepoint_by_number (char **arg,
1588 number_or_range_parser *parser);
1590 /* Return a vector of all tracepoints currently defined. The vector
1591 is newly allocated; the caller should free when done with it. */
1592 extern VEC(breakpoint_p) *all_tracepoints (void);
1594 extern int is_tracepoint (const struct breakpoint *b);
1596 /* Return a vector of all static tracepoints defined at ADDR. The
1597 vector is newly allocated; the caller should free when done with
1599 extern VEC(breakpoint_p) *static_tracepoints_here (CORE_ADDR addr);
1601 /* Function that can be passed to read_command_line to validate
1602 that each command is suitable for tracepoint command list. */
1603 extern void check_tracepoint_command (char *line, void *closure);
1605 /* Call at the start and end of an "rbreak" command to register
1606 breakpoint numbers for a later "commands" command. */
1607 extern void start_rbreak_breakpoints (void);
1608 extern void end_rbreak_breakpoints (void);
1610 /* Breakpoint iterator function.
1612 Calls a callback function once for each breakpoint, so long as the
1613 callback function returns false. If the callback function returns
1614 true, the iteration will end and the current breakpoint will be
1615 returned. This can be useful for implementing a search for a
1616 breakpoint with arbitrary attributes, or for applying an operation
1617 to every breakpoint. */
1618 extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *,
1621 /* Nonzero if the specified PC cannot be a location where functions
1622 have been inlined. */
1624 extern int pc_at_non_inline_function (struct address_space *aspace,
1626 const struct target_waitstatus *ws);
1628 extern int user_breakpoint_p (struct breakpoint *);
1630 /* Return true if this breakpoint is pending, false if not. */
1631 extern int pending_breakpoint_p (struct breakpoint *);
1633 /* Attempt to determine architecture of location identified by SAL. */
1634 extern struct gdbarch *get_sal_arch (struct symtab_and_line sal);
1636 extern void breakpoint_free_objfile (struct objfile *objfile);
1638 extern const char *ep_parse_optional_if_clause (const char **arg);
1640 /* Print the "Thread ID hit" part of "Thread ID hit Breakpoint N" to
1641 UIOUT iff debugging multiple threads. */
1642 extern void maybe_print_thread_hit_breakpoint (struct ui_out *uiout);
1644 #endif /* !defined (BREAKPOINT_H) */