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"
32 #include "cli/cli-script.h"
36 struct gdbpy_breakpoint_object;
37 struct gdbscm_breakpoint_object;
38 struct number_or_range_parser;
42 struct linespec_result;
45 /* Why are we removing the breakpoint from the target? */
49 /* A regular remove. Remove the breakpoint and forget everything
53 /* Detach the breakpoints from a fork child. */
57 /* This is the maximum number of bytes a breakpoint instruction can
58 take. Feel free to increase it. It's just used in a few places to
59 size arrays that should be independent of the target
62 #define BREAKPOINT_MAX 16
65 /* Type of breakpoint. */
69 bp_none = 0, /* Eventpoint has been deleted */
70 bp_breakpoint, /* Normal breakpoint */
71 bp_hardware_breakpoint, /* Hardware assisted breakpoint */
72 bp_single_step, /* Software single-step */
73 bp_until, /* used by until command */
74 bp_finish, /* used by finish command */
75 bp_watchpoint, /* Watchpoint */
76 bp_hardware_watchpoint, /* Hardware assisted watchpoint */
77 bp_read_watchpoint, /* read watchpoint, (hardware assisted) */
78 bp_access_watchpoint, /* access watchpoint, (hardware assisted) */
79 bp_longjmp, /* secret breakpoint to find longjmp() */
80 bp_longjmp_resume, /* secret breakpoint to escape longjmp() */
82 /* Breakpoint placed to the same location(s) like bp_longjmp but used to
83 protect against stale DUMMY_FRAME. Multiple bp_longjmp_call_dummy and
84 one bp_call_dummy are chained together by related_breakpoint for each
86 bp_longjmp_call_dummy,
88 /* An internal breakpoint that is installed on the unwinder's
91 /* An internal breakpoint that is set at the point where an
92 exception will land. */
95 /* Used by wait_for_inferior for stepping over subroutine calls,
96 and for skipping prologues. */
99 /* Used by wait_for_inferior for stepping over signal
103 /* Used to detect when a watchpoint expression has gone out of
104 scope. These breakpoints are usually not visible to the user.
106 This breakpoint has some interesting properties:
108 1) There's always a 1:1 mapping between watchpoints
109 on local variables and watchpoint_scope breakpoints.
111 2) It automatically deletes itself and the watchpoint it's
112 associated with when hit.
114 3) It can never be disabled. */
117 /* The breakpoint at the end of a call dummy. See bp_longjmp_call_dummy it
118 is chained with by related_breakpoint. */
121 /* A breakpoint set on std::terminate, that is used to catch
122 otherwise uncaught exceptions thrown during an inferior call. */
125 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
126 code in the inferior to run when significant events occur in the
127 dynamic linker (for example a library is loaded or unloaded).
129 By placing a breakpoint in this magic code GDB will get control
130 when these significant events occur. GDB can then re-examine
131 the dynamic linker's data structures to discover any newly loaded
132 dynamic libraries. */
135 /* Some multi-threaded systems can arrange for a location in the
136 inferior to be executed when certain thread-related events occur
137 (such as thread creation or thread death).
139 By placing a breakpoint at one of these locations, GDB will get
140 control when these events occur. GDB can then update its thread
145 /* On the same principal, an overlay manager can arrange to call a
146 magic location in the inferior whenever there is an interesting
147 change in overlay status. GDB can update its overlay tables
148 and fiddle with breakpoints in overlays when this breakpoint
153 /* Master copies of longjmp breakpoints. These are always installed
154 as soon as an objfile containing longjmp is loaded, but they are
155 always disabled. While necessary, temporary clones of bp_longjmp
156 type will be created and enabled. */
160 /* Master copies of std::terminate breakpoints. */
161 bp_std_terminate_master,
163 /* Like bp_longjmp_master, but for exceptions. */
170 bp_static_tracepoint,
172 /* A dynamic printf stops at the given location, does a formatted
173 print, then automatically continues. (Although this is sort of
174 like a macro packaging up standard breakpoint functionality,
175 GDB doesn't have a way to construct types of breakpoint from
176 elements of behavior.) */
179 /* Event for JIT compiled code generation or deletion. */
182 /* Breakpoint is placed at the STT_GNU_IFUNC resolver. When hit GDB
183 inserts new bp_gnu_ifunc_resolver_return at the caller.
184 bp_gnu_ifunc_resolver is still being kept here as a different thread
185 may still hit it before bp_gnu_ifunc_resolver_return is hit by the
187 bp_gnu_ifunc_resolver,
189 /* On its hit GDB now know the resolved address of the target
190 STT_GNU_IFUNC function. Associated bp_gnu_ifunc_resolver can be
191 deleted now and the breakpoint moved to the target function entry
193 bp_gnu_ifunc_resolver_return,
196 /* States of enablement of breakpoint. */
200 bp_disabled, /* The eventpoint is inactive, and cannot
202 bp_enabled, /* The eventpoint is active, and can
204 bp_call_disabled, /* The eventpoint has been disabled while a
205 call into the inferior is "in flight",
206 because some eventpoints interfere with
207 the implementation of a call on some
208 targets. The eventpoint will be
209 automatically enabled and reset when the
210 call "lands" (either completes, or stops
211 at another eventpoint). */
215 /* Disposition of breakpoint. Ie: what to do after hitting it. */
219 disp_del, /* Delete it */
220 disp_del_at_next_stop, /* Delete at next stop,
221 whether hit or not */
222 disp_disable, /* Disable it */
223 disp_donttouch /* Leave it alone */
226 /* Status of breakpoint conditions used when synchronizing
227 conditions with the target. */
229 enum condition_status
231 condition_unchanged = 0,
236 /* Information used by targets to insert and remove breakpoints. */
238 struct bp_target_info
240 /* Address space at which the breakpoint was placed. */
241 struct address_space *placed_address_space;
243 /* Address at which the breakpoint was placed. This is normally
244 the same as REQUESTED_ADDRESS, except when adjustment happens in
245 gdbarch_breakpoint_from_pc. The most common form of adjustment
246 is stripping an alternate ISA marker from the PC which is used
247 to determine the type of breakpoint to insert. */
248 CORE_ADDR placed_address;
250 /* Address at which the breakpoint was requested. */
251 CORE_ADDR reqstd_address;
253 /* If this is a ranged breakpoint, then this field contains the
254 length of the range that will be watched for execution. */
257 /* If the breakpoint lives in memory and reading that memory would
258 give back the breakpoint, instead of the original contents, then
259 the original contents are cached here. Only SHADOW_LEN bytes of
260 this buffer are valid, and only when the breakpoint is inserted. */
261 gdb_byte shadow_contents[BREAKPOINT_MAX];
263 /* The length of the data cached in SHADOW_CONTENTS. */
266 /* The breakpoint's kind. It is used in 'kind' parameter in Z
270 /* Conditions the target should evaluate if it supports target-side
271 breakpoint conditions. These are non-owning pointers. */
272 std::vector<agent_expr *> conditions;
274 /* Commands the target should evaluate if it supports target-side
275 breakpoint commands. These are non-owning pointers. */
276 std::vector<agent_expr *> tcommands;
278 /* Flag that is true if the breakpoint should be left in place even
279 when GDB is not connected. */
283 /* GDB maintains two types of information about each breakpoint (or
284 watchpoint, or other related event). The first type corresponds
285 to struct breakpoint; this is a relatively high-level structure
286 which contains the source location(s), stopping conditions, user
287 commands to execute when the breakpoint is hit, and so forth.
289 The second type of information corresponds to struct bp_location.
290 Each breakpoint has one or (eventually) more locations associated
291 with it, which represent target-specific and machine-specific
292 mechanisms for stopping the program. For instance, a watchpoint
293 expression may require multiple hardware watchpoints in order to
294 catch all changes in the value of the expression being watched. */
298 bp_loc_software_breakpoint,
299 bp_loc_hardware_breakpoint,
300 bp_loc_hardware_watchpoint,
301 bp_loc_other /* Miscellaneous... */
304 /* This structure is a collection of function pointers that, if
305 available, will be called instead of performing the default action
306 for this bp_loc_type. */
308 struct bp_location_ops
310 /* Destructor. Releases everything from SELF (but not SELF
312 void (*dtor) (struct bp_location *self);
318 bp_location () = default;
320 bp_location (const bp_location_ops *ops, breakpoint *owner);
322 /* Chain pointer to the next breakpoint location for
323 the same parent breakpoint. */
324 bp_location *next = NULL;
326 /* Methods associated with this location. */
327 const bp_location_ops *ops = NULL;
329 /* The reference count. */
332 /* Type of this breakpoint location. */
333 bp_loc_type loc_type {};
335 /* Each breakpoint location must belong to exactly one higher-level
336 breakpoint. This pointer is NULL iff this bp_location is no
337 longer attached to a breakpoint. For example, when a breakpoint
338 is deleted, its locations may still be found in the
339 moribund_locations list, or if we had stopped for it, in
341 breakpoint *owner = NULL;
343 /* Conditional. Break only if this expression's value is nonzero.
344 Unlike string form of condition, which is associated with
345 breakpoint, this is associated with location, since if breakpoint
346 has several locations, the evaluation of expression can be
347 different for different locations. Only valid for real
348 breakpoints; a watchpoint's conditional expression is stored in
349 the owner breakpoint object. */
352 /* Conditional expression in agent expression
353 bytecode form. This is used for stub-side breakpoint
354 condition evaluation. */
355 agent_expr_up cond_bytecode;
357 /* Signals that the condition has changed since the last time
358 we updated the global location list. This means the condition
359 needs to be sent to the target again. This is used together
360 with target-side breakpoint conditions.
362 condition_unchanged: It means there has been no condition changes.
364 condition_modified: It means this location had its condition modified.
366 condition_updated: It means we already marked all the locations that are
367 duplicates of this location and thus we don't need to call
368 force_breakpoint_reinsertion (...) for this location. */
370 condition_status condition_changed {};
372 agent_expr_up cmd_bytecode;
374 /* Signals that breakpoint conditions and/or commands need to be
375 re-synched with the target. This has no use other than
376 target-side breakpoints. */
377 bool needs_update = false;
379 /* This location's address is in an unloaded solib, and so this
380 location should not be inserted. It will be automatically
381 enabled when that solib is loaded. */
382 bool shlib_disabled = false;
384 /* Is this particular location enabled. */
385 bool enabled = false;
387 /* Nonzero if this breakpoint is now inserted. */
388 bool inserted = false;
390 /* Nonzero if this is a permanent breakpoint. There is a breakpoint
391 instruction hard-wired into the target's code. Don't try to
392 write another breakpoint instruction on top of it, or restore its
393 value. Step over it using the architecture's
394 gdbarch_skip_permanent_breakpoint method. */
395 bool permanent = false;
397 /* Nonzero if this is not the first breakpoint in the list
398 for the given address. location of tracepoint can _never_
399 be duplicated with other locations of tracepoints and other
400 kinds of breakpoints, because two locations at the same
401 address may have different actions, so both of these locations
402 should be downloaded and so that `tfind N' always works. */
403 bool duplicate = false;
405 /* If we someday support real thread-specific breakpoints, then
406 the breakpoint location will need a thread identifier. */
408 /* Data for specific breakpoint types. These could be a union, but
409 simplicity is more important than memory usage for breakpoints. */
411 /* Architecture associated with this location's address. May be
412 different from the breakpoint architecture. */
413 struct gdbarch *gdbarch = NULL;
415 /* The program space associated with this breakpoint location
416 address. Note that an address space may be represented in more
417 than one program space (e.g. each uClinux program will be given
418 its own program space, but there will only be one address space
419 for all of them), but we must not insert more than one location
420 at the same address in the same address space. */
421 program_space *pspace = NULL;
423 /* Note that zero is a perfectly valid code address on some platforms
424 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
425 is not a special value for this field. Valid for all types except
427 CORE_ADDR address = 0;
429 /* For hardware watchpoints, the size of the memory region being
430 watched. For hardware ranged breakpoints, the size of the
434 /* Type of hardware watchpoint. */
435 target_hw_bp_type watchpoint_type {};
437 /* For any breakpoint type with an address, this is the section
438 associated with the address. Used primarily for overlay
440 obj_section *section = NULL;
442 /* Address at which breakpoint was requested, either by the user or
443 by GDB for internal breakpoints. This will usually be the same
444 as ``address'' (above) except for cases in which
445 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
446 which to place the breakpoint in order to comply with a
447 processor's architectual constraints. */
448 CORE_ADDR requested_address = 0;
450 /* An additional address assigned with this location. This is currently
451 only used by STT_GNU_IFUNC resolver breakpoints to hold the address
452 of the resolver function. */
453 CORE_ADDR related_address = 0;
455 /* If the location comes from a probe point, this is the probe associated
457 bound_probe probe {};
459 char *function_name = NULL;
461 /* Details of the placed breakpoint, when inserted. */
462 bp_target_info target_info {};
464 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
465 bp_target_info overlay_target_info {};
467 /* In a non-stop mode, it's possible that we delete a breakpoint,
468 but as we do that, some still running thread hits that breakpoint.
469 For that reason, we need to keep locations belonging to deleted
470 breakpoints for a bit, so that don't report unexpected SIGTRAP.
471 We can't keep such locations forever, so we use a heuristic --
472 after we process certain number of inferior events since
473 breakpoint was deleted, we retire all locations of that breakpoint.
474 This variable keeps a number of events still to go, when
475 it becomes 0 this location is retired. */
476 int events_till_retirement = 0;
478 /* Line number which was used to place this location.
480 Breakpoint placed into a comment keeps it's user specified line number
481 despite ADDRESS resolves into a different line number. */
485 /* Symtab which was used to place this location. This is used
486 to find the corresponding source file name. */
488 struct symtab *symtab = NULL;
491 /* The possible return values for print_bpstat, print_it_normal,
492 print_it_done, print_it_noop. */
493 enum print_stop_action
495 /* We printed nothing or we need to do some more analysis. */
498 /* We printed something, and we *do* desire that something to be
499 followed by a location. */
502 /* We printed something, and we do *not* desire that something to be
503 followed by a location. */
506 /* We already printed all we needed to print, don't print anything
511 /* This structure is a collection of function pointers that, if available,
512 will be called instead of the performing the default action for this
515 struct breakpoint_ops
517 /* Allocate a location for this breakpoint. */
518 struct bp_location * (*allocate_location) (struct breakpoint *);
520 /* Reevaluate a breakpoint. This is necessary after symbols change
521 (e.g., an executable or DSO was loaded, or the inferior just
523 void (*re_set) (struct breakpoint *self);
525 /* Insert the breakpoint or watchpoint or activate the catchpoint.
526 Return 0 for success, 1 if the breakpoint, watchpoint or
527 catchpoint type is not supported, -1 for failure. */
528 int (*insert_location) (struct bp_location *);
530 /* Remove the breakpoint/catchpoint that was previously inserted
531 with the "insert" method above. Return 0 for success, 1 if the
532 breakpoint, watchpoint or catchpoint type is not supported,
534 int (*remove_location) (struct bp_location *, enum remove_bp_reason reason);
536 /* Return true if it the target has stopped due to hitting
537 breakpoint location BL. This function does not check if we
538 should stop, only if BL explains the stop. ASPACE is the address
539 space in which the event occurred, BP_ADDR is the address at
540 which the inferior stopped, and WS is the target_waitstatus
541 describing the event. */
542 int (*breakpoint_hit) (const struct bp_location *bl,
543 struct address_space *aspace,
545 const struct target_waitstatus *ws);
547 /* Check internal conditions of the breakpoint referred to by BS.
548 If we should not stop for this breakpoint, set BS->stop to 0. */
549 void (*check_status) (struct bpstats *bs);
551 /* Tell how many hardware resources (debug registers) are needed
552 for this breakpoint. If this function is not provided, then
553 the breakpoint or watchpoint needs one debug register. */
554 int (*resources_needed) (const struct bp_location *);
556 /* Tell whether we can downgrade from a hardware watchpoint to a software
557 one. If not, the user will not be able to enable the watchpoint when
558 there are not enough hardware resources available. */
559 int (*works_in_software_mode) (const struct breakpoint *);
561 /* The normal print routine for this breakpoint, called when we
563 enum print_stop_action (*print_it) (struct bpstats *bs);
565 /* Display information about this breakpoint, for "info
567 void (*print_one) (struct breakpoint *, struct bp_location **);
569 /* Display extra information about this breakpoint, below the normal
570 breakpoint description in "info breakpoints".
572 In the example below, the "address range" line was printed
573 by print_one_detail_ranged_breakpoint.
575 (gdb) info breakpoints
576 Num Type Disp Enb Address What
577 2 hw breakpoint keep y in main at test-watch.c:70
578 address range: [0x10000458, 0x100004c7]
581 void (*print_one_detail) (const struct breakpoint *, struct ui_out *);
583 /* Display information about this breakpoint after setting it
584 (roughly speaking; this is called from "mention"). */
585 void (*print_mention) (struct breakpoint *);
587 /* Print to FP the CLI command that recreates this breakpoint. */
588 void (*print_recreate) (struct breakpoint *, struct ui_file *fp);
590 /* Create SALs from location, storing the result in linespec_result.
592 For an explanation about the arguments, see the function
593 `create_sals_from_location_default'.
595 This function is called inside `create_breakpoint'. */
596 void (*create_sals_from_location) (const struct event_location *location,
597 struct linespec_result *canonical,
598 enum bptype type_wanted);
600 /* This method will be responsible for creating a breakpoint given its SALs.
601 Usually, it just calls `create_breakpoints_sal' (for ordinary
602 breakpoints). However, there may be some special cases where we might
603 need to do some tweaks, e.g., see
604 `strace_marker_create_breakpoints_sal'.
606 This function is called inside `create_breakpoint'. */
607 void (*create_breakpoints_sal) (struct gdbarch *,
608 struct linespec_result *,
609 gdb::unique_xmalloc_ptr<char>,
610 gdb::unique_xmalloc_ptr<char>,
611 enum bptype, enum bpdisp, int, int,
612 int, const struct breakpoint_ops *,
613 int, int, int, unsigned);
615 /* Given the location (second parameter), this method decodes it and
616 returns the SAL locations related to it. For ordinary
617 breakpoints, it calls `decode_line_full'. If SEARCH_PSPACE is
618 not NULL, symbol search is restricted to just that program space.
620 This function is called inside `location_to_sals'. */
621 std::vector<symtab_and_line> (*decode_location)
622 (struct breakpoint *b,
623 const struct event_location *location,
624 struct program_space *search_pspace);
626 /* Return true if this breakpoint explains a signal. See
627 bpstat_explains_signal. */
628 int (*explains_signal) (struct breakpoint *, enum gdb_signal);
630 /* Called after evaluating the breakpoint's condition,
631 and only if it evaluated true. */
632 void (*after_condition_true) (struct bpstats *bs);
635 /* Helper for breakpoint_ops->print_recreate implementations. Prints
636 the "thread" or "task" condition of B, and then a newline.
638 Necessary because most breakpoint implementations accept
639 thread/task conditions at the end of the spec line, like "break foo
640 thread 1", which needs outputting before any breakpoint-type
641 specific extra command necessary for B's recreation. */
642 extern void print_recreate_thread (struct breakpoint *b, struct ui_file *fp);
644 enum watchpoint_triggered
646 /* This watchpoint definitely did not trigger. */
647 watch_triggered_no = 0,
649 /* Some hardware watchpoint triggered, and it might have been this
650 one, but we do not know which it was. */
651 watch_triggered_unknown,
653 /* This hardware watchpoint definitely did trigger. */
657 typedef struct bp_location *bp_location_p;
658 DEF_VEC_P(bp_location_p);
660 /* A reference-counted struct command_line. This lets multiple
661 breakpoints share a single command list. This is an implementation
662 detail to the breakpoints module. */
663 struct counted_command_line;
665 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
666 a watchpoint over a memory region. If this flag is true, GDB will use
667 only one register per watchpoint, thus assuming that all acesses that
668 modify a memory location happen at its starting address. */
670 extern int target_exact_watchpoints;
672 /* Note that the ->silent field is not currently used by any commands
673 (though the code is in there if it was to be, and set_raw_breakpoint
674 does set it to 0). I implemented it because I thought it would be
675 useful for a hack I had to put in; I'm going to leave it in because
676 I can see how there might be times when it would indeed be useful */
678 /* This is for all kinds of breakpoints. */
682 virtual ~breakpoint ();
684 /* Methods associated with this breakpoint. */
685 const breakpoint_ops *ops = NULL;
687 breakpoint *next = NULL;
688 /* Type of breakpoint. */
689 bptype type = bp_none;
690 /* Zero means disabled; remember the info but don't break here. */
691 enum enable_state enable_state = bp_enabled;
692 /* What to do with this breakpoint after we hit it. */
693 bpdisp disposition = disp_del;
694 /* Number assigned to distinguish breakpoints. */
697 /* Location(s) associated with this high-level breakpoint. */
698 bp_location *loc = NULL;
700 /* True means a silent breakpoint (don't print frame info if we stop
703 /* True means display ADDR_STRING to the user verbatim. */
704 bool display_canonical = false;
705 /* Number of stops at this breakpoint that should be continued
706 automatically before really stopping. */
707 int ignore_count = 0;
709 /* Number of stops at this breakpoint before it will be
711 int enable_count = 0;
713 /* Chain of command lines to execute when this breakpoint is
715 counted_command_line *commands = NULL;
716 /* Stack depth (address of frame). If nonzero, break only if fp
718 struct frame_id frame_id = null_frame_id;
720 /* The program space used to set the breakpoint. This is only set
721 for breakpoints which are specific to a program space; for
722 non-thread-specific ordinary breakpoints this is NULL. */
723 program_space *pspace = NULL;
725 /* Location we used to set the breakpoint. */
726 event_location_up location;
728 /* The filter that should be passed to decode_line_full when
729 re-setting this breakpoint. This may be NULL, but otherwise is
730 allocated with xmalloc. */
733 /* For a ranged breakpoint, the location we used to find the end of
735 event_location_up location_range_end;
737 /* Architecture we used to set the breakpoint. */
738 struct gdbarch *gdbarch = NULL;
739 /* Language we used to set the breakpoint. */
740 enum language language = language_unknown;
741 /* Input radix we used to set the breakpoint. */
743 /* String form of the breakpoint condition (malloc'd), or NULL if
744 there is no condition. */
745 char *cond_string = NULL;
747 /* String form of extra parameters, or NULL if there are none.
749 char *extra_string = NULL;
751 /* Holds the address of the related watchpoint_scope breakpoint when
752 using watchpoints on local variables (might the concept of a
753 related breakpoint be useful elsewhere, if not just call it the
754 watchpoint_scope breakpoint or something like that. FIXME). */
755 breakpoint *related_breakpoint = NULL;
757 /* Thread number for thread-specific breakpoint, or -1 if don't
761 /* Ada task number for task-specific breakpoint, or 0 if don't
765 /* Count of the number of times this breakpoint was taken, dumped
766 with the info, but not used for anything else. Useful for seeing
767 how many times you hit a break prior to the program aborting, so
768 you can back up to just before the abort. */
771 /* Is breakpoint's condition not yet parsed because we found no
772 location initially so had no context to parse the condition
774 int condition_not_parsed = 0;
776 /* With a Python scripting enabled GDB, store a reference to the
777 Python object that has been associated with this breakpoint.
778 This is always NULL for a GDB that is not script enabled. It can
779 sometimes be NULL for enabled GDBs as not all breakpoint types
780 are tracked by the scripting language API. */
781 gdbpy_breakpoint_object *py_bp_object = NULL;
783 /* Same as py_bp_object, but for Scheme. */
784 gdbscm_breakpoint_object *scm_bp_object = NULL;
787 /* An instance of this type is used to represent a watchpoint. */
789 struct watchpoint : public breakpoint
791 ~watchpoint () override;
793 /* String form of exp to use for displaying to the user (malloc'd),
796 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
797 char *exp_string_reparse;
799 /* The expression we are watching, or NULL if not a watchpoint. */
801 /* The largest block within which it is valid, or NULL if it is
802 valid anywhere (e.g. consists just of global symbols). */
803 const struct block *exp_valid_block;
804 /* The conditional expression if any. */
805 expression_up cond_exp;
806 /* The largest block within which it is valid, or NULL if it is
807 valid anywhere (e.g. consists just of global symbols). */
808 const struct block *cond_exp_valid_block;
809 /* Value of the watchpoint the last time we checked it, or NULL when
810 we do not know the value yet or the value was not readable. VAL
813 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
814 then an error occurred reading the value. */
817 /* When watching the location of a bitfield, contains the offset and size of
818 the bitfield. Otherwise contains 0. */
822 /* Holds the frame address which identifies the frame this
823 watchpoint should be evaluated in, or `null' if the watchpoint
824 should be evaluated on the outermost frame. */
825 struct frame_id watchpoint_frame;
827 /* Holds the thread which identifies the frame this watchpoint
828 should be considered in scope for, or `null_ptid' if the
829 watchpoint should be evaluated in all threads. */
830 ptid_t watchpoint_thread;
832 /* For hardware watchpoints, the triggered status according to the
834 enum watchpoint_triggered watchpoint_triggered;
836 /* Whether this watchpoint is exact (see
837 target_exact_watchpoints). */
840 /* The mask address for a masked hardware watchpoint. */
841 CORE_ADDR hw_wp_mask;
844 /* Given a function FUNC (struct breakpoint *B, void *DATA) and
845 USER_DATA, call FUNC for every known breakpoint passing USER_DATA
848 If FUNC returns 1, the loop stops and the current
849 'struct breakpoint' being processed is returned. If FUNC returns
850 zero, the loop continues.
852 This function returns either a 'struct breakpoint' pointer or NULL.
853 It was based on BFD's bfd_sections_find_if function. */
855 extern struct breakpoint *breakpoint_find_if
856 (int (*func) (struct breakpoint *b, void *d), void *user_data);
858 /* Return true if BPT is either a software breakpoint or a hardware
861 extern int is_breakpoint (const struct breakpoint *bpt);
863 /* Returns true if BPT is really a watchpoint. */
865 extern int is_watchpoint (const struct breakpoint *bpt);
867 /* An instance of this type is used to represent all kinds of
870 struct tracepoint : public breakpoint
872 /* Number of times this tracepoint should single-step and collect
876 /* Number of times this tracepoint should be hit before
880 /* The number of the tracepoint on the target. */
881 int number_on_target;
883 /* The total space taken by all the trace frames for this
885 ULONGEST traceframe_usage;
887 /* The static tracepoint marker id, if known. */
888 char *static_trace_marker_id;
890 /* LTTng/UST allow more than one marker with the same ID string,
891 although it unadvised because it confuses tools. When setting
892 static tracepoints by marker ID, this will record the index in
893 the array of markers we found for the given marker ID for which
894 this static tracepoint corresponds. When resetting breakpoints,
895 we will use this index to try to find the same marker again. */
896 int static_trace_marker_id_idx;
899 typedef struct breakpoint *breakpoint_p;
900 DEF_VEC_P(breakpoint_p);
902 /* The following stuff is an abstract data type "bpstat" ("breakpoint
903 status"). This provides the ability to determine whether we have
904 stopped at a breakpoint, and what we should do about it. */
906 typedef struct bpstats *bpstat;
908 /* Clears a chain of bpstat, freeing storage
910 extern void bpstat_clear (bpstat *);
912 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
913 is part of the bpstat is copied as well. */
914 extern bpstat bpstat_copy (bpstat);
916 extern bpstat bpstat_stop_status (struct address_space *aspace,
917 CORE_ADDR pc, ptid_t ptid,
918 const struct target_waitstatus *ws);
920 /* This bpstat_what stuff tells wait_for_inferior what to do with a
921 breakpoint (a challenging task).
923 The enum values order defines priority-like order of the actions.
924 Once you've decided that some action is appropriate, you'll never
925 go back and decide something of a lower priority is better. Each
926 of these actions is mutually exclusive with the others. That
927 means, that if you find yourself adding a new action class here and
928 wanting to tell GDB that you have two simultaneous actions to
929 handle, something is wrong, and you probably don't actually need a
932 Note that a step resume breakpoint overrides another breakpoint of
933 signal handling (see comment in wait_for_inferior at where we set
934 the step_resume breakpoint). */
936 enum bpstat_what_main_action
938 /* Perform various other tests; that is, this bpstat does not
939 say to perform any action (e.g. failed watchpoint and nothing
941 BPSTAT_WHAT_KEEP_CHECKING,
943 /* Remove breakpoints, single step once, then put them back in and
944 go back to what we were doing. It's possible that this should
945 be removed from the main_action and put into a separate field,
946 to more cleanly handle
947 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
950 /* Set longjmp_resume breakpoint, remove all other breakpoints,
951 and continue. The "remove all other breakpoints" part is
952 required if we are also stepping over another breakpoint as
953 well as doing the longjmp handling. */
954 BPSTAT_WHAT_SET_LONGJMP_RESUME,
956 /* Clear longjmp_resume breakpoint, then handle as
957 BPSTAT_WHAT_KEEP_CHECKING. */
958 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
960 /* Clear step resume breakpoint, and keep checking. */
961 BPSTAT_WHAT_STEP_RESUME,
963 /* Rather than distinguish between noisy and silent stops here, it
964 might be cleaner to have bpstat_print make that decision (also
965 taking into account stop_print_frame and source_only). But the
966 implications are a bit scary (interaction with auto-displays,
967 etc.), so I won't try it. */
970 BPSTAT_WHAT_STOP_SILENT,
972 /* Stop and print. */
973 BPSTAT_WHAT_STOP_NOISY,
975 /* Clear step resume breakpoint, and keep checking. High-priority
976 step-resume breakpoints are used when even if there's a user
977 breakpoint at the current PC when we set the step-resume
978 breakpoint, we don't want to re-handle any breakpoint other
979 than the step-resume when it's hit; instead we want to move
980 past the breakpoint. This is used in the case of skipping
982 BPSTAT_WHAT_HP_STEP_RESUME,
985 /* An enum indicating the kind of "stack dummy" stop. This is a bit
986 of a misnomer because only one kind of truly a stack dummy. */
989 /* We didn't stop at a stack dummy breakpoint. */
992 /* Stopped at a stack dummy. */
995 /* Stopped at std::terminate. */
1001 enum bpstat_what_main_action main_action;
1003 /* Did we hit a call dummy breakpoint? This only goes with a
1004 main_action of BPSTAT_WHAT_STOP_SILENT or
1005 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
1006 dummy without popping the frame is not a useful one). */
1007 enum stop_stack_kind call_dummy;
1009 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
1010 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
1011 longjmp, false if we are handling an exception. */
1015 /* Tell what to do about this bpstat. */
1016 struct bpstat_what bpstat_what (bpstat);
1018 /* Run breakpoint event callbacks associated with the breakpoints that
1020 extern void bpstat_run_callbacks (bpstat bs_head);
1022 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
1023 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
1025 /* Nonzero if a signal that we got in target_wait() was due to
1026 circumstances explained by the bpstat; the signal is therefore not
1028 extern int bpstat_explains_signal (bpstat, enum gdb_signal);
1030 /* Nonzero is this bpstat causes a stop. */
1031 extern int bpstat_causes_stop (bpstat);
1033 /* Nonzero if we should step constantly (e.g. watchpoints on machines
1034 without hardware support). This isn't related to a specific bpstat,
1035 just to things like whether watchpoints are set. */
1036 extern int bpstat_should_step (void);
1038 /* Print a message indicating what happened. Returns nonzero to
1039 say that only the source line should be printed after this (zero
1040 return means print the frame as well as the source line). */
1041 extern enum print_stop_action bpstat_print (bpstat, int);
1043 /* Put in *NUM the breakpoint number of the first breakpoint we are
1044 stopped at. *BSP upon return is a bpstat which points to the
1045 remaining breakpoints stopped at (but which is not guaranteed to be
1046 good for anything but further calls to bpstat_num).
1048 Return 0 if passed a bpstat which does not indicate any breakpoints.
1049 Return -1 if stopped at a breakpoint that has been deleted since
1051 Return 1 otherwise. */
1052 extern int bpstat_num (bpstat *, int *);
1054 /* Perform actions associated with the stopped inferior. Actually, we
1055 just use this for breakpoint commands. Perhaps other actions will
1056 go here later, but this is executed at a late time (from the
1058 extern void bpstat_do_actions (void);
1060 /* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will
1061 not be performed. */
1062 extern void bpstat_clear_actions (void);
1064 /* Implementation: */
1066 /* Values used to tell the printing routine how to behave for this
1070 /* This is used when we want to do a normal printing of the reason
1071 for stopping. The output will depend on the type of eventpoint
1072 we are dealing with. This is the default value, most commonly
1075 /* This is used when nothing should be printed for this bpstat
1078 /* This is used when everything which needs to be printed has
1079 already been printed. But we still want to print the frame. */
1086 bpstats (struct bp_location *bl, bpstat **bs_link_pointer);
1089 bpstats (const bpstats &);
1090 bpstats &operator= (const bpstats &) = delete;
1092 /* Linked list because there can be more than one breakpoint at
1093 the same place, and a bpstat reflects the fact that all have
1097 /* Location that caused the stop. Locations are refcounted, so
1098 this will never be NULL. Note that this location may end up
1099 detached from a breakpoint, but that does not necessary mean
1100 that the struct breakpoint is gone. E.g., consider a
1101 watchpoint with a condition that involves an inferior function
1102 call. Watchpoint locations are recreated often (on resumes,
1103 hence on infcalls too). Between creating the bpstat and after
1104 evaluating the watchpoint condition, this location may hence
1105 end up detached from its original owner watchpoint, even though
1106 the watchpoint is still listed. If it's condition evaluates as
1107 true, we still want this location to cause a stop, and we will
1108 still need to know which watchpoint it was originally attached.
1109 What this means is that we should not (in most cases) follow
1110 the `bpstat->bp_location->owner' link, but instead use the
1111 `breakpoint_at' field below. */
1112 struct bp_location *bp_location_at;
1114 /* Breakpoint that caused the stop. This is nullified if the
1115 breakpoint ends up being deleted. See comments on
1116 `bp_location_at' above for why do we need this field instead of
1117 following the location's owner. */
1118 struct breakpoint *breakpoint_at;
1120 /* The associated command list. */
1121 struct counted_command_line *commands;
1123 /* Old value associated with a watchpoint. */
1124 struct value *old_val;
1126 /* Nonzero if this breakpoint tells us to print the frame. */
1129 /* Nonzero if this breakpoint tells us to stop. */
1132 /* Tell bpstat_print and print_bp_stop_message how to print stuff
1133 associated with this element of the bpstat chain. */
1134 enum bp_print_how print_it;
1145 /* The possible return values for breakpoint_here_p.
1146 We guarantee that zero always means "no breakpoint here". */
1147 enum breakpoint_here
1149 no_breakpoint_here = 0,
1150 ordinary_breakpoint_here,
1151 permanent_breakpoint_here
1155 /* Prototypes for breakpoint-related functions. */
1157 /* Return 1 if there's a program/permanent breakpoint planted in
1158 memory at ADDRESS, return 0 otherwise. */
1160 extern int program_breakpoint_here_p (struct gdbarch *gdbarch, CORE_ADDR address);
1162 extern enum breakpoint_here breakpoint_here_p (struct address_space *,
1165 /* Return true if an enabled breakpoint exists in the range defined by
1166 ADDR and LEN, in ASPACE. */
1167 extern int breakpoint_in_range_p (struct address_space *aspace,
1168 CORE_ADDR addr, ULONGEST len);
1170 extern int moribund_breakpoint_here_p (struct address_space *, CORE_ADDR);
1172 extern int breakpoint_inserted_here_p (struct address_space *, CORE_ADDR);
1174 extern int regular_breakpoint_inserted_here_p (struct address_space *,
1177 extern int software_breakpoint_inserted_here_p (struct address_space *,
1180 /* Return non-zero iff there is a hardware breakpoint inserted at
1182 extern int hardware_breakpoint_inserted_here_p (struct address_space *,
1185 /* Check whether any location of BP is inserted at PC. */
1187 extern int breakpoint_has_location_inserted_here (struct breakpoint *bp,
1188 struct address_space *aspace,
1191 extern int single_step_breakpoint_inserted_here_p (struct address_space *,
1194 /* Returns true if there's a hardware watchpoint or access watchpoint
1195 inserted in the range defined by ADDR and LEN. */
1196 extern int hardware_watchpoint_inserted_in_range (struct address_space *,
1200 /* Returns true if {ASPACE1,ADDR1} and {ASPACE2,ADDR2} represent the
1201 same breakpoint location. In most targets, this can only be true
1202 if ASPACE1 matches ASPACE2. On targets that have global
1203 breakpoints, the address space doesn't really matter. */
1205 extern int breakpoint_address_match (struct address_space *aspace1,
1207 struct address_space *aspace2,
1210 extern void until_break_command (char *, int, int);
1212 /* Initialize a struct bp_location. */
1214 extern void update_breakpoint_locations
1215 (struct breakpoint *b,
1216 struct program_space *filter_pspace,
1217 gdb::array_view<const symtab_and_line> sals,
1218 gdb::array_view<const symtab_and_line> sals_end);
1220 extern void breakpoint_re_set (void);
1222 extern void breakpoint_re_set_thread (struct breakpoint *);
1224 extern struct breakpoint *set_momentary_breakpoint
1225 (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype);
1227 extern struct breakpoint *set_momentary_breakpoint_at_pc
1228 (struct gdbarch *, CORE_ADDR pc, enum bptype type);
1230 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt);
1232 extern void set_ignore_count (int, int, int);
1234 extern void breakpoint_init_inferior (enum inf_context);
1236 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
1238 extern void delete_breakpoint (struct breakpoint *);
1240 extern void breakpoint_auto_delete (bpstat);
1242 typedef void (*walk_bp_location_callback) (struct bp_location *, void *);
1244 extern void iterate_over_bp_locations (walk_bp_location_callback);
1246 /* Return the chain of command lines to execute when this breakpoint
1248 extern struct command_line *breakpoint_commands (struct breakpoint *b);
1250 /* Return a string image of DISP. The string is static, and thus should
1251 NOT be deallocated after use. */
1252 const char *bpdisp_text (enum bpdisp disp);
1254 extern void break_command (char *, int);
1256 extern void hbreak_command_wrapper (char *, int);
1257 extern void thbreak_command_wrapper (char *, int);
1258 extern void rbreak_command_wrapper (char *, int);
1259 extern void watch_command_wrapper (char *, int, int);
1260 extern void awatch_command_wrapper (char *, int, int);
1261 extern void rwatch_command_wrapper (char *, int, int);
1262 extern void tbreak_command (char *, int);
1264 extern struct breakpoint_ops base_breakpoint_ops;
1265 extern struct breakpoint_ops bkpt_breakpoint_ops;
1266 extern struct breakpoint_ops tracepoint_breakpoint_ops;
1267 extern struct breakpoint_ops dprintf_breakpoint_ops;
1269 extern void initialize_breakpoint_ops (void);
1271 /* Arguments to pass as context to some catch command handlers. */
1272 #define CATCH_PERMANENT ((void *) (uintptr_t) 0)
1273 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
1275 /* Like add_cmd, but add the command to both the "catch" and "tcatch"
1276 lists, and pass some additional user data to the command
1280 add_catch_command (const char *name, const char *docstring,
1281 cmd_sfunc_ftype *sfunc,
1282 completer_ftype *completer,
1283 void *user_data_catch,
1284 void *user_data_tcatch);
1286 /* Initialize a breakpoint struct for Ada exception catchpoints. */
1289 init_ada_exception_breakpoint (struct breakpoint *b,
1290 struct gdbarch *gdbarch,
1291 struct symtab_and_line sal,
1293 const struct breakpoint_ops *ops,
1298 extern void init_catchpoint (struct breakpoint *b,
1299 struct gdbarch *gdbarch, int tempflag,
1300 const char *cond_string,
1301 const struct breakpoint_ops *ops);
1303 /* Add breakpoint B on the breakpoint list, and notify the user, the
1304 target and breakpoint_created observers of its existence. If
1305 INTERNAL is non-zero, the breakpoint number will be allocated from
1306 the internal breakpoint count. If UPDATE_GLL is non-zero,
1307 update_global_location_list will be called. */
1309 extern void install_breakpoint (int internal, std::unique_ptr<breakpoint> &&b,
1312 /* Flags that can be passed down to create_breakpoint, etc., to affect
1313 breakpoint creation in several ways. */
1315 enum breakpoint_create_flags
1317 /* We're adding a breakpoint to our tables that is already
1318 inserted in the target. */
1319 CREATE_BREAKPOINT_FLAGS_INSERTED = 1 << 0
1322 /* Set a breakpoint. This function is shared between CLI and MI functions
1323 for setting a breakpoint at LOCATION.
1325 This function has two major modes of operations, selected by the
1326 PARSE_EXTRA parameter.
1328 If PARSE_EXTRA is zero, LOCATION is just the breakpoint's location,
1329 with condition, thread, and extra string specified by the COND_STRING,
1330 THREAD, and EXTRA_STRING parameters.
1332 If PARSE_EXTRA is non-zero, this function will attempt to extract
1333 the condition, thread, and extra string from EXTRA_STRING, ignoring
1334 the similarly named parameters.
1336 If INTERNAL is non-zero, the breakpoint number will be allocated
1337 from the internal breakpoint count.
1339 Returns true if any breakpoint was created; false otherwise. */
1341 extern int create_breakpoint (struct gdbarch *gdbarch,
1342 const struct event_location *location,
1343 const char *cond_string, int thread,
1344 const char *extra_string,
1346 int tempflag, enum bptype wanted_type,
1348 enum auto_boolean pending_break_support,
1349 const struct breakpoint_ops *ops,
1352 int internal, unsigned flags);
1354 extern void insert_breakpoints (void);
1356 extern int remove_breakpoints (void);
1358 extern int remove_breakpoints_pid (int pid);
1360 /* This function can be used to physically insert eventpoints from the
1361 specified traced inferior process, without modifying the breakpoint
1362 package's state. This can be useful for those targets which
1363 support following the processes of a fork() or vfork() system call,
1364 when both of the resulting two processes are to be followed. */
1365 extern int reattach_breakpoints (int);
1367 /* This function can be used to update the breakpoint package's state
1368 after an exec() system call has been executed.
1370 This function causes the following:
1372 - All eventpoints are marked "not inserted".
1373 - All eventpoints with a symbolic address are reset such that
1374 the symbolic address must be reevaluated before the eventpoints
1376 - The solib breakpoints are explicitly removed from the breakpoint
1378 - A step-resume breakpoint, if any, is explicitly removed from the
1380 - All eventpoints without a symbolic address are removed from the
1382 extern void update_breakpoints_after_exec (void);
1384 /* This function can be used to physically remove hardware breakpoints
1385 and watchpoints from the specified traced inferior process, without
1386 modifying the breakpoint package's state. This can be useful for
1387 those targets which support following the processes of a fork() or
1388 vfork() system call, when one of the resulting two processes is to
1389 be detached and allowed to run free.
1391 It is an error to use this function on the process whose id is
1393 extern int detach_breakpoints (ptid_t ptid);
1395 /* This function is called when program space PSPACE is about to be
1396 deleted. It takes care of updating breakpoints to not reference
1397 this PSPACE anymore. */
1398 extern void breakpoint_program_space_exit (struct program_space *pspace);
1400 extern void set_longjmp_breakpoint (struct thread_info *tp,
1401 struct frame_id frame);
1402 extern void delete_longjmp_breakpoint (int thread);
1404 /* Mark all longjmp breakpoints from THREAD for later deletion. */
1405 extern void delete_longjmp_breakpoint_at_next_stop (int thread);
1407 extern struct breakpoint *set_longjmp_breakpoint_for_call_dummy (void);
1408 extern void check_longjmp_breakpoint_for_call_dummy (struct thread_info *tp);
1410 extern void enable_overlay_breakpoints (void);
1411 extern void disable_overlay_breakpoints (void);
1413 extern void set_std_terminate_breakpoint (void);
1414 extern void delete_std_terminate_breakpoint (void);
1416 /* These functions respectively disable or reenable all currently
1417 enabled watchpoints. When disabled, the watchpoints are marked
1418 call_disabled. When re-enabled, they are marked enabled.
1420 The intended client of these functions is call_function_by_hand.
1422 The inferior must be stopped, and all breakpoints removed, when
1423 these functions are used.
1425 The need for these functions is that on some targets (e.g., HP-UX),
1426 gdb is unable to unwind through the dummy frame that is pushed as
1427 part of the implementation of a call command. Watchpoints can
1428 cause the inferior to stop in places where this frame is visible,
1429 and that can cause execution control to become very confused.
1431 Note that if a user sets breakpoints in an interactively called
1432 function, the call_disabled watchpoints will have been re-enabled
1433 when the first such breakpoint is reached. However, on targets
1434 that are unable to unwind through the call dummy frame, watches
1435 of stack-based storage may then be deleted, because gdb will
1436 believe that their watched storage is out of scope. (Sigh.) */
1437 extern void disable_watchpoints_before_interactive_call_start (void);
1439 extern void enable_watchpoints_after_interactive_call_stop (void);
1441 /* These functions disable and re-enable all breakpoints during
1442 inferior startup. They are intended to be called from solib
1443 code where necessary. This is needed on platforms where the
1444 main executable is relocated at some point during startup
1445 processing, making breakpoint addresses invalid.
1447 If additional breakpoints are created after the routine
1448 disable_breakpoints_before_startup but before the routine
1449 enable_breakpoints_after_startup was called, they will also
1450 be marked as disabled. */
1451 extern void disable_breakpoints_before_startup (void);
1452 extern void enable_breakpoints_after_startup (void);
1454 /* For script interpreters that need to define breakpoint commands
1455 after they've already read the commands into a struct
1457 extern enum command_control_type commands_from_control_command
1458 (const char *arg, struct command_line *cmd);
1460 extern void clear_breakpoint_hit_counts (void);
1462 extern struct breakpoint *get_breakpoint (int num);
1464 /* The following are for displays, which aren't really breakpoints,
1465 but here is as good a place as any for them. */
1467 extern void disable_current_display (void);
1469 extern void do_displays (void);
1471 extern void disable_display (int);
1473 extern void clear_displays (void);
1475 extern void disable_breakpoint (struct breakpoint *);
1477 extern void enable_breakpoint (struct breakpoint *);
1479 extern void breakpoint_set_commands (struct breakpoint *b,
1480 command_line_up &&commands);
1482 extern void breakpoint_set_silent (struct breakpoint *b, int silent);
1484 extern void breakpoint_set_thread (struct breakpoint *b, int thread);
1486 extern void breakpoint_set_task (struct breakpoint *b, int task);
1488 /* Clear the "inserted" flag in all breakpoints. */
1489 extern void mark_breakpoints_out (void);
1491 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *,
1494 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *,
1497 /* Create an solib event breakpoint at ADDRESS in the current program
1498 space, and immediately try to insert it. Returns a pointer to the
1499 breakpoint on success. Deletes the new breakpoint and returns NULL
1500 if inserting the breakpoint fails. */
1501 extern struct breakpoint *create_and_insert_solib_event_breakpoint
1502 (struct gdbarch *gdbarch, CORE_ADDR address);
1504 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *,
1507 extern void remove_jit_event_breakpoints (void);
1509 extern void remove_solib_event_breakpoints (void);
1511 /* Mark solib event breakpoints of the current program space with
1512 delete at next stop disposition. */
1513 extern void remove_solib_event_breakpoints_at_next_stop (void);
1515 extern void disable_breakpoints_in_shlibs (void);
1517 /* This function returns TRUE if ep is a catchpoint. */
1518 extern int is_catchpoint (struct breakpoint *);
1520 /* Shared helper function (MI and CLI) for creating and installing
1521 a shared object event catchpoint. */
1522 extern void add_solib_catchpoint (const char *arg, int is_load, int is_temp,
1525 /* Enable breakpoints and delete when hit. Called with ARG == NULL
1526 deletes all breakpoints. */
1527 extern void delete_command (char *arg, int from_tty);
1529 /* Create and insert a new software single step breakpoint for the
1530 current thread. May be called multiple times; each time will add a
1531 new location to the set of potential addresses the next instruction
1533 extern void insert_single_step_breakpoint (struct gdbarch *,
1534 struct address_space *,
1537 /* Insert all software single step breakpoints for the current frame.
1538 Return true if any software single step breakpoints are inserted,
1539 otherwise, return false. */
1540 extern int insert_single_step_breakpoints (struct gdbarch *);
1542 /* Check if any hardware watchpoints have triggered, according to the
1544 int watchpoints_triggered (struct target_waitstatus *);
1546 /* Helper for transparent breakpoint hiding for memory read and write
1549 Update one of READBUF or WRITEBUF with either the shadows
1550 (READBUF), or the breakpoint instructions (WRITEBUF) of inserted
1551 breakpoints at the memory range defined by MEMADDR and extending
1552 for LEN bytes. If writing, then WRITEBUF is a copy of WRITEBUF_ORG
1554 extern void breakpoint_xfer_memory (gdb_byte *readbuf, gdb_byte *writebuf,
1555 const gdb_byte *writebuf_org,
1556 ULONGEST memaddr, LONGEST len);
1558 /* Return true if breakpoints should be inserted now. That'll be the
1561 - the target has global breakpoints.
1563 - "breakpoint always-inserted" is on, and the target has
1566 - threads are executing.
1568 extern int breakpoints_should_be_inserted_now (void);
1570 /* Called each time new event from target is processed.
1571 Retires previously deleted breakpoint locations that
1572 in our opinion won't ever trigger. */
1573 extern void breakpoint_retire_moribund (void);
1575 /* Set break condition of breakpoint B to EXP. */
1576 extern void set_breakpoint_condition (struct breakpoint *b, const char *exp,
1579 /* Checks if we are catching syscalls or not.
1580 Returns 0 if not, greater than 0 if we are. */
1581 extern int catch_syscall_enabled (void);
1583 /* Checks if we are catching syscalls with the specific
1584 syscall_number. Used for "filtering" the catchpoints.
1585 Returns 0 if not, greater than 0 if we are. */
1586 extern int catching_syscall_number (int syscall_number);
1588 /* Return a tracepoint with the given number if found. */
1589 extern struct tracepoint *get_tracepoint (int num);
1591 extern struct tracepoint *get_tracepoint_by_number_on_target (int num);
1593 /* Find a tracepoint by parsing a number in the supplied string. */
1594 extern struct tracepoint *
1595 get_tracepoint_by_number (char **arg,
1596 number_or_range_parser *parser);
1598 /* Return a vector of all tracepoints currently defined. The vector
1599 is newly allocated; the caller should free when done with it. */
1600 extern VEC(breakpoint_p) *all_tracepoints (void);
1602 extern int is_tracepoint (const struct breakpoint *b);
1604 /* Return a vector of all static tracepoints defined at ADDR. The
1605 vector is newly allocated; the caller should free when done with
1607 extern VEC(breakpoint_p) *static_tracepoints_here (CORE_ADDR addr);
1609 /* Function that can be passed to read_command_line to validate
1610 that each command is suitable for tracepoint command list. */
1611 extern void check_tracepoint_command (char *line, void *closure);
1613 /* Call at the start and end of an "rbreak" command to register
1614 breakpoint numbers for a later "commands" command. */
1615 extern void start_rbreak_breakpoints (void);
1616 extern void end_rbreak_breakpoints (void);
1618 /* Breakpoint iterator function.
1620 Calls a callback function once for each breakpoint, so long as the
1621 callback function returns false. If the callback function returns
1622 true, the iteration will end and the current breakpoint will be
1623 returned. This can be useful for implementing a search for a
1624 breakpoint with arbitrary attributes, or for applying an operation
1625 to every breakpoint. */
1626 extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *,
1629 /* Nonzero if the specified PC cannot be a location where functions
1630 have been inlined. */
1632 extern int pc_at_non_inline_function (struct address_space *aspace,
1634 const struct target_waitstatus *ws);
1636 extern int user_breakpoint_p (struct breakpoint *);
1638 /* Return true if this breakpoint is pending, false if not. */
1639 extern int pending_breakpoint_p (struct breakpoint *);
1641 /* Attempt to determine architecture of location identified by SAL. */
1642 extern struct gdbarch *get_sal_arch (struct symtab_and_line sal);
1644 extern void breakpoint_free_objfile (struct objfile *objfile);
1646 extern const char *ep_parse_optional_if_clause (const char **arg);
1648 /* Print the "Thread ID hit" part of "Thread ID hit Breakpoint N" to
1649 UIOUT iff debugging multiple threads. */
1650 extern void maybe_print_thread_hit_breakpoint (struct ui_out *uiout);
1652 #endif /* !defined (BREAKPOINT_H) */