1 /* Data structures associated with breakpoints in GDB.
2 Copyright (C) 1992-2019 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
24 /* Local non-gdb includes. */
26 #include "cli/cli-script.h"
28 #include "common/array-view.h"
29 #include "common/break-common.h"
30 #include "common/vec.h"
37 struct gdbpy_breakpoint_object
;
38 struct gdbscm_breakpoint_object
;
39 struct number_or_range_parser
;
43 struct linespec_result
;
47 /* Why are we removing the breakpoint from the target? */
51 /* A regular remove. Remove the breakpoint and forget everything
55 /* Detach the breakpoints from a fork child. */
59 /* This is the maximum number of bytes a breakpoint instruction can
60 take. Feel free to increase it. It's just used in a few places to
61 size arrays that should be independent of the target
64 #define BREAKPOINT_MAX 16
67 /* Type of breakpoint. */
71 bp_none
= 0, /* Eventpoint has been deleted */
72 bp_breakpoint
, /* Normal breakpoint */
73 bp_hardware_breakpoint
, /* Hardware assisted breakpoint */
74 bp_single_step
, /* Software single-step */
75 bp_until
, /* used by until command */
76 bp_finish
, /* used by finish command */
77 bp_watchpoint
, /* Watchpoint */
78 bp_hardware_watchpoint
, /* Hardware assisted watchpoint */
79 bp_read_watchpoint
, /* read watchpoint, (hardware assisted) */
80 bp_access_watchpoint
, /* access watchpoint, (hardware assisted) */
81 bp_longjmp
, /* secret breakpoint to find longjmp() */
82 bp_longjmp_resume
, /* secret breakpoint to escape longjmp() */
84 /* Breakpoint placed to the same location(s) like bp_longjmp but used to
85 protect against stale DUMMY_FRAME. Multiple bp_longjmp_call_dummy and
86 one bp_call_dummy are chained together by related_breakpoint for each
88 bp_longjmp_call_dummy
,
90 /* An internal breakpoint that is installed on the unwinder's
93 /* An internal breakpoint that is set at the point where an
94 exception will land. */
97 /* Used by wait_for_inferior for stepping over subroutine calls,
98 and for skipping prologues. */
101 /* Used by wait_for_inferior for stepping over signal
105 /* Used to detect when a watchpoint expression has gone out of
106 scope. These breakpoints are usually not visible to the user.
108 This breakpoint has some interesting properties:
110 1) There's always a 1:1 mapping between watchpoints
111 on local variables and watchpoint_scope breakpoints.
113 2) It automatically deletes itself and the watchpoint it's
114 associated with when hit.
116 3) It can never be disabled. */
119 /* The breakpoint at the end of a call dummy. See bp_longjmp_call_dummy it
120 is chained with by related_breakpoint. */
123 /* A breakpoint set on std::terminate, that is used to catch
124 otherwise uncaught exceptions thrown during an inferior call. */
127 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
128 code in the inferior to run when significant events occur in the
129 dynamic linker (for example a library is loaded or unloaded).
131 By placing a breakpoint in this magic code GDB will get control
132 when these significant events occur. GDB can then re-examine
133 the dynamic linker's data structures to discover any newly loaded
134 dynamic libraries. */
137 /* Some multi-threaded systems can arrange for a location in the
138 inferior to be executed when certain thread-related events occur
139 (such as thread creation or thread death).
141 By placing a breakpoint at one of these locations, GDB will get
142 control when these events occur. GDB can then update its thread
147 /* On the same principal, an overlay manager can arrange to call a
148 magic location in the inferior whenever there is an interesting
149 change in overlay status. GDB can update its overlay tables
150 and fiddle with breakpoints in overlays when this breakpoint
155 /* Master copies of longjmp breakpoints. These are always installed
156 as soon as an objfile containing longjmp is loaded, but they are
157 always disabled. While necessary, temporary clones of bp_longjmp
158 type will be created and enabled. */
162 /* Master copies of std::terminate breakpoints. */
163 bp_std_terminate_master
,
165 /* Like bp_longjmp_master, but for exceptions. */
172 bp_static_tracepoint
,
174 /* A dynamic printf stops at the given location, does a formatted
175 print, then automatically continues. (Although this is sort of
176 like a macro packaging up standard breakpoint functionality,
177 GDB doesn't have a way to construct types of breakpoint from
178 elements of behavior.) */
181 /* Event for JIT compiled code generation or deletion. */
184 /* Breakpoint is placed at the STT_GNU_IFUNC resolver. When hit GDB
185 inserts new bp_gnu_ifunc_resolver_return at the caller.
186 bp_gnu_ifunc_resolver is still being kept here as a different thread
187 may still hit it before bp_gnu_ifunc_resolver_return is hit by the
189 bp_gnu_ifunc_resolver
,
191 /* On its hit GDB now know the resolved address of the target
192 STT_GNU_IFUNC function. Associated bp_gnu_ifunc_resolver can be
193 deleted now and the breakpoint moved to the target function entry
195 bp_gnu_ifunc_resolver_return
,
198 /* States of enablement of breakpoint. */
202 bp_disabled
, /* The eventpoint is inactive, and cannot
204 bp_enabled
, /* The eventpoint is active, and can
206 bp_call_disabled
, /* The eventpoint has been disabled while a
207 call into the inferior is "in flight",
208 because some eventpoints interfere with
209 the implementation of a call on some
210 targets. The eventpoint will be
211 automatically enabled and reset when the
212 call "lands" (either completes, or stops
213 at another eventpoint). */
217 /* Disposition of breakpoint. Ie: what to do after hitting it. */
221 disp_del
, /* Delete it */
222 disp_del_at_next_stop
, /* Delete at next stop,
223 whether hit or not */
224 disp_disable
, /* Disable it */
225 disp_donttouch
/* Leave it alone */
228 /* Status of breakpoint conditions used when synchronizing
229 conditions with the target. */
231 enum condition_status
233 condition_unchanged
= 0,
238 /* Information used by targets to insert and remove breakpoints. */
240 struct bp_target_info
242 /* Address space at which the breakpoint was placed. */
243 struct address_space
*placed_address_space
;
245 /* Address at which the breakpoint was placed. This is normally
246 the same as REQUESTED_ADDRESS, except when adjustment happens in
247 gdbarch_breakpoint_from_pc. The most common form of adjustment
248 is stripping an alternate ISA marker from the PC which is used
249 to determine the type of breakpoint to insert. */
250 CORE_ADDR placed_address
;
252 /* Address at which the breakpoint was requested. */
253 CORE_ADDR reqstd_address
;
255 /* If this is a ranged breakpoint, then this field contains the
256 length of the range that will be watched for execution. */
259 /* If the breakpoint lives in memory and reading that memory would
260 give back the breakpoint, instead of the original contents, then
261 the original contents are cached here. Only SHADOW_LEN bytes of
262 this buffer are valid, and only when the breakpoint is inserted. */
263 gdb_byte shadow_contents
[BREAKPOINT_MAX
];
265 /* The length of the data cached in SHADOW_CONTENTS. */
268 /* The breakpoint's kind. It is used in 'kind' parameter in Z
272 /* Conditions the target should evaluate if it supports target-side
273 breakpoint conditions. These are non-owning pointers. */
274 std::vector
<agent_expr
*> conditions
;
276 /* Commands the target should evaluate if it supports target-side
277 breakpoint commands. These are non-owning pointers. */
278 std::vector
<agent_expr
*> tcommands
;
280 /* Flag that is true if the breakpoint should be left in place even
281 when GDB is not connected. */
285 /* GDB maintains two types of information about each breakpoint (or
286 watchpoint, or other related event). The first type corresponds
287 to struct breakpoint; this is a relatively high-level structure
288 which contains the source location(s), stopping conditions, user
289 commands to execute when the breakpoint is hit, and so forth.
291 The second type of information corresponds to struct bp_location.
292 Each breakpoint has one or (eventually) more locations associated
293 with it, which represent target-specific and machine-specific
294 mechanisms for stopping the program. For instance, a watchpoint
295 expression may require multiple hardware watchpoints in order to
296 catch all changes in the value of the expression being watched. */
300 bp_loc_software_breakpoint
,
301 bp_loc_hardware_breakpoint
,
302 bp_loc_hardware_watchpoint
,
303 bp_loc_other
/* Miscellaneous... */
309 bp_location () = default;
311 bp_location (breakpoint
*owner
);
313 virtual ~bp_location ();
315 /* Chain pointer to the next breakpoint location for
316 the same parent breakpoint. */
317 bp_location
*next
= NULL
;
319 /* The reference count. */
322 /* Type of this breakpoint location. */
323 bp_loc_type loc_type
{};
325 /* Each breakpoint location must belong to exactly one higher-level
326 breakpoint. This pointer is NULL iff this bp_location is no
327 longer attached to a breakpoint. For example, when a breakpoint
328 is deleted, its locations may still be found in the
329 moribund_locations list, or if we had stopped for it, in
331 breakpoint
*owner
= NULL
;
333 /* Conditional. Break only if this expression's value is nonzero.
334 Unlike string form of condition, which is associated with
335 breakpoint, this is associated with location, since if breakpoint
336 has several locations, the evaluation of expression can be
337 different for different locations. Only valid for real
338 breakpoints; a watchpoint's conditional expression is stored in
339 the owner breakpoint object. */
342 /* Conditional expression in agent expression
343 bytecode form. This is used for stub-side breakpoint
344 condition evaluation. */
345 agent_expr_up cond_bytecode
;
347 /* Signals that the condition has changed since the last time
348 we updated the global location list. This means the condition
349 needs to be sent to the target again. This is used together
350 with target-side breakpoint conditions.
352 condition_unchanged: It means there has been no condition changes.
354 condition_modified: It means this location had its condition modified.
356 condition_updated: It means we already marked all the locations that are
357 duplicates of this location and thus we don't need to call
358 force_breakpoint_reinsertion (...) for this location. */
360 condition_status condition_changed
{};
362 agent_expr_up cmd_bytecode
;
364 /* Signals that breakpoint conditions and/or commands need to be
365 re-synched with the target. This has no use other than
366 target-side breakpoints. */
367 bool needs_update
= false;
369 /* This location's address is in an unloaded solib, and so this
370 location should not be inserted. It will be automatically
371 enabled when that solib is loaded. */
372 bool shlib_disabled
= false;
374 /* Is this particular location enabled. */
375 bool enabled
= false;
377 /* Nonzero if this breakpoint is now inserted. */
378 bool inserted
= false;
380 /* Nonzero if this is a permanent breakpoint. There is a breakpoint
381 instruction hard-wired into the target's code. Don't try to
382 write another breakpoint instruction on top of it, or restore its
383 value. Step over it using the architecture's
384 gdbarch_skip_permanent_breakpoint method. */
385 bool permanent
= false;
387 /* Nonzero if this is not the first breakpoint in the list
388 for the given address. location of tracepoint can _never_
389 be duplicated with other locations of tracepoints and other
390 kinds of breakpoints, because two locations at the same
391 address may have different actions, so both of these locations
392 should be downloaded and so that `tfind N' always works. */
393 bool duplicate
= false;
395 /* If we someday support real thread-specific breakpoints, then
396 the breakpoint location will need a thread identifier. */
398 /* Data for specific breakpoint types. These could be a union, but
399 simplicity is more important than memory usage for breakpoints. */
401 /* Architecture associated with this location's address. May be
402 different from the breakpoint architecture. */
403 struct gdbarch
*gdbarch
= NULL
;
405 /* The program space associated with this breakpoint location
406 address. Note that an address space may be represented in more
407 than one program space (e.g. each uClinux program will be given
408 its own program space, but there will only be one address space
409 for all of them), but we must not insert more than one location
410 at the same address in the same address space. */
411 program_space
*pspace
= NULL
;
413 /* Note that zero is a perfectly valid code address on some platforms
414 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
415 is not a special value for this field. Valid for all types except
417 CORE_ADDR address
= 0;
419 /* For hardware watchpoints, the size of the memory region being
420 watched. For hardware ranged breakpoints, the size of the
424 /* Type of hardware watchpoint. */
425 target_hw_bp_type watchpoint_type
{};
427 /* For any breakpoint type with an address, this is the section
428 associated with the address. Used primarily for overlay
430 obj_section
*section
= NULL
;
432 /* Address at which breakpoint was requested, either by the user or
433 by GDB for internal breakpoints. This will usually be the same
434 as ``address'' (above) except for cases in which
435 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
436 which to place the breakpoint in order to comply with a
437 processor's architectual constraints. */
438 CORE_ADDR requested_address
= 0;
440 /* An additional address assigned with this location. This is currently
441 only used by STT_GNU_IFUNC resolver breakpoints to hold the address
442 of the resolver function. */
443 CORE_ADDR related_address
= 0;
445 /* If the location comes from a probe point, this is the probe associated
447 bound_probe probe
{};
449 char *function_name
= NULL
;
451 /* Details of the placed breakpoint, when inserted. */
452 bp_target_info target_info
{};
454 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
455 bp_target_info overlay_target_info
{};
457 /* In a non-stop mode, it's possible that we delete a breakpoint,
458 but as we do that, some still running thread hits that breakpoint.
459 For that reason, we need to keep locations belonging to deleted
460 breakpoints for a bit, so that don't report unexpected SIGTRAP.
461 We can't keep such locations forever, so we use a heuristic --
462 after we process certain number of inferior events since
463 breakpoint was deleted, we retire all locations of that breakpoint.
464 This variable keeps a number of events still to go, when
465 it becomes 0 this location is retired. */
466 int events_till_retirement
= 0;
468 /* Line number which was used to place this location.
470 Breakpoint placed into a comment keeps it's user specified line number
471 despite ADDRESS resolves into a different line number. */
475 /* Symtab which was used to place this location. This is used
476 to find the corresponding source file name. */
478 struct symtab
*symtab
= NULL
;
480 /* The symbol found by the location parser, if any. This may be used to
481 ascertain when an event location was set at a different location than
482 the one originally selected by parsing, e.g., inlined symbols. */
483 const struct symbol
*symbol
= NULL
;
485 /* Similarly, the minimal symbol found by the location parser, if
486 any. This may be used to ascertain if the location was
487 originally set on a GNU ifunc symbol. */
488 const minimal_symbol
*msymbol
= NULL
;
490 /* The objfile the symbol or minimal symbol were found in. */
491 const struct objfile
*objfile
= NULL
;
494 /* The possible return values for print_bpstat, print_it_normal,
495 print_it_done, print_it_noop. */
496 enum print_stop_action
498 /* We printed nothing or we need to do some more analysis. */
501 /* We printed something, and we *do* desire that something to be
502 followed by a location. */
505 /* We printed something, and we do *not* desire that something to be
506 followed by a location. */
509 /* We already printed all we needed to print, don't print anything
514 /* This structure is a collection of function pointers that, if available,
515 will be called instead of the performing the default action for this
518 struct breakpoint_ops
520 /* Allocate a location for this breakpoint. */
521 struct bp_location
* (*allocate_location
) (struct breakpoint
*);
523 /* Reevaluate a breakpoint. This is necessary after symbols change
524 (e.g., an executable or DSO was loaded, or the inferior just
526 void (*re_set
) (struct breakpoint
*self
);
528 /* Insert the breakpoint or watchpoint or activate the catchpoint.
529 Return 0 for success, 1 if the breakpoint, watchpoint or
530 catchpoint type is not supported, -1 for failure. */
531 int (*insert_location
) (struct bp_location
*);
533 /* Remove the breakpoint/catchpoint that was previously inserted
534 with the "insert" method above. Return 0 for success, 1 if the
535 breakpoint, watchpoint or catchpoint type is not supported,
537 int (*remove_location
) (struct bp_location
*, enum remove_bp_reason reason
);
539 /* Return true if it the target has stopped due to hitting
540 breakpoint location BL. This function does not check if we
541 should stop, only if BL explains the stop. ASPACE is the address
542 space in which the event occurred, BP_ADDR is the address at
543 which the inferior stopped, and WS is the target_waitstatus
544 describing the event. */
545 int (*breakpoint_hit
) (const struct bp_location
*bl
,
546 const address_space
*aspace
,
548 const struct target_waitstatus
*ws
);
550 /* Check internal conditions of the breakpoint referred to by BS.
551 If we should not stop for this breakpoint, set BS->stop to 0. */
552 void (*check_status
) (struct bpstats
*bs
);
554 /* Tell how many hardware resources (debug registers) are needed
555 for this breakpoint. If this function is not provided, then
556 the breakpoint or watchpoint needs one debug register. */
557 int (*resources_needed
) (const struct bp_location
*);
559 /* Tell whether we can downgrade from a hardware watchpoint to a software
560 one. If not, the user will not be able to enable the watchpoint when
561 there are not enough hardware resources available. */
562 int (*works_in_software_mode
) (const struct breakpoint
*);
564 /* The normal print routine for this breakpoint, called when we
566 enum print_stop_action (*print_it
) (struct bpstats
*bs
);
568 /* Display information about this breakpoint, for "info
570 void (*print_one
) (struct breakpoint
*, struct bp_location
**);
572 /* Display extra information about this breakpoint, below the normal
573 breakpoint description in "info breakpoints".
575 In the example below, the "address range" line was printed
576 by print_one_detail_ranged_breakpoint.
578 (gdb) info breakpoints
579 Num Type Disp Enb Address What
580 2 hw breakpoint keep y in main at test-watch.c:70
581 address range: [0x10000458, 0x100004c7]
584 void (*print_one_detail
) (const struct breakpoint
*, struct ui_out
*);
586 /* Display information about this breakpoint after setting it
587 (roughly speaking; this is called from "mention"). */
588 void (*print_mention
) (struct breakpoint
*);
590 /* Print to FP the CLI command that recreates this breakpoint. */
591 void (*print_recreate
) (struct breakpoint
*, struct ui_file
*fp
);
593 /* Create SALs from location, storing the result in linespec_result.
595 For an explanation about the arguments, see the function
596 `create_sals_from_location_default'.
598 This function is called inside `create_breakpoint'. */
599 void (*create_sals_from_location
) (const struct event_location
*location
,
600 struct linespec_result
*canonical
,
601 enum bptype type_wanted
);
603 /* This method will be responsible for creating a breakpoint given its SALs.
604 Usually, it just calls `create_breakpoints_sal' (for ordinary
605 breakpoints). However, there may be some special cases where we might
606 need to do some tweaks, e.g., see
607 `strace_marker_create_breakpoints_sal'.
609 This function is called inside `create_breakpoint'. */
610 void (*create_breakpoints_sal
) (struct gdbarch
*,
611 struct linespec_result
*,
612 gdb::unique_xmalloc_ptr
<char>,
613 gdb::unique_xmalloc_ptr
<char>,
614 enum bptype
, enum bpdisp
, int, int,
615 int, const struct breakpoint_ops
*,
616 int, int, int, unsigned);
618 /* Given the location (second parameter), this method decodes it and
619 returns the SAL locations related to it. For ordinary
620 breakpoints, it calls `decode_line_full'. If SEARCH_PSPACE is
621 not NULL, symbol search is restricted to just that program space.
623 This function is called inside `location_to_sals'. */
624 std::vector
<symtab_and_line
> (*decode_location
)
625 (struct breakpoint
*b
,
626 const struct event_location
*location
,
627 struct program_space
*search_pspace
);
629 /* Return true if this breakpoint explains a signal. See
630 bpstat_explains_signal. */
631 int (*explains_signal
) (struct breakpoint
*, enum gdb_signal
);
633 /* Called after evaluating the breakpoint's condition,
634 and only if it evaluated true. */
635 void (*after_condition_true
) (struct bpstats
*bs
);
638 /* Helper for breakpoint_ops->print_recreate implementations. Prints
639 the "thread" or "task" condition of B, and then a newline.
641 Necessary because most breakpoint implementations accept
642 thread/task conditions at the end of the spec line, like "break foo
643 thread 1", which needs outputting before any breakpoint-type
644 specific extra command necessary for B's recreation. */
645 extern void print_recreate_thread (struct breakpoint
*b
, struct ui_file
*fp
);
647 enum watchpoint_triggered
649 /* This watchpoint definitely did not trigger. */
650 watch_triggered_no
= 0,
652 /* Some hardware watchpoint triggered, and it might have been this
653 one, but we do not know which it was. */
654 watch_triggered_unknown
,
656 /* This hardware watchpoint definitely did trigger. */
660 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
661 a watchpoint over a memory region. If this flag is true, GDB will use
662 only one register per watchpoint, thus assuming that all acesses that
663 modify a memory location happen at its starting address. */
665 extern int target_exact_watchpoints
;
667 /* Note that the ->silent field is not currently used by any commands
668 (though the code is in there if it was to be, and set_raw_breakpoint
669 does set it to 0). I implemented it because I thought it would be
670 useful for a hack I had to put in; I'm going to leave it in because
671 I can see how there might be times when it would indeed be useful */
673 /* This is for all kinds of breakpoints. */
677 virtual ~breakpoint ();
679 /* Methods associated with this breakpoint. */
680 const breakpoint_ops
*ops
= NULL
;
682 breakpoint
*next
= NULL
;
683 /* Type of breakpoint. */
684 bptype type
= bp_none
;
685 /* Zero means disabled; remember the info but don't break here. */
686 enum enable_state enable_state
= bp_enabled
;
687 /* What to do with this breakpoint after we hit it. */
688 bpdisp disposition
= disp_del
;
689 /* Number assigned to distinguish breakpoints. */
692 /* Location(s) associated with this high-level breakpoint. */
693 bp_location
*loc
= NULL
;
695 /* True means a silent breakpoint (don't print frame info if we stop
698 /* True means display ADDR_STRING to the user verbatim. */
699 bool display_canonical
= false;
700 /* Number of stops at this breakpoint that should be continued
701 automatically before really stopping. */
702 int ignore_count
= 0;
704 /* Number of stops at this breakpoint before it will be
706 int enable_count
= 0;
708 /* Chain of command lines to execute when this breakpoint is
710 counted_command_line commands
;
711 /* Stack depth (address of frame). If nonzero, break only if fp
713 struct frame_id frame_id
= null_frame_id
;
715 /* The program space used to set the breakpoint. This is only set
716 for breakpoints which are specific to a program space; for
717 non-thread-specific ordinary breakpoints this is NULL. */
718 program_space
*pspace
= NULL
;
720 /* Location we used to set the breakpoint. */
721 event_location_up location
;
723 /* The filter that should be passed to decode_line_full when
724 re-setting this breakpoint. This may be NULL, but otherwise is
725 allocated with xmalloc. */
728 /* For a ranged breakpoint, the location we used to find the end of
730 event_location_up location_range_end
;
732 /* Architecture we used to set the breakpoint. */
733 struct gdbarch
*gdbarch
= NULL
;
734 /* Language we used to set the breakpoint. */
735 enum language language
= language_unknown
;
736 /* Input radix we used to set the breakpoint. */
738 /* String form of the breakpoint condition (malloc'd), or NULL if
739 there is no condition. */
740 char *cond_string
= NULL
;
742 /* String form of extra parameters, or NULL if there are none.
744 char *extra_string
= NULL
;
746 /* Holds the address of the related watchpoint_scope breakpoint when
747 using watchpoints on local variables (might the concept of a
748 related breakpoint be useful elsewhere, if not just call it the
749 watchpoint_scope breakpoint or something like that. FIXME). */
750 breakpoint
*related_breakpoint
= NULL
;
752 /* Thread number for thread-specific breakpoint, or -1 if don't
756 /* Ada task number for task-specific breakpoint, or 0 if don't
760 /* Count of the number of times this breakpoint was taken, dumped
761 with the info, but not used for anything else. Useful for seeing
762 how many times you hit a break prior to the program aborting, so
763 you can back up to just before the abort. */
766 /* Is breakpoint's condition not yet parsed because we found no
767 location initially so had no context to parse the condition
769 int condition_not_parsed
= 0;
771 /* With a Python scripting enabled GDB, store a reference to the
772 Python object that has been associated with this breakpoint.
773 This is always NULL for a GDB that is not script enabled. It can
774 sometimes be NULL for enabled GDBs as not all breakpoint types
775 are tracked by the scripting language API. */
776 gdbpy_breakpoint_object
*py_bp_object
= NULL
;
778 /* Same as py_bp_object, but for Scheme. */
779 gdbscm_breakpoint_object
*scm_bp_object
= NULL
;
782 /* An instance of this type is used to represent a watchpoint. */
784 struct watchpoint
: public breakpoint
786 ~watchpoint () override
;
788 /* String form of exp to use for displaying to the user (malloc'd),
791 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
792 char *exp_string_reparse
;
794 /* The expression we are watching, or NULL if not a watchpoint. */
796 /* The largest block within which it is valid, or NULL if it is
797 valid anywhere (e.g. consists just of global symbols). */
798 const struct block
*exp_valid_block
;
799 /* The conditional expression if any. */
800 expression_up cond_exp
;
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
*cond_exp_valid_block
;
804 /* Value of the watchpoint the last time we checked it, or NULL when
805 we do not know the value yet or the value was not readable. VAL
808 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
809 then an error occurred reading the value. */
812 /* When watching the location of a bitfield, contains the offset and size of
813 the bitfield. Otherwise contains 0. */
817 /* Holds the frame address which identifies the frame this
818 watchpoint should be evaluated in, or `null' if the watchpoint
819 should be evaluated on the outermost frame. */
820 struct frame_id watchpoint_frame
;
822 /* Holds the thread which identifies the frame this watchpoint
823 should be considered in scope for, or `null_ptid' if the
824 watchpoint should be evaluated in all threads. */
825 ptid_t watchpoint_thread
;
827 /* For hardware watchpoints, the triggered status according to the
829 enum watchpoint_triggered watchpoint_triggered
;
831 /* Whether this watchpoint is exact (see
832 target_exact_watchpoints). */
835 /* The mask address for a masked hardware watchpoint. */
836 CORE_ADDR hw_wp_mask
;
839 /* Given a function FUNC (struct breakpoint *B, void *DATA) and
840 USER_DATA, call FUNC for every known breakpoint passing USER_DATA
843 If FUNC returns 1, the loop stops and the current
844 'struct breakpoint' being processed is returned. If FUNC returns
845 zero, the loop continues.
847 This function returns either a 'struct breakpoint' pointer or NULL.
848 It was based on BFD's bfd_sections_find_if function. */
850 extern struct breakpoint
*breakpoint_find_if
851 (int (*func
) (struct breakpoint
*b
, void *d
), void *user_data
);
853 /* Return true if BPT is either a software breakpoint or a hardware
856 extern int is_breakpoint (const struct breakpoint
*bpt
);
858 /* Returns true if BPT is really a watchpoint. */
860 extern int is_watchpoint (const struct breakpoint
*bpt
);
862 /* An instance of this type is used to represent all kinds of
865 struct tracepoint
: public breakpoint
867 /* Number of times this tracepoint should single-step and collect
871 /* Number of times this tracepoint should be hit before
875 /* The number of the tracepoint on the target. */
876 int number_on_target
;
878 /* The total space taken by all the trace frames for this
880 ULONGEST traceframe_usage
;
882 /* The static tracepoint marker id, if known. */
883 std::string static_trace_marker_id
;
885 /* LTTng/UST allow more than one marker with the same ID string,
886 although it unadvised because it confuses tools. When setting
887 static tracepoints by marker ID, this will record the index in
888 the array of markers we found for the given marker ID for which
889 this static tracepoint corresponds. When resetting breakpoints,
890 we will use this index to try to find the same marker again. */
891 int static_trace_marker_id_idx
;
895 /* The following stuff is an abstract data type "bpstat" ("breakpoint
896 status"). This provides the ability to determine whether we have
897 stopped at a breakpoint, and what we should do about it. */
899 typedef struct bpstats
*bpstat
;
901 /* Clears a chain of bpstat, freeing storage
903 extern void bpstat_clear (bpstat
*);
905 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
906 is part of the bpstat is copied as well. */
907 extern bpstat
bpstat_copy (bpstat
);
909 /* Build the (raw) bpstat chain for the stop information given by ASPACE,
910 BP_ADDR, and WS. Returns the head of the bpstat chain. */
912 extern bpstat
build_bpstat_chain (const address_space
*aspace
,
914 const struct target_waitstatus
*ws
);
916 /* Get a bpstat associated with having just stopped at address
917 BP_ADDR in thread PTID. STOP_CHAIN may be supplied as a previously
918 computed stop chain or NULL, in which case the stop chain will be
919 computed using build_bpstat_chain.
921 Determine whether we stopped at a breakpoint, etc, or whether we
922 don't understand this stop. Result is a chain of bpstat's such
925 if we don't understand the stop, the result is a null pointer.
927 if we understand why we stopped, the result is not null.
929 Each element of the chain refers to a particular breakpoint or
930 watchpoint at which we have stopped. (We may have stopped for
931 several reasons concurrently.)
933 Each element of the chain has valid next, breakpoint_at,
934 commands, FIXME??? fields. */
936 extern bpstat
bpstat_stop_status (const address_space
*aspace
,
937 CORE_ADDR pc
, thread_info
*thread
,
938 const struct target_waitstatus
*ws
,
939 bpstat stop_chain
= NULL
);
941 /* This bpstat_what stuff tells wait_for_inferior what to do with a
942 breakpoint (a challenging task).
944 The enum values order defines priority-like order of the actions.
945 Once you've decided that some action is appropriate, you'll never
946 go back and decide something of a lower priority is better. Each
947 of these actions is mutually exclusive with the others. That
948 means, that if you find yourself adding a new action class here and
949 wanting to tell GDB that you have two simultaneous actions to
950 handle, something is wrong, and you probably don't actually need a
953 Note that a step resume breakpoint overrides another breakpoint of
954 signal handling (see comment in wait_for_inferior at where we set
955 the step_resume breakpoint). */
957 enum bpstat_what_main_action
959 /* Perform various other tests; that is, this bpstat does not
960 say to perform any action (e.g. failed watchpoint and nothing
962 BPSTAT_WHAT_KEEP_CHECKING
,
964 /* Remove breakpoints, single step once, then put them back in and
965 go back to what we were doing. It's possible that this should
966 be removed from the main_action and put into a separate field,
967 to more cleanly handle
968 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
971 /* Set longjmp_resume breakpoint, remove all other breakpoints,
972 and continue. The "remove all other breakpoints" part is
973 required if we are also stepping over another breakpoint as
974 well as doing the longjmp handling. */
975 BPSTAT_WHAT_SET_LONGJMP_RESUME
,
977 /* Clear longjmp_resume breakpoint, then handle as
978 BPSTAT_WHAT_KEEP_CHECKING. */
979 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME
,
981 /* Clear step resume breakpoint, and keep checking. */
982 BPSTAT_WHAT_STEP_RESUME
,
984 /* Rather than distinguish between noisy and silent stops here, it
985 might be cleaner to have bpstat_print make that decision (also
986 taking into account stop_print_frame and source_only). But the
987 implications are a bit scary (interaction with auto-displays,
988 etc.), so I won't try it. */
991 BPSTAT_WHAT_STOP_SILENT
,
993 /* Stop and print. */
994 BPSTAT_WHAT_STOP_NOISY
,
996 /* Clear step resume breakpoint, and keep checking. High-priority
997 step-resume breakpoints are used when even if there's a user
998 breakpoint at the current PC when we set the step-resume
999 breakpoint, we don't want to re-handle any breakpoint other
1000 than the step-resume when it's hit; instead we want to move
1001 past the breakpoint. This is used in the case of skipping
1003 BPSTAT_WHAT_HP_STEP_RESUME
,
1006 /* An enum indicating the kind of "stack dummy" stop. This is a bit
1007 of a misnomer because only one kind of truly a stack dummy. */
1008 enum stop_stack_kind
1010 /* We didn't stop at a stack dummy breakpoint. */
1013 /* Stopped at a stack dummy. */
1016 /* Stopped at std::terminate. */
1022 enum bpstat_what_main_action main_action
;
1024 /* Did we hit a call dummy breakpoint? This only goes with a
1025 main_action of BPSTAT_WHAT_STOP_SILENT or
1026 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
1027 dummy without popping the frame is not a useful one). */
1028 enum stop_stack_kind call_dummy
;
1030 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
1031 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
1032 longjmp, false if we are handling an exception. */
1036 /* Tell what to do about this bpstat. */
1037 struct bpstat_what
bpstat_what (bpstat
);
1039 /* Run breakpoint event callbacks associated with the breakpoints that
1041 extern void bpstat_run_callbacks (bpstat bs_head
);
1043 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
1044 bpstat
bpstat_find_breakpoint (bpstat
, struct breakpoint
*);
1046 /* Nonzero if a signal that we got in target_wait() was due to
1047 circumstances explained by the bpstat; the signal is therefore not
1049 extern int bpstat_explains_signal (bpstat
, enum gdb_signal
);
1051 /* Nonzero is this bpstat causes a stop. */
1052 extern int bpstat_causes_stop (bpstat
);
1054 /* Nonzero if we should step constantly (e.g. watchpoints on machines
1055 without hardware support). This isn't related to a specific bpstat,
1056 just to things like whether watchpoints are set. */
1057 extern int bpstat_should_step (void);
1059 /* Print a message indicating what happened. Returns nonzero to
1060 say that only the source line should be printed after this (zero
1061 return means print the frame as well as the source line). */
1062 extern enum print_stop_action
bpstat_print (bpstat
, int);
1064 /* Put in *NUM the breakpoint number of the first breakpoint we are
1065 stopped at. *BSP upon return is a bpstat which points to the
1066 remaining breakpoints stopped at (but which is not guaranteed to be
1067 good for anything but further calls to bpstat_num).
1069 Return 0 if passed a bpstat which does not indicate any breakpoints.
1070 Return -1 if stopped at a breakpoint that has been deleted since
1072 Return 1 otherwise. */
1073 extern int bpstat_num (bpstat
*, int *);
1075 /* Perform actions associated with the stopped inferior. Actually, we
1076 just use this for breakpoint commands. Perhaps other actions will
1077 go here later, but this is executed at a late time (from the
1079 extern void bpstat_do_actions (void);
1081 /* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will
1082 not be performed. */
1083 extern void bpstat_clear_actions (void);
1085 /* Implementation: */
1087 /* Values used to tell the printing routine how to behave for this
1091 /* This is used when we want to do a normal printing of the reason
1092 for stopping. The output will depend on the type of eventpoint
1093 we are dealing with. This is the default value, most commonly
1096 /* This is used when nothing should be printed for this bpstat
1099 /* This is used when everything which needs to be printed has
1100 already been printed. But we still want to print the frame. */
1107 bpstats (struct bp_location
*bl
, bpstat
**bs_link_pointer
);
1110 bpstats (const bpstats
&);
1111 bpstats
&operator= (const bpstats
&) = delete;
1113 /* Linked list because there can be more than one breakpoint at
1114 the same place, and a bpstat reflects the fact that all have
1118 /* Location that caused the stop. Locations are refcounted, so
1119 this will never be NULL. Note that this location may end up
1120 detached from a breakpoint, but that does not necessary mean
1121 that the struct breakpoint is gone. E.g., consider a
1122 watchpoint with a condition that involves an inferior function
1123 call. Watchpoint locations are recreated often (on resumes,
1124 hence on infcalls too). Between creating the bpstat and after
1125 evaluating the watchpoint condition, this location may hence
1126 end up detached from its original owner watchpoint, even though
1127 the watchpoint is still listed. If it's condition evaluates as
1128 true, we still want this location to cause a stop, and we will
1129 still need to know which watchpoint it was originally attached.
1130 What this means is that we should not (in most cases) follow
1131 the `bpstat->bp_location->owner' link, but instead use the
1132 `breakpoint_at' field below. */
1133 struct bp_location
*bp_location_at
;
1135 /* Breakpoint that caused the stop. This is nullified if the
1136 breakpoint ends up being deleted. See comments on
1137 `bp_location_at' above for why do we need this field instead of
1138 following the location's owner. */
1139 struct breakpoint
*breakpoint_at
;
1141 /* The associated command list. */
1142 counted_command_line commands
;
1144 /* Old value associated with a watchpoint. */
1145 value_ref_ptr old_val
;
1147 /* Nonzero if this breakpoint tells us to print the frame. */
1150 /* Nonzero if this breakpoint tells us to stop. */
1153 /* Tell bpstat_print and print_bp_stop_message how to print stuff
1154 associated with this element of the bpstat chain. */
1155 enum bp_print_how print_it
;
1166 /* The possible return values for breakpoint_here_p.
1167 We guarantee that zero always means "no breakpoint here". */
1168 enum breakpoint_here
1170 no_breakpoint_here
= 0,
1171 ordinary_breakpoint_here
,
1172 permanent_breakpoint_here
1176 /* Prototypes for breakpoint-related functions. */
1178 /* Return 1 if there's a program/permanent breakpoint planted in
1179 memory at ADDRESS, return 0 otherwise. */
1181 extern int program_breakpoint_here_p (struct gdbarch
*gdbarch
, CORE_ADDR address
);
1183 extern enum breakpoint_here
breakpoint_here_p (const address_space
*,
1186 /* Return true if an enabled breakpoint exists in the range defined by
1187 ADDR and LEN, in ASPACE. */
1188 extern int breakpoint_in_range_p (const address_space
*aspace
,
1189 CORE_ADDR addr
, ULONGEST len
);
1191 extern int moribund_breakpoint_here_p (const address_space
*, CORE_ADDR
);
1193 extern int breakpoint_inserted_here_p (const address_space
*,
1196 extern int software_breakpoint_inserted_here_p (const address_space
*,
1199 /* Return non-zero iff there is a hardware breakpoint inserted at
1201 extern int hardware_breakpoint_inserted_here_p (const address_space
*,
1204 /* Check whether any location of BP is inserted at PC. */
1206 extern int breakpoint_has_location_inserted_here (struct breakpoint
*bp
,
1207 const address_space
*aspace
,
1210 extern int single_step_breakpoint_inserted_here_p (const address_space
*,
1213 /* Returns true if there's a hardware watchpoint or access watchpoint
1214 inserted in the range defined by ADDR and LEN. */
1215 extern int hardware_watchpoint_inserted_in_range (const address_space
*,
1219 /* Returns true if {ASPACE1,ADDR1} and {ASPACE2,ADDR2} represent the
1220 same breakpoint location. In most targets, this can only be true
1221 if ASPACE1 matches ASPACE2. On targets that have global
1222 breakpoints, the address space doesn't really matter. */
1224 extern int breakpoint_address_match (const address_space
*aspace1
,
1226 const address_space
*aspace2
,
1229 extern void until_break_command (const char *, int, int);
1231 /* Initialize a struct bp_location. */
1233 extern void update_breakpoint_locations
1234 (struct breakpoint
*b
,
1235 struct program_space
*filter_pspace
,
1236 gdb::array_view
<const symtab_and_line
> sals
,
1237 gdb::array_view
<const symtab_and_line
> sals_end
);
1239 extern void breakpoint_re_set (void);
1241 extern void breakpoint_re_set_thread (struct breakpoint
*);
1243 extern void delete_breakpoint (struct breakpoint
*);
1245 struct breakpoint_deleter
1247 void operator() (struct breakpoint
*b
) const
1249 delete_breakpoint (b
);
1253 typedef std::unique_ptr
<struct breakpoint
, breakpoint_deleter
> breakpoint_up
;
1255 extern breakpoint_up set_momentary_breakpoint
1256 (struct gdbarch
*, struct symtab_and_line
, struct frame_id
, enum bptype
);
1258 extern breakpoint_up set_momentary_breakpoint_at_pc
1259 (struct gdbarch
*, CORE_ADDR pc
, enum bptype type
);
1261 extern struct breakpoint
*clone_momentary_breakpoint (struct breakpoint
*bpkt
);
1263 extern void set_ignore_count (int, int, int);
1265 extern void breakpoint_init_inferior (enum inf_context
);
1267 extern void breakpoint_auto_delete (bpstat
);
1269 typedef void (*walk_bp_location_callback
) (struct bp_location
*, void *);
1271 extern void iterate_over_bp_locations (walk_bp_location_callback
);
1273 /* Return the chain of command lines to execute when this breakpoint
1275 extern struct command_line
*breakpoint_commands (struct breakpoint
*b
);
1277 /* Return a string image of DISP. The string is static, and thus should
1278 NOT be deallocated after use. */
1279 const char *bpdisp_text (enum bpdisp disp
);
1281 extern void break_command (const char *, int);
1283 extern void hbreak_command_wrapper (const char *, int);
1284 extern void thbreak_command_wrapper (const char *, int);
1285 extern void rbreak_command_wrapper (const char *, int);
1286 extern void watch_command_wrapper (const char *, int, int);
1287 extern void awatch_command_wrapper (const char *, int, int);
1288 extern void rwatch_command_wrapper (const char *, int, int);
1289 extern void tbreak_command (const char *, int);
1291 extern struct breakpoint_ops base_breakpoint_ops
;
1292 extern struct breakpoint_ops bkpt_breakpoint_ops
;
1293 extern struct breakpoint_ops tracepoint_breakpoint_ops
;
1294 extern struct breakpoint_ops dprintf_breakpoint_ops
;
1296 extern void initialize_breakpoint_ops (void);
1298 /* Arguments to pass as context to some catch command handlers. */
1299 #define CATCH_PERMANENT ((void *) (uintptr_t) 0)
1300 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
1302 /* Like add_cmd, but add the command to both the "catch" and "tcatch"
1303 lists, and pass some additional user data to the command
1307 add_catch_command (const char *name
, const char *docstring
,
1308 cmd_const_sfunc_ftype
*sfunc
,
1309 completer_ftype
*completer
,
1310 void *user_data_catch
,
1311 void *user_data_tcatch
);
1313 /* Initialize a breakpoint struct for Ada exception catchpoints. */
1316 init_ada_exception_breakpoint (struct breakpoint
*b
,
1317 struct gdbarch
*gdbarch
,
1318 struct symtab_and_line sal
,
1319 const char *addr_string
,
1320 const struct breakpoint_ops
*ops
,
1325 extern void init_catchpoint (struct breakpoint
*b
,
1326 struct gdbarch
*gdbarch
, int tempflag
,
1327 const char *cond_string
,
1328 const struct breakpoint_ops
*ops
);
1330 /* Add breakpoint B on the breakpoint list, and notify the user, the
1331 target and breakpoint_created observers of its existence. If
1332 INTERNAL is non-zero, the breakpoint number will be allocated from
1333 the internal breakpoint count. If UPDATE_GLL is non-zero,
1334 update_global_location_list will be called. */
1336 extern void install_breakpoint (int internal
, std::unique_ptr
<breakpoint
> &&b
,
1339 /* Flags that can be passed down to create_breakpoint, etc., to affect
1340 breakpoint creation in several ways. */
1342 enum breakpoint_create_flags
1344 /* We're adding a breakpoint to our tables that is already
1345 inserted in the target. */
1346 CREATE_BREAKPOINT_FLAGS_INSERTED
= 1 << 0
1349 /* Set a breakpoint. This function is shared between CLI and MI functions
1350 for setting a breakpoint at LOCATION.
1352 This function has two major modes of operations, selected by the
1353 PARSE_EXTRA parameter.
1355 If PARSE_EXTRA is zero, LOCATION is just the breakpoint's location,
1356 with condition, thread, and extra string specified by the COND_STRING,
1357 THREAD, and EXTRA_STRING parameters.
1359 If PARSE_EXTRA is non-zero, this function will attempt to extract
1360 the condition, thread, and extra string from EXTRA_STRING, ignoring
1361 the similarly named parameters.
1363 If INTERNAL is non-zero, the breakpoint number will be allocated
1364 from the internal breakpoint count.
1366 Returns true if any breakpoint was created; false otherwise. */
1368 extern int create_breakpoint (struct gdbarch
*gdbarch
,
1369 const struct event_location
*location
,
1370 const char *cond_string
, int thread
,
1371 const char *extra_string
,
1373 int tempflag
, enum bptype wanted_type
,
1375 enum auto_boolean pending_break_support
,
1376 const struct breakpoint_ops
*ops
,
1379 int internal
, unsigned flags
);
1381 extern void insert_breakpoints (void);
1383 extern int remove_breakpoints (void);
1385 extern int remove_breakpoints_inf (inferior
*inf
);
1387 /* This function can be used to update the breakpoint package's state
1388 after an exec() system call has been executed.
1390 This function causes the following:
1392 - All eventpoints are marked "not inserted".
1393 - All eventpoints with a symbolic address are reset such that
1394 the symbolic address must be reevaluated before the eventpoints
1396 - The solib breakpoints are explicitly removed from the breakpoint
1398 - A step-resume breakpoint, if any, is explicitly removed from the
1400 - All eventpoints without a symbolic address are removed from the
1402 extern void update_breakpoints_after_exec (void);
1404 /* This function can be used to physically remove hardware breakpoints
1405 and watchpoints from the specified traced inferior process, without
1406 modifying the breakpoint package's state. This can be useful for
1407 those targets which support following the processes of a fork() or
1408 vfork() system call, when one of the resulting two processes is to
1409 be detached and allowed to run free.
1411 It is an error to use this function on the process whose id is
1413 extern int detach_breakpoints (ptid_t ptid
);
1415 /* This function is called when program space PSPACE is about to be
1416 deleted. It takes care of updating breakpoints to not reference
1417 this PSPACE anymore. */
1418 extern void breakpoint_program_space_exit (struct program_space
*pspace
);
1420 extern void set_longjmp_breakpoint (struct thread_info
*tp
,
1421 struct frame_id frame
);
1422 extern void delete_longjmp_breakpoint (int thread
);
1424 /* Mark all longjmp breakpoints from THREAD for later deletion. */
1425 extern void delete_longjmp_breakpoint_at_next_stop (int thread
);
1427 extern struct breakpoint
*set_longjmp_breakpoint_for_call_dummy (void);
1428 extern void check_longjmp_breakpoint_for_call_dummy (struct thread_info
*tp
);
1430 extern void enable_overlay_breakpoints (void);
1431 extern void disable_overlay_breakpoints (void);
1433 extern void set_std_terminate_breakpoint (void);
1434 extern void delete_std_terminate_breakpoint (void);
1436 /* These functions respectively disable or reenable all currently
1437 enabled watchpoints. When disabled, the watchpoints are marked
1438 call_disabled. When re-enabled, they are marked enabled.
1440 The intended client of these functions is call_function_by_hand.
1442 The inferior must be stopped, and all breakpoints removed, when
1443 these functions are used.
1445 The need for these functions is that on some targets (e.g., HP-UX),
1446 gdb is unable to unwind through the dummy frame that is pushed as
1447 part of the implementation of a call command. Watchpoints can
1448 cause the inferior to stop in places where this frame is visible,
1449 and that can cause execution control to become very confused.
1451 Note that if a user sets breakpoints in an interactively called
1452 function, the call_disabled watchpoints will have been re-enabled
1453 when the first such breakpoint is reached. However, on targets
1454 that are unable to unwind through the call dummy frame, watches
1455 of stack-based storage may then be deleted, because gdb will
1456 believe that their watched storage is out of scope. (Sigh.) */
1457 extern void disable_watchpoints_before_interactive_call_start (void);
1459 extern void enable_watchpoints_after_interactive_call_stop (void);
1461 /* These functions disable and re-enable all breakpoints during
1462 inferior startup. They are intended to be called from solib
1463 code where necessary. This is needed on platforms where the
1464 main executable is relocated at some point during startup
1465 processing, making breakpoint addresses invalid.
1467 If additional breakpoints are created after the routine
1468 disable_breakpoints_before_startup but before the routine
1469 enable_breakpoints_after_startup was called, they will also
1470 be marked as disabled. */
1471 extern void disable_breakpoints_before_startup (void);
1472 extern void enable_breakpoints_after_startup (void);
1474 /* For script interpreters that need to define breakpoint commands
1475 after they've already read the commands into a struct
1477 extern enum command_control_type commands_from_control_command
1478 (const char *arg
, struct command_line
*cmd
);
1480 extern void clear_breakpoint_hit_counts (void);
1482 extern struct breakpoint
*get_breakpoint (int num
);
1484 /* The following are for displays, which aren't really breakpoints,
1485 but here is as good a place as any for them. */
1487 extern void disable_current_display (void);
1489 extern void do_displays (void);
1491 extern void disable_display (int);
1493 extern void clear_displays (void);
1495 extern void disable_breakpoint (struct breakpoint
*);
1497 extern void enable_breakpoint (struct breakpoint
*);
1499 extern void breakpoint_set_commands (struct breakpoint
*b
,
1500 counted_command_line
&&commands
);
1502 extern void breakpoint_set_silent (struct breakpoint
*b
, int silent
);
1504 extern void breakpoint_set_thread (struct breakpoint
*b
, int thread
);
1506 extern void breakpoint_set_task (struct breakpoint
*b
, int task
);
1508 /* Clear the "inserted" flag in all breakpoints. */
1509 extern void mark_breakpoints_out (void);
1511 extern struct breakpoint
*create_jit_event_breakpoint (struct gdbarch
*,
1514 extern struct breakpoint
*create_solib_event_breakpoint (struct gdbarch
*,
1517 /* Create an solib event breakpoint at ADDRESS in the current program
1518 space, and immediately try to insert it. Returns a pointer to the
1519 breakpoint on success. Deletes the new breakpoint and returns NULL
1520 if inserting the breakpoint fails. */
1521 extern struct breakpoint
*create_and_insert_solib_event_breakpoint
1522 (struct gdbarch
*gdbarch
, CORE_ADDR address
);
1524 extern struct breakpoint
*create_thread_event_breakpoint (struct gdbarch
*,
1527 extern void remove_jit_event_breakpoints (void);
1529 extern void remove_solib_event_breakpoints (void);
1531 /* Mark solib event breakpoints of the current program space with
1532 delete at next stop disposition. */
1533 extern void remove_solib_event_breakpoints_at_next_stop (void);
1535 extern void disable_breakpoints_in_shlibs (void);
1537 /* This function returns TRUE if ep is a catchpoint. */
1538 extern int is_catchpoint (struct breakpoint
*);
1540 /* Shared helper function (MI and CLI) for creating and installing
1541 a shared object event catchpoint. */
1542 extern void add_solib_catchpoint (const char *arg
, int is_load
, int is_temp
,
1545 /* Create and insert a new software single step breakpoint for the
1546 current thread. May be called multiple times; each time will add a
1547 new location to the set of potential addresses the next instruction
1549 extern void insert_single_step_breakpoint (struct gdbarch
*,
1550 const address_space
*,
1553 /* Insert all software single step breakpoints for the current frame.
1554 Return true if any software single step breakpoints are inserted,
1555 otherwise, return false. */
1556 extern int insert_single_step_breakpoints (struct gdbarch
*);
1558 /* Check if any hardware watchpoints have triggered, according to the
1560 int watchpoints_triggered (struct target_waitstatus
*);
1562 /* Helper for transparent breakpoint hiding for memory read and write
1565 Update one of READBUF or WRITEBUF with either the shadows
1566 (READBUF), or the breakpoint instructions (WRITEBUF) of inserted
1567 breakpoints at the memory range defined by MEMADDR and extending
1568 for LEN bytes. If writing, then WRITEBUF is a copy of WRITEBUF_ORG
1570 extern void breakpoint_xfer_memory (gdb_byte
*readbuf
, gdb_byte
*writebuf
,
1571 const gdb_byte
*writebuf_org
,
1572 ULONGEST memaddr
, LONGEST len
);
1574 /* Return true if breakpoints should be inserted now. That'll be the
1577 - the target has global breakpoints.
1579 - "breakpoint always-inserted" is on, and the target has
1582 - threads are executing.
1584 extern int breakpoints_should_be_inserted_now (void);
1586 /* Called each time new event from target is processed.
1587 Retires previously deleted breakpoint locations that
1588 in our opinion won't ever trigger. */
1589 extern void breakpoint_retire_moribund (void);
1591 /* Set break condition of breakpoint B to EXP. */
1592 extern void set_breakpoint_condition (struct breakpoint
*b
, const char *exp
,
1595 /* Checks if we are catching syscalls or not.
1596 Returns 0 if not, greater than 0 if we are. */
1597 extern int catch_syscall_enabled (void);
1599 /* Checks if we are catching syscalls with the specific
1600 syscall_number. Used for "filtering" the catchpoints.
1601 Returns 0 if not, greater than 0 if we are. */
1602 extern int catching_syscall_number (int syscall_number
);
1604 /* Return a tracepoint with the given number if found. */
1605 extern struct tracepoint
*get_tracepoint (int num
);
1607 extern struct tracepoint
*get_tracepoint_by_number_on_target (int num
);
1609 /* Find a tracepoint by parsing a number in the supplied string. */
1610 extern struct tracepoint
*
1611 get_tracepoint_by_number (const char **arg
,
1612 number_or_range_parser
*parser
);
1614 /* Return a vector of all tracepoints currently defined. */
1615 extern std::vector
<breakpoint
*> all_tracepoints (void);
1617 extern int is_tracepoint (const struct breakpoint
*b
);
1619 /* Return a vector of all static tracepoints defined at ADDR. */
1620 extern std::vector
<breakpoint
*> static_tracepoints_here (CORE_ADDR addr
);
1622 /* Create an instance of this to start registering breakpoint numbers
1623 for a later "commands" command. */
1625 class scoped_rbreak_breakpoints
1629 scoped_rbreak_breakpoints ();
1630 ~scoped_rbreak_breakpoints ();
1632 DISABLE_COPY_AND_ASSIGN (scoped_rbreak_breakpoints
);
1635 /* Breakpoint iterator function.
1637 Calls a callback function once for each breakpoint, so long as the
1638 callback function returns false. If the callback function returns
1639 true, the iteration will end and the current breakpoint will be
1640 returned. This can be useful for implementing a search for a
1641 breakpoint with arbitrary attributes, or for applying an operation
1642 to every breakpoint. */
1643 extern struct breakpoint
*iterate_over_breakpoints (int (*) (struct breakpoint
*,
1646 /* Nonzero if the specified PC cannot be a location where functions
1647 have been inlined. */
1649 extern int pc_at_non_inline_function (const address_space
*aspace
,
1651 const struct target_waitstatus
*ws
);
1653 extern int user_breakpoint_p (struct breakpoint
*);
1655 /* Return true if this breakpoint is pending, false if not. */
1656 extern int pending_breakpoint_p (struct breakpoint
*);
1658 /* Attempt to determine architecture of location identified by SAL. */
1659 extern struct gdbarch
*get_sal_arch (struct symtab_and_line sal
);
1661 extern void breakpoint_free_objfile (struct objfile
*objfile
);
1663 extern const char *ep_parse_optional_if_clause (const char **arg
);
1665 /* Print the "Thread ID hit" part of "Thread ID hit Breakpoint N" to
1666 UIOUT iff debugging multiple threads. */
1667 extern void maybe_print_thread_hit_breakpoint (struct ui_out
*uiout
);
1669 /* Print the specified breakpoint. */
1670 extern void print_breakpoint (breakpoint
*bp
);
1672 /* Command element for the 'commands' command. */
1673 extern cmd_list_element
*commands_cmd_element
;
1675 #endif /* !defined (BREAKPOINT_H) */