1 /* Data structures associated with breakpoints in GDB.
2 Copyright (C) 1992-2021 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
26 #include "gdbsupport/break-common.h"
30 #include "gdbsupport/array-view.h"
31 #include "gdbsupport/filtered-iterator.h"
32 #include "gdbsupport/function-view.h"
33 #include "gdbsupport/refcounted-object.h"
34 #include "cli/cli-script.h"
37 struct gdbpy_breakpoint_object
;
38 struct gdbscm_breakpoint_object
;
39 struct number_or_range_parser
;
43 struct linespec_result
;
47 /* Enum for exception-handling support in 'catch throw', 'catch rethrow',
48 'catch catch' and the MI equivalent. */
50 enum exception_event_kind
57 /* Why are we removing the breakpoint from the target? */
61 /* A regular remove. Remove the breakpoint and forget everything
65 /* Detach the breakpoints from a fork child. */
69 /* This is the maximum number of bytes a breakpoint instruction can
70 take. Feel free to increase it. It's just used in a few places to
71 size arrays that should be independent of the target
74 #define BREAKPOINT_MAX 16
77 /* Type of breakpoint. */
81 bp_none
= 0, /* Eventpoint has been deleted */
82 bp_breakpoint
, /* Normal breakpoint */
83 bp_hardware_breakpoint
, /* Hardware assisted breakpoint */
84 bp_single_step
, /* Software single-step */
85 bp_until
, /* used by until command */
86 bp_finish
, /* used by finish command */
87 bp_watchpoint
, /* Watchpoint */
88 bp_hardware_watchpoint
, /* Hardware assisted watchpoint */
89 bp_read_watchpoint
, /* read watchpoint, (hardware assisted) */
90 bp_access_watchpoint
, /* access watchpoint, (hardware assisted) */
91 bp_longjmp
, /* secret breakpoint to find longjmp() */
92 bp_longjmp_resume
, /* secret breakpoint to escape longjmp() */
94 /* Breakpoint placed to the same location(s) like bp_longjmp but used to
95 protect against stale DUMMY_FRAME. Multiple bp_longjmp_call_dummy and
96 one bp_call_dummy are chained together by related_breakpoint for each
98 bp_longjmp_call_dummy
,
100 /* An internal breakpoint that is installed on the unwinder's
103 /* An internal breakpoint that is set at the point where an
104 exception will land. */
107 /* Used by wait_for_inferior for stepping over subroutine calls,
108 and for skipping prologues. */
111 /* Used by wait_for_inferior for stepping over signal
115 /* Used to detect when a watchpoint expression has gone out of
116 scope. These breakpoints are usually not visible to the user.
118 This breakpoint has some interesting properties:
120 1) There's always a 1:1 mapping between watchpoints
121 on local variables and watchpoint_scope breakpoints.
123 2) It automatically deletes itself and the watchpoint it's
124 associated with when hit.
126 3) It can never be disabled. */
129 /* The breakpoint at the end of a call dummy. See bp_longjmp_call_dummy it
130 is chained with by related_breakpoint. */
133 /* A breakpoint set on std::terminate, that is used to catch
134 otherwise uncaught exceptions thrown during an inferior call. */
137 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
138 code in the inferior to run when significant events occur in the
139 dynamic linker (for example a library is loaded or unloaded).
141 By placing a breakpoint in this magic code GDB will get control
142 when these significant events occur. GDB can then re-examine
143 the dynamic linker's data structures to discover any newly loaded
144 dynamic libraries. */
147 /* Some multi-threaded systems can arrange for a location in the
148 inferior to be executed when certain thread-related events occur
149 (such as thread creation or thread death).
151 By placing a breakpoint at one of these locations, GDB will get
152 control when these events occur. GDB can then update its thread
157 /* On the same principal, an overlay manager can arrange to call a
158 magic location in the inferior whenever there is an interesting
159 change in overlay status. GDB can update its overlay tables
160 and fiddle with breakpoints in overlays when this breakpoint
165 /* Master copies of longjmp breakpoints. These are always installed
166 as soon as an objfile containing longjmp is loaded, but they are
167 always disabled. While necessary, temporary clones of bp_longjmp
168 type will be created and enabled. */
172 /* Master copies of std::terminate breakpoints. */
173 bp_std_terminate_master
,
175 /* Like bp_longjmp_master, but for exceptions. */
182 bp_static_tracepoint
,
184 /* A dynamic printf stops at the given location, does a formatted
185 print, then automatically continues. (Although this is sort of
186 like a macro packaging up standard breakpoint functionality,
187 GDB doesn't have a way to construct types of breakpoint from
188 elements of behavior.) */
191 /* Event for JIT compiled code generation or deletion. */
194 /* Breakpoint is placed at the STT_GNU_IFUNC resolver. When hit GDB
195 inserts new bp_gnu_ifunc_resolver_return at the caller.
196 bp_gnu_ifunc_resolver is still being kept here as a different thread
197 may still hit it before bp_gnu_ifunc_resolver_return is hit by the
199 bp_gnu_ifunc_resolver
,
201 /* On its hit GDB now know the resolved address of the target
202 STT_GNU_IFUNC function. Associated bp_gnu_ifunc_resolver can be
203 deleted now and the breakpoint moved to the target function entry
205 bp_gnu_ifunc_resolver_return
,
208 /* States of enablement of breakpoint. */
212 bp_disabled
, /* The eventpoint is inactive, and cannot
214 bp_enabled
, /* The eventpoint is active, and can
216 bp_call_disabled
, /* The eventpoint has been disabled while a
217 call into the inferior is "in flight",
218 because some eventpoints interfere with
219 the implementation of a call on some
220 targets. The eventpoint will be
221 automatically enabled and reset when the
222 call "lands" (either completes, or stops
223 at another eventpoint). */
227 /* Disposition of breakpoint. Ie: what to do after hitting it. */
231 disp_del
, /* Delete it */
232 disp_del_at_next_stop
, /* Delete at next stop,
233 whether hit or not */
234 disp_disable
, /* Disable it */
235 disp_donttouch
/* Leave it alone */
238 /* Status of breakpoint conditions used when synchronizing
239 conditions with the target. */
241 enum condition_status
243 condition_unchanged
= 0,
248 /* Information used by targets to insert and remove breakpoints. */
250 struct bp_target_info
252 /* Address space at which the breakpoint was placed. */
253 struct address_space
*placed_address_space
;
255 /* Address at which the breakpoint was placed. This is normally
256 the same as REQUESTED_ADDRESS, except when adjustment happens in
257 gdbarch_breakpoint_from_pc. The most common form of adjustment
258 is stripping an alternate ISA marker from the PC which is used
259 to determine the type of breakpoint to insert. */
260 CORE_ADDR placed_address
;
262 /* Address at which the breakpoint was requested. */
263 CORE_ADDR reqstd_address
;
265 /* If this is a ranged breakpoint, then this field contains the
266 length of the range that will be watched for execution. */
269 /* If the breakpoint lives in memory and reading that memory would
270 give back the breakpoint, instead of the original contents, then
271 the original contents are cached here. Only SHADOW_LEN bytes of
272 this buffer are valid, and only when the breakpoint is inserted. */
273 gdb_byte shadow_contents
[BREAKPOINT_MAX
];
275 /* The length of the data cached in SHADOW_CONTENTS. */
278 /* The breakpoint's kind. It is used in 'kind' parameter in Z
282 /* Conditions the target should evaluate if it supports target-side
283 breakpoint conditions. These are non-owning pointers. */
284 std::vector
<agent_expr
*> conditions
;
286 /* Commands the target should evaluate if it supports target-side
287 breakpoint commands. These are non-owning pointers. */
288 std::vector
<agent_expr
*> tcommands
;
290 /* Flag that is true if the breakpoint should be left in place even
291 when GDB is not connected. */
295 /* GDB maintains two types of information about each breakpoint (or
296 watchpoint, or other related event). The first type corresponds
297 to struct breakpoint; this is a relatively high-level structure
298 which contains the source location(s), stopping conditions, user
299 commands to execute when the breakpoint is hit, and so forth.
301 The second type of information corresponds to struct bp_location.
302 Each breakpoint has one or (eventually) more locations associated
303 with it, which represent target-specific and machine-specific
304 mechanisms for stopping the program. For instance, a watchpoint
305 expression may require multiple hardware watchpoints in order to
306 catch all changes in the value of the expression being watched. */
310 bp_loc_software_breakpoint
,
311 bp_loc_hardware_breakpoint
,
312 bp_loc_hardware_watchpoint
,
313 bp_loc_other
/* Miscellaneous... */
316 class bp_location
: public refcounted_object
319 bp_location () = default;
321 /* Construct a bp_location with the type inferred from OWNER's
323 explicit bp_location (breakpoint
*owner
);
325 /* Construct a bp_location with type TYPE. */
326 bp_location (breakpoint
*owner
, bp_loc_type type
);
328 virtual ~bp_location ();
330 /* Chain pointer to the next breakpoint location for
331 the same parent breakpoint. */
332 bp_location
*next
= NULL
;
334 /* Type of this breakpoint location. */
335 bp_loc_type loc_type
{};
337 /* Each breakpoint location must belong to exactly one higher-level
338 breakpoint. This pointer is NULL iff this bp_location is no
339 longer attached to a breakpoint. For example, when a breakpoint
340 is deleted, its locations may still be found in the
341 moribund_locations list, or if we had stopped for it, in
343 breakpoint
*owner
= NULL
;
345 /* Conditional. Break only if this expression's value is nonzero.
346 Unlike string form of condition, which is associated with
347 breakpoint, this is associated with location, since if breakpoint
348 has several locations, the evaluation of expression can be
349 different for different locations. Only valid for real
350 breakpoints; a watchpoint's conditional expression is stored in
351 the owner breakpoint object. */
354 /* Conditional expression in agent expression
355 bytecode form. This is used for stub-side breakpoint
356 condition evaluation. */
357 agent_expr_up cond_bytecode
;
359 /* Signals that the condition has changed since the last time
360 we updated the global location list. This means the condition
361 needs to be sent to the target again. This is used together
362 with target-side breakpoint conditions.
364 condition_unchanged: It means there has been no condition changes.
366 condition_modified: It means this location had its condition modified.
368 condition_updated: It means we already marked all the locations that are
369 duplicates of this location and thus we don't need to call
370 force_breakpoint_reinsertion (...) for this location. */
372 condition_status condition_changed
{};
374 agent_expr_up cmd_bytecode
;
376 /* Signals that breakpoint conditions and/or commands need to be
377 re-synced with the target. This has no use other than
378 target-side breakpoints. */
379 bool needs_update
= false;
381 /* This location's address is in an unloaded solib, and so this
382 location should not be inserted. It will be automatically
383 enabled when that solib is loaded. */
384 bool shlib_disabled
= false;
386 /* Is this particular location enabled. */
387 bool enabled
= false;
389 /* Is this particular location disabled because the condition
390 expression is invalid at this location. For a location to be
391 reported as enabled, the ENABLED field above has to be true *and*
392 the DISABLED_BY_COND field has to be false. */
393 bool disabled_by_cond
= false;
395 /* True if this breakpoint is now inserted. */
396 bool inserted
= false;
398 /* True if this is a permanent breakpoint. There is a breakpoint
399 instruction hard-wired into the target's code. Don't try to
400 write another breakpoint instruction on top of it, or restore its
401 value. Step over it using the architecture's
402 gdbarch_skip_permanent_breakpoint method. */
403 bool permanent
= false;
405 /* True if this is not the first breakpoint in the list
406 for the given address. location of tracepoint can _never_
407 be duplicated with other locations of tracepoints and other
408 kinds of breakpoints, because two locations at the same
409 address may have different actions, so both of these locations
410 should be downloaded and so that `tfind N' always works. */
411 bool duplicate
= false;
413 /* If we someday support real thread-specific breakpoints, then
414 the breakpoint location will need a thread identifier. */
416 /* Data for specific breakpoint types. These could be a union, but
417 simplicity is more important than memory usage for breakpoints. */
419 /* Architecture associated with this location's address. May be
420 different from the breakpoint architecture. */
421 struct gdbarch
*gdbarch
= NULL
;
423 /* The program space associated with this breakpoint location
424 address. Note that an address space may be represented in more
425 than one program space (e.g. each uClinux program will be given
426 its own program space, but there will only be one address space
427 for all of them), but we must not insert more than one location
428 at the same address in the same address space. */
429 program_space
*pspace
= NULL
;
431 /* Note that zero is a perfectly valid code address on some platforms
432 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
433 is not a special value for this field. Valid for all types except
435 CORE_ADDR address
= 0;
437 /* For hardware watchpoints, the size of the memory region being
438 watched. For hardware ranged breakpoints, the size of the
442 /* Type of hardware watchpoint. */
443 target_hw_bp_type watchpoint_type
{};
445 /* For any breakpoint type with an address, this is the section
446 associated with the address. Used primarily for overlay
448 obj_section
*section
= NULL
;
450 /* Address at which breakpoint was requested, either by the user or
451 by GDB for internal breakpoints. This will usually be the same
452 as ``address'' (above) except for cases in which
453 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
454 which to place the breakpoint in order to comply with a
455 processor's architectual constraints. */
456 CORE_ADDR requested_address
= 0;
458 /* An additional address assigned with this location. This is currently
459 only used by STT_GNU_IFUNC resolver breakpoints to hold the address
460 of the resolver function. */
461 CORE_ADDR related_address
= 0;
463 /* If the location comes from a probe point, this is the probe associated
465 bound_probe probe
{};
467 char *function_name
= NULL
;
469 /* Details of the placed breakpoint, when inserted. */
470 bp_target_info target_info
{};
472 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
473 bp_target_info overlay_target_info
{};
475 /* In a non-stop mode, it's possible that we delete a breakpoint,
476 but as we do that, some still running thread hits that breakpoint.
477 For that reason, we need to keep locations belonging to deleted
478 breakpoints for a bit, so that don't report unexpected SIGTRAP.
479 We can't keep such locations forever, so we use a heuristic --
480 after we process certain number of inferior events since
481 breakpoint was deleted, we retire all locations of that breakpoint.
482 This variable keeps a number of events still to go, when
483 it becomes 0 this location is retired. */
484 int events_till_retirement
= 0;
486 /* Line number which was used to place this location.
488 Breakpoint placed into a comment keeps it's user specified line number
489 despite ADDRESS resolves into a different line number. */
493 /* Symtab which was used to place this location. This is used
494 to find the corresponding source file name. */
496 struct symtab
*symtab
= NULL
;
498 /* The symbol found by the location parser, if any. This may be used to
499 ascertain when an event location was set at a different location than
500 the one originally selected by parsing, e.g., inlined symbols. */
501 const struct symbol
*symbol
= NULL
;
503 /* Similarly, the minimal symbol found by the location parser, if
504 any. This may be used to ascertain if the location was
505 originally set on a GNU ifunc symbol. */
506 const minimal_symbol
*msymbol
= NULL
;
508 /* The objfile the symbol or minimal symbol were found in. */
509 const struct objfile
*objfile
= NULL
;
512 /* A policy class for bp_location reference counting. */
513 struct bp_location_ref_policy
515 static void incref (bp_location
*loc
)
520 static void decref (bp_location
*loc
)
522 gdb_assert (loc
->refcount () > 0);
524 if (loc
->refcount () == 0)
529 /* A gdb::ref_ptr that has been specialized for bp_location. */
530 typedef gdb::ref_ptr
<bp_location
, bp_location_ref_policy
>
533 /* The possible return values for print_bpstat, print_it_normal,
534 print_it_done, print_it_noop. */
535 enum print_stop_action
537 /* We printed nothing or we need to do some more analysis. */
540 /* We printed something, and we *do* desire that something to be
541 followed by a location. */
544 /* We printed something, and we do *not* desire that something to be
545 followed by a location. */
548 /* We already printed all we needed to print, don't print anything
553 /* This structure is a collection of function pointers that, if available,
554 will be called instead of the performing the default action for this
557 struct breakpoint_ops
559 /* Allocate a location for this breakpoint. */
560 struct bp_location
* (*allocate_location
) (struct breakpoint
*);
562 /* Reevaluate a breakpoint. This is necessary after symbols change
563 (e.g., an executable or DSO was loaded, or the inferior just
565 void (*re_set
) (struct breakpoint
*self
);
567 /* Insert the breakpoint or watchpoint or activate the catchpoint.
568 Return 0 for success, 1 if the breakpoint, watchpoint or
569 catchpoint type is not supported, -1 for failure. */
570 int (*insert_location
) (struct bp_location
*);
572 /* Remove the breakpoint/catchpoint that was previously inserted
573 with the "insert" method above. Return 0 for success, 1 if the
574 breakpoint, watchpoint or catchpoint type is not supported,
576 int (*remove_location
) (struct bp_location
*, enum remove_bp_reason reason
);
578 /* Return true if it the target has stopped due to hitting
579 breakpoint location BL. This function does not check if we
580 should stop, only if BL explains the stop. ASPACE is the address
581 space in which the event occurred, BP_ADDR is the address at
582 which the inferior stopped, and WS is the target_waitstatus
583 describing the event. */
584 int (*breakpoint_hit
) (const struct bp_location
*bl
,
585 const address_space
*aspace
,
587 const struct target_waitstatus
*ws
);
589 /* Check internal conditions of the breakpoint referred to by BS.
590 If we should not stop for this breakpoint, set BS->stop to 0. */
591 void (*check_status
) (struct bpstats
*bs
);
593 /* Tell how many hardware resources (debug registers) are needed
594 for this breakpoint. If this function is not provided, then
595 the breakpoint or watchpoint needs one debug register. */
596 int (*resources_needed
) (const struct bp_location
*);
598 /* Tell whether we can downgrade from a hardware watchpoint to a software
599 one. If not, the user will not be able to enable the watchpoint when
600 there are not enough hardware resources available. */
601 int (*works_in_software_mode
) (const struct breakpoint
*);
603 /* The normal print routine for this breakpoint, called when we
605 enum print_stop_action (*print_it
) (struct bpstats
*bs
);
607 /* Display information about this breakpoint, for "info
609 void (*print_one
) (struct breakpoint
*, struct bp_location
**);
611 /* Display extra information about this breakpoint, below the normal
612 breakpoint description in "info breakpoints".
614 In the example below, the "address range" line was printed
615 by print_one_detail_ranged_breakpoint.
617 (gdb) info breakpoints
618 Num Type Disp Enb Address What
619 2 hw breakpoint keep y in main at test-watch.c:70
620 address range: [0x10000458, 0x100004c7]
623 void (*print_one_detail
) (const struct breakpoint
*, struct ui_out
*);
625 /* Display information about this breakpoint after setting it
626 (roughly speaking; this is called from "mention"). */
627 void (*print_mention
) (struct breakpoint
*);
629 /* Print to FP the CLI command that recreates this breakpoint. */
630 void (*print_recreate
) (struct breakpoint
*, struct ui_file
*fp
);
632 /* Create SALs from location, storing the result in linespec_result.
634 For an explanation about the arguments, see the function
635 `create_sals_from_location_default'.
637 This function is called inside `create_breakpoint'. */
638 void (*create_sals_from_location
) (struct event_location
*location
,
639 struct linespec_result
*canonical
,
640 enum bptype type_wanted
);
642 /* This method will be responsible for creating a breakpoint given its SALs.
643 Usually, it just calls `create_breakpoints_sal' (for ordinary
644 breakpoints). However, there may be some special cases where we might
645 need to do some tweaks, e.g., see
646 `strace_marker_create_breakpoints_sal'.
648 This function is called inside `create_breakpoint'. */
649 void (*create_breakpoints_sal
) (struct gdbarch
*,
650 struct linespec_result
*,
651 gdb::unique_xmalloc_ptr
<char>,
652 gdb::unique_xmalloc_ptr
<char>,
653 enum bptype
, enum bpdisp
, int, int,
654 int, const struct breakpoint_ops
*,
655 int, int, int, unsigned);
657 /* Given the location (second parameter), this method decodes it and
658 returns the SAL locations related to it. For ordinary
659 breakpoints, it calls `decode_line_full'. If SEARCH_PSPACE is
660 not NULL, symbol search is restricted to just that program space.
662 This function is called inside `location_to_sals'. */
663 std::vector
<symtab_and_line
> (*decode_location
)
664 (struct breakpoint
*b
,
665 struct event_location
*location
,
666 struct program_space
*search_pspace
);
668 /* Return true if this breakpoint explains a signal. See
669 bpstat_explains_signal. */
670 int (*explains_signal
) (struct breakpoint
*, enum gdb_signal
);
672 /* Called after evaluating the breakpoint's condition,
673 and only if it evaluated true. */
674 void (*after_condition_true
) (struct bpstats
*bs
);
677 /* Helper for breakpoint_ops->print_recreate implementations. Prints
678 the "thread" or "task" condition of B, and then a newline.
680 Necessary because most breakpoint implementations accept
681 thread/task conditions at the end of the spec line, like "break foo
682 thread 1", which needs outputting before any breakpoint-type
683 specific extra command necessary for B's recreation. */
684 extern void print_recreate_thread (struct breakpoint
*b
, struct ui_file
*fp
);
686 enum watchpoint_triggered
688 /* This watchpoint definitely did not trigger. */
689 watch_triggered_no
= 0,
691 /* Some hardware watchpoint triggered, and it might have been this
692 one, but we do not know which it was. */
693 watch_triggered_unknown
,
695 /* This hardware watchpoint definitely did trigger. */
699 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
700 a watchpoint over a memory region. If this flag is true, GDB will use
701 only one register per watchpoint, thus assuming that all accesses that
702 modify a memory location happen at its starting address. */
704 extern bool target_exact_watchpoints
;
706 /* bp_location linked list range. */
708 using bp_locations_range
= next_adapter
<bp_location
>;
710 /* Note that the ->silent field is not currently used by any commands
711 (though the code is in there if it was to be, and set_raw_breakpoint
712 does set it to 0). I implemented it because I thought it would be
713 useful for a hack I had to put in; I'm going to leave it in because
714 I can see how there might be times when it would indeed be useful */
716 /* This is for all kinds of breakpoints. */
720 virtual ~breakpoint ();
722 /* Return a range of this breakpoint's locations. */
723 bp_locations_range
locations ();
725 /* Methods associated with this breakpoint. */
726 const breakpoint_ops
*ops
= NULL
;
728 breakpoint
*next
= NULL
;
729 /* Type of breakpoint. */
730 bptype type
= bp_none
;
731 /* Zero means disabled; remember the info but don't break here. */
732 enum enable_state enable_state
= bp_enabled
;
733 /* What to do with this breakpoint after we hit it. */
734 bpdisp disposition
= disp_del
;
735 /* Number assigned to distinguish breakpoints. */
738 /* Location(s) associated with this high-level breakpoint. */
739 bp_location
*loc
= NULL
;
741 /* True means a silent breakpoint (don't print frame info if we stop
744 /* True means display ADDR_STRING to the user verbatim. */
745 bool display_canonical
= false;
746 /* Number of stops at this breakpoint that should be continued
747 automatically before really stopping. */
748 int ignore_count
= 0;
750 /* Number of stops at this breakpoint before it will be
752 int enable_count
= 0;
754 /* Chain of command lines to execute when this breakpoint is
756 counted_command_line commands
;
757 /* Stack depth (address of frame). If nonzero, break only if fp
759 struct frame_id frame_id
= null_frame_id
;
761 /* The program space used to set the breakpoint. This is only set
762 for breakpoints which are specific to a program space; for
763 non-thread-specific ordinary breakpoints this is NULL. */
764 program_space
*pspace
= NULL
;
766 /* Location we used to set the breakpoint. */
767 event_location_up location
;
769 /* The filter that should be passed to decode_line_full when
770 re-setting this breakpoint. This may be NULL. */
771 gdb::unique_xmalloc_ptr
<char> filter
;
773 /* For a ranged breakpoint, the location we used to find the end of
775 event_location_up location_range_end
;
777 /* Architecture we used to set the breakpoint. */
778 struct gdbarch
*gdbarch
= NULL
;
779 /* Language we used to set the breakpoint. */
780 enum language language
= language_unknown
;
781 /* Input radix we used to set the breakpoint. */
783 /* String form of the breakpoint condition (malloc'd), or NULL if
784 there is no condition. */
785 char *cond_string
= NULL
;
787 /* String form of extra parameters, or NULL if there are none.
789 char *extra_string
= NULL
;
791 /* Holds the address of the related watchpoint_scope breakpoint when
792 using watchpoints on local variables (might the concept of a
793 related breakpoint be useful elsewhere, if not just call it the
794 watchpoint_scope breakpoint or something like that. FIXME). */
795 breakpoint
*related_breakpoint
= NULL
;
797 /* Thread number for thread-specific breakpoint, or -1 if don't
801 /* Ada task number for task-specific breakpoint, or 0 if don't
805 /* Count of the number of times this breakpoint was taken, dumped
806 with the info, but not used for anything else. Useful for seeing
807 how many times you hit a break prior to the program aborting, so
808 you can back up to just before the abort. */
811 /* Is breakpoint's condition not yet parsed because we found no
812 location initially so had no context to parse the condition
814 int condition_not_parsed
= 0;
816 /* With a Python scripting enabled GDB, store a reference to the
817 Python object that has been associated with this breakpoint.
818 This is always NULL for a GDB that is not script enabled. It can
819 sometimes be NULL for enabled GDBs as not all breakpoint types
820 are tracked by the scripting language API. */
821 gdbpy_breakpoint_object
*py_bp_object
= NULL
;
823 /* Same as py_bp_object, but for Scheme. */
824 gdbscm_breakpoint_object
*scm_bp_object
= NULL
;
827 /* An instance of this type is used to represent a watchpoint. */
829 struct watchpoint
: public breakpoint
831 ~watchpoint () override
;
833 /* String form of exp to use for displaying to the user (malloc'd),
836 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
837 char *exp_string_reparse
;
839 /* The expression we are watching, or NULL if not a watchpoint. */
841 /* The largest block within which it is valid, or NULL if it is
842 valid anywhere (e.g. consists just of global symbols). */
843 const struct block
*exp_valid_block
;
844 /* The conditional expression if any. */
845 expression_up cond_exp
;
846 /* The largest block within which it is valid, or NULL if it is
847 valid anywhere (e.g. consists just of global symbols). */
848 const struct block
*cond_exp_valid_block
;
849 /* Value of the watchpoint the last time we checked it, or NULL when
850 we do not know the value yet or the value was not readable. VAL
854 /* True if VAL is valid. If VAL_VALID is set but VAL is NULL,
855 then an error occurred reading the value. */
858 /* When watching the location of a bitfield, contains the offset and size of
859 the bitfield. Otherwise contains 0. */
863 /* Holds the frame address which identifies the frame this
864 watchpoint should be evaluated in, or `null' if the watchpoint
865 should be evaluated on the outermost frame. */
866 struct frame_id watchpoint_frame
;
868 /* Holds the thread which identifies the frame this watchpoint
869 should be considered in scope for, or `null_ptid' if the
870 watchpoint should be evaluated in all threads. */
871 ptid_t watchpoint_thread
;
873 /* For hardware watchpoints, the triggered status according to the
875 enum watchpoint_triggered watchpoint_triggered
;
877 /* Whether this watchpoint is exact (see
878 target_exact_watchpoints). */
881 /* The mask address for a masked hardware watchpoint. */
882 CORE_ADDR hw_wp_mask
;
885 /* Given a function FUNC (struct breakpoint *B, void *DATA) and
886 USER_DATA, call FUNC for every known breakpoint passing USER_DATA
889 If FUNC returns 1, the loop stops and the current
890 'struct breakpoint' being processed is returned. If FUNC returns
891 zero, the loop continues.
893 This function returns either a 'struct breakpoint' pointer or NULL.
894 It was based on BFD's bfd_sections_find_if function. */
896 extern struct breakpoint
*breakpoint_find_if
897 (int (*func
) (struct breakpoint
*b
, void *d
), void *user_data
);
899 /* Return true if BPT is either a software breakpoint or a hardware
902 extern bool is_breakpoint (const struct breakpoint
*bpt
);
904 /* Return true if BPT is of any watchpoint kind, hardware or
907 extern bool is_watchpoint (const struct breakpoint
*bpt
);
909 /* Return true if BPT is a C++ exception catchpoint (catch
910 catch/throw/rethrow). */
912 extern bool is_exception_catchpoint (breakpoint
*bp
);
914 /* An instance of this type is used to represent all kinds of
917 struct tracepoint
: public breakpoint
919 /* Number of times this tracepoint should single-step and collect
923 /* Number of times this tracepoint should be hit before
927 /* The number of the tracepoint on the target. */
928 int number_on_target
;
930 /* The total space taken by all the trace frames for this
932 ULONGEST traceframe_usage
;
934 /* The static tracepoint marker id, if known. */
935 std::string static_trace_marker_id
;
937 /* LTTng/UST allow more than one marker with the same ID string,
938 although it unadvised because it confuses tools. When setting
939 static tracepoints by marker ID, this will record the index in
940 the array of markers we found for the given marker ID for which
941 this static tracepoint corresponds. When resetting breakpoints,
942 we will use this index to try to find the same marker again. */
943 int static_trace_marker_id_idx
;
947 /* The following stuff is an abstract data type "bpstat" ("breakpoint
948 status"). This provides the ability to determine whether we have
949 stopped at a breakpoint, and what we should do about it. */
951 typedef struct bpstats
*bpstat
;
953 /* Clears a chain of bpstat, freeing storage
955 extern void bpstat_clear (bpstat
*);
957 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
958 is part of the bpstat is copied as well. */
959 extern bpstat
bpstat_copy (bpstat
);
961 /* Build the (raw) bpstat chain for the stop information given by ASPACE,
962 BP_ADDR, and WS. Returns the head of the bpstat chain. */
964 extern bpstat
build_bpstat_chain (const address_space
*aspace
,
966 const struct target_waitstatus
*ws
);
968 /* Get a bpstat associated with having just stopped at address
969 BP_ADDR in thread PTID. STOP_CHAIN may be supplied as a previously
970 computed stop chain or NULL, in which case the stop chain will be
971 computed using build_bpstat_chain.
973 Determine whether we stopped at a breakpoint, etc, or whether we
974 don't understand this stop. Result is a chain of bpstat's such
977 if we don't understand the stop, the result is a null pointer.
979 if we understand why we stopped, the result is not null.
981 Each element of the chain refers to a particular breakpoint or
982 watchpoint at which we have stopped. (We may have stopped for
983 several reasons concurrently.)
985 Each element of the chain has valid next, breakpoint_at,
986 commands, FIXME??? fields. */
988 extern bpstat
bpstat_stop_status (const address_space
*aspace
,
989 CORE_ADDR pc
, thread_info
*thread
,
990 const struct target_waitstatus
*ws
,
991 bpstat stop_chain
= NULL
);
993 /* This bpstat_what stuff tells wait_for_inferior what to do with a
994 breakpoint (a challenging task).
996 The enum values order defines priority-like order of the actions.
997 Once you've decided that some action is appropriate, you'll never
998 go back and decide something of a lower priority is better. Each
999 of these actions is mutually exclusive with the others. That
1000 means, that if you find yourself adding a new action class here and
1001 wanting to tell GDB that you have two simultaneous actions to
1002 handle, something is wrong, and you probably don't actually need a
1005 Note that a step resume breakpoint overrides another breakpoint of
1006 signal handling (see comment in wait_for_inferior at where we set
1007 the step_resume breakpoint). */
1009 enum bpstat_what_main_action
1011 /* Perform various other tests; that is, this bpstat does not
1012 say to perform any action (e.g. failed watchpoint and nothing
1014 BPSTAT_WHAT_KEEP_CHECKING
,
1016 /* Remove breakpoints, single step once, then put them back in and
1017 go back to what we were doing. It's possible that this should
1018 be removed from the main_action and put into a separate field,
1019 to more cleanly handle
1020 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
1023 /* Set longjmp_resume breakpoint, remove all other breakpoints,
1024 and continue. The "remove all other breakpoints" part is
1025 required if we are also stepping over another breakpoint as
1026 well as doing the longjmp handling. */
1027 BPSTAT_WHAT_SET_LONGJMP_RESUME
,
1029 /* Clear longjmp_resume breakpoint, then handle as
1030 BPSTAT_WHAT_KEEP_CHECKING. */
1031 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME
,
1033 /* Clear step resume breakpoint, and keep checking. */
1034 BPSTAT_WHAT_STEP_RESUME
,
1036 /* Rather than distinguish between noisy and silent stops here, it
1037 might be cleaner to have bpstat_print make that decision (also
1038 taking into account stop_print_frame and source_only). But the
1039 implications are a bit scary (interaction with auto-displays,
1040 etc.), so I won't try it. */
1042 /* Stop silently. */
1043 BPSTAT_WHAT_STOP_SILENT
,
1045 /* Stop and print. */
1046 BPSTAT_WHAT_STOP_NOISY
,
1048 /* Clear step resume breakpoint, and keep checking. High-priority
1049 step-resume breakpoints are used when even if there's a user
1050 breakpoint at the current PC when we set the step-resume
1051 breakpoint, we don't want to re-handle any breakpoint other
1052 than the step-resume when it's hit; instead we want to move
1053 past the breakpoint. This is used in the case of skipping
1055 BPSTAT_WHAT_HP_STEP_RESUME
,
1058 /* An enum indicating the kind of "stack dummy" stop. This is a bit
1059 of a misnomer because only one kind of truly a stack dummy. */
1060 enum stop_stack_kind
1062 /* We didn't stop at a stack dummy breakpoint. */
1065 /* Stopped at a stack dummy. */
1068 /* Stopped at std::terminate. */
1074 enum bpstat_what_main_action main_action
;
1076 /* Did we hit a call dummy breakpoint? This only goes with a
1077 main_action of BPSTAT_WHAT_STOP_SILENT or
1078 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
1079 dummy without popping the frame is not a useful one). */
1080 enum stop_stack_kind call_dummy
;
1082 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
1083 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
1084 longjmp, false if we are handling an exception. */
1088 /* Tell what to do about this bpstat. */
1089 struct bpstat_what
bpstat_what (bpstat
);
1091 /* Run breakpoint event callbacks associated with the breakpoints that
1093 extern void bpstat_run_callbacks (bpstat bs_head
);
1095 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
1096 bpstat
bpstat_find_breakpoint (bpstat
, struct breakpoint
*);
1098 /* True if a signal that we got in target_wait() was due to
1099 circumstances explained by the bpstat; the signal is therefore not
1101 extern bool bpstat_explains_signal (bpstat
, enum gdb_signal
);
1103 /* True if this bpstat causes a stop. */
1104 extern bool bpstat_causes_stop (bpstat
);
1106 /* True if we should step constantly (e.g. watchpoints on machines
1107 without hardware support). This isn't related to a specific bpstat,
1108 just to things like whether watchpoints are set. */
1109 extern bool bpstat_should_step ();
1111 /* Print a message indicating what happened. Returns nonzero to
1112 say that only the source line should be printed after this (zero
1113 return means print the frame as well as the source line). */
1114 extern enum print_stop_action
bpstat_print (bpstat
, int);
1116 /* Put in *NUM the breakpoint number of the first breakpoint we are
1117 stopped at. *BSP upon return is a bpstat which points to the
1118 remaining breakpoints stopped at (but which is not guaranteed to be
1119 good for anything but further calls to bpstat_num).
1121 Return 0 if passed a bpstat which does not indicate any breakpoints.
1122 Return -1 if stopped at a breakpoint that has been deleted since
1124 Return 1 otherwise. */
1125 extern int bpstat_num (bpstat
*, int *);
1127 /* Perform actions associated with the stopped inferior. Actually, we
1128 just use this for breakpoint commands. Perhaps other actions will
1129 go here later, but this is executed at a late time (from the
1131 extern void bpstat_do_actions (void);
1133 /* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will
1134 not be performed. */
1135 extern void bpstat_clear_actions (void);
1137 /* Implementation: */
1139 /* Values used to tell the printing routine how to behave for this
1143 /* This is used when we want to do a normal printing of the reason
1144 for stopping. The output will depend on the type of eventpoint
1145 we are dealing with. This is the default value, most commonly
1148 /* This is used when nothing should be printed for this bpstat
1151 /* This is used when everything which needs to be printed has
1152 already been printed. But we still want to print the frame. */
1159 bpstats (struct bp_location
*bl
, bpstat
**bs_link_pointer
);
1161 bpstats (const bpstats
&);
1162 bpstats
&operator= (const bpstats
&) = delete;
1164 /* Linked list because there can be more than one breakpoint at
1165 the same place, and a bpstat reflects the fact that all have
1169 /* Location that caused the stop. Locations are refcounted, so
1170 this will never be NULL. Note that this location may end up
1171 detached from a breakpoint, but that does not necessary mean
1172 that the struct breakpoint is gone. E.g., consider a
1173 watchpoint with a condition that involves an inferior function
1174 call. Watchpoint locations are recreated often (on resumes,
1175 hence on infcalls too). Between creating the bpstat and after
1176 evaluating the watchpoint condition, this location may hence
1177 end up detached from its original owner watchpoint, even though
1178 the watchpoint is still listed. If it's condition evaluates as
1179 true, we still want this location to cause a stop, and we will
1180 still need to know which watchpoint it was originally attached.
1181 What this means is that we should not (in most cases) follow
1182 the `bpstat->bp_location->owner' link, but instead use the
1183 `breakpoint_at' field below. */
1184 bp_location_ref_ptr bp_location_at
;
1186 /* Breakpoint that caused the stop. This is nullified if the
1187 breakpoint ends up being deleted. See comments on
1188 `bp_location_at' above for why do we need this field instead of
1189 following the location's owner. */
1190 struct breakpoint
*breakpoint_at
;
1192 /* The associated command list. */
1193 counted_command_line commands
;
1195 /* Old value associated with a watchpoint. */
1196 value_ref_ptr old_val
;
1198 /* Nonzero if this breakpoint tells us to print the frame. */
1201 /* Nonzero if this breakpoint tells us to stop. */
1204 /* Tell bpstat_print and print_bp_stop_message how to print stuff
1205 associated with this element of the bpstat chain. */
1206 enum bp_print_how print_it
;
1217 /* The possible return values for breakpoint_here_p.
1218 We guarantee that zero always means "no breakpoint here". */
1219 enum breakpoint_here
1221 no_breakpoint_here
= 0,
1222 ordinary_breakpoint_here
,
1223 permanent_breakpoint_here
1227 /* Prototypes for breakpoint-related functions. */
1229 extern enum breakpoint_here
breakpoint_here_p (const address_space
*,
1232 /* Return true if an enabled breakpoint exists in the range defined by
1233 ADDR and LEN, in ASPACE. */
1234 extern int breakpoint_in_range_p (const address_space
*aspace
,
1235 CORE_ADDR addr
, ULONGEST len
);
1237 extern int moribund_breakpoint_here_p (const address_space
*, CORE_ADDR
);
1239 extern int breakpoint_inserted_here_p (const address_space
*,
1242 extern int software_breakpoint_inserted_here_p (const address_space
*,
1245 /* Return non-zero iff there is a hardware breakpoint inserted at
1247 extern int hardware_breakpoint_inserted_here_p (const address_space
*,
1250 /* Check whether any location of BP is inserted at PC. */
1252 extern int breakpoint_has_location_inserted_here (struct breakpoint
*bp
,
1253 const address_space
*aspace
,
1256 extern int single_step_breakpoint_inserted_here_p (const address_space
*,
1259 /* Returns true if there's a hardware watchpoint or access watchpoint
1260 inserted in the range defined by ADDR and LEN. */
1261 extern int hardware_watchpoint_inserted_in_range (const address_space
*,
1265 /* Returns true if {ASPACE1,ADDR1} and {ASPACE2,ADDR2} represent the
1266 same breakpoint location. In most targets, this can only be true
1267 if ASPACE1 matches ASPACE2. On targets that have global
1268 breakpoints, the address space doesn't really matter. */
1270 extern int breakpoint_address_match (const address_space
*aspace1
,
1272 const address_space
*aspace2
,
1275 extern void until_break_command (const char *, int, int);
1277 /* Initialize a struct bp_location. */
1279 extern void update_breakpoint_locations
1280 (struct breakpoint
*b
,
1281 struct program_space
*filter_pspace
,
1282 gdb::array_view
<const symtab_and_line
> sals
,
1283 gdb::array_view
<const symtab_and_line
> sals_end
);
1285 extern void breakpoint_re_set (void);
1287 extern void breakpoint_re_set_thread (struct breakpoint
*);
1289 extern void delete_breakpoint (struct breakpoint
*);
1291 struct breakpoint_deleter
1293 void operator() (struct breakpoint
*b
) const
1295 delete_breakpoint (b
);
1299 typedef std::unique_ptr
<struct breakpoint
, breakpoint_deleter
> breakpoint_up
;
1301 extern breakpoint_up set_momentary_breakpoint
1302 (struct gdbarch
*, struct symtab_and_line
, struct frame_id
, enum bptype
);
1304 extern breakpoint_up set_momentary_breakpoint_at_pc
1305 (struct gdbarch
*, CORE_ADDR pc
, enum bptype type
);
1307 extern struct breakpoint
*clone_momentary_breakpoint (struct breakpoint
*bpkt
);
1309 extern void set_ignore_count (int, int, int);
1311 extern void breakpoint_init_inferior (enum inf_context
);
1313 extern void breakpoint_auto_delete (bpstat
);
1315 extern void iterate_over_bp_locations
1316 (gdb::function_view
<void (bp_location
*)> callback
);
1318 /* Return the chain of command lines to execute when this breakpoint
1320 extern struct command_line
*breakpoint_commands (struct breakpoint
*b
);
1322 /* Return a string image of DISP. The string is static, and thus should
1323 NOT be deallocated after use. */
1324 const char *bpdisp_text (enum bpdisp disp
);
1326 extern void break_command (const char *, int);
1328 extern void watch_command_wrapper (const char *, int, bool);
1329 extern void awatch_command_wrapper (const char *, int, bool);
1330 extern void rwatch_command_wrapper (const char *, int, bool);
1331 extern void tbreak_command (const char *, int);
1333 extern struct breakpoint_ops base_breakpoint_ops
;
1334 extern struct breakpoint_ops bkpt_breakpoint_ops
;
1335 extern struct breakpoint_ops tracepoint_breakpoint_ops
;
1336 extern struct breakpoint_ops dprintf_breakpoint_ops
;
1338 extern void initialize_breakpoint_ops (void);
1340 /* Arguments to pass as context to some catch command handlers. */
1341 #define CATCH_PERMANENT ((void *) (uintptr_t) 0)
1342 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
1344 /* Like add_cmd, but add the command to both the "catch" and "tcatch"
1345 lists, and pass some additional user data to the command
1349 add_catch_command (const char *name
, const char *docstring
,
1350 cmd_const_sfunc_ftype
*sfunc
,
1351 completer_ftype
*completer
,
1352 void *user_data_catch
,
1353 void *user_data_tcatch
);
1355 /* Initialize a breakpoint struct for Ada exception catchpoints. */
1358 init_ada_exception_breakpoint (struct breakpoint
*b
,
1359 struct gdbarch
*gdbarch
,
1360 struct symtab_and_line sal
,
1361 const char *addr_string
,
1362 const struct breakpoint_ops
*ops
,
1367 /* Initialize a new breakpoint of the bp_catchpoint kind. If TEMP
1368 is true, then make the breakpoint temporary. If COND_STRING is
1369 not NULL, then store it in the breakpoint. OPS, if not NULL, is
1370 the breakpoint_ops structure associated to the catchpoint. */
1372 extern void init_catchpoint (struct breakpoint
*b
,
1373 struct gdbarch
*gdbarch
, bool temp
,
1374 const char *cond_string
,
1375 const struct breakpoint_ops
*ops
);
1377 /* Add breakpoint B on the breakpoint list, and notify the user, the
1378 target and breakpoint_created observers of its existence. If
1379 INTERNAL is non-zero, the breakpoint number will be allocated from
1380 the internal breakpoint count. If UPDATE_GLL is non-zero,
1381 update_global_location_list will be called. */
1383 extern void install_breakpoint (int internal
, std::unique_ptr
<breakpoint
> &&b
,
1386 /* Returns the breakpoint ops appropriate for use with with LOCATION and
1387 according to IS_TRACEPOINT. Use this to ensure, for example, that you pass
1388 the correct ops to create_breakpoint for probe locations. If LOCATION is
1389 NULL, returns bkpt_breakpoint_ops (or tracepoint_breakpoint_ops, if
1390 IS_TRACEPOINT is true). */
1392 extern const struct breakpoint_ops
*breakpoint_ops_for_event_location
1393 (const struct event_location
*location
, bool is_tracepoint
);
1395 /* Flags that can be passed down to create_breakpoint, etc., to affect
1396 breakpoint creation in several ways. */
1398 enum breakpoint_create_flags
1400 /* We're adding a breakpoint to our tables that is already
1401 inserted in the target. */
1402 CREATE_BREAKPOINT_FLAGS_INSERTED
= 1 << 0
1405 /* Set a breakpoint. This function is shared between CLI and MI functions
1406 for setting a breakpoint at LOCATION.
1408 This function has two major modes of operations, selected by the
1409 PARSE_EXTRA parameter.
1411 If PARSE_EXTRA is zero, LOCATION is just the breakpoint's location,
1412 with condition, thread, and extra string specified by the COND_STRING,
1413 THREAD, and EXTRA_STRING parameters.
1415 If PARSE_EXTRA is non-zero, this function will attempt to extract
1416 the condition, thread, and extra string from EXTRA_STRING, ignoring
1417 the similarly named parameters.
1419 If FORCE_CONDITION is true, the condition is accepted even when it is
1420 invalid at all of the locations. However, if PARSE_EXTRA is non-zero,
1421 the FORCE_CONDITION parameter is ignored and the corresponding argument
1422 is parsed from EXTRA_STRING.
1424 If INTERNAL is non-zero, the breakpoint number will be allocated
1425 from the internal breakpoint count.
1427 Returns true if any breakpoint was created; false otherwise. */
1429 extern int create_breakpoint (struct gdbarch
*gdbarch
,
1430 struct event_location
*location
,
1431 const char *cond_string
, int thread
,
1432 const char *extra_string
,
1433 bool force_condition
,
1435 int tempflag
, enum bptype wanted_type
,
1437 enum auto_boolean pending_break_support
,
1438 const struct breakpoint_ops
*ops
,
1441 int internal
, unsigned flags
);
1443 extern void insert_breakpoints (void);
1445 extern int remove_breakpoints (void);
1447 /* Remove breakpoints of inferior INF. */
1449 extern void remove_breakpoints_inf (inferior
*inf
);
1451 /* This function can be used to update the breakpoint package's state
1452 after an exec() system call has been executed.
1454 This function causes the following:
1456 - All eventpoints are marked "not inserted".
1457 - All eventpoints with a symbolic address are reset such that
1458 the symbolic address must be reevaluated before the eventpoints
1460 - The solib breakpoints are explicitly removed from the breakpoint
1462 - A step-resume breakpoint, if any, is explicitly removed from the
1464 - All eventpoints without a symbolic address are removed from the
1466 extern void update_breakpoints_after_exec (void);
1468 /* This function can be used to physically remove hardware breakpoints
1469 and watchpoints from the specified traced inferior process, without
1470 modifying the breakpoint package's state. This can be useful for
1471 those targets which support following the processes of a fork() or
1472 vfork() system call, when one of the resulting two processes is to
1473 be detached and allowed to run free.
1475 It is an error to use this function on the process whose id is
1477 extern int detach_breakpoints (ptid_t ptid
);
1479 /* This function is called when program space PSPACE is about to be
1480 deleted. It takes care of updating breakpoints to not reference
1481 this PSPACE anymore. */
1482 extern void breakpoint_program_space_exit (struct program_space
*pspace
);
1484 extern void set_longjmp_breakpoint (struct thread_info
*tp
,
1485 struct frame_id frame
);
1486 extern void delete_longjmp_breakpoint (int thread
);
1488 /* Mark all longjmp breakpoints from THREAD for later deletion. */
1489 extern void delete_longjmp_breakpoint_at_next_stop (int thread
);
1491 extern struct breakpoint
*set_longjmp_breakpoint_for_call_dummy (void);
1492 extern void check_longjmp_breakpoint_for_call_dummy (struct thread_info
*tp
);
1494 extern void enable_overlay_breakpoints (void);
1495 extern void disable_overlay_breakpoints (void);
1497 extern void set_std_terminate_breakpoint (void);
1498 extern void delete_std_terminate_breakpoint (void);
1500 /* These functions respectively disable or reenable all currently
1501 enabled watchpoints. When disabled, the watchpoints are marked
1502 call_disabled. When re-enabled, they are marked enabled.
1504 The intended client of these functions is call_function_by_hand.
1506 The inferior must be stopped, and all breakpoints removed, when
1507 these functions are used.
1509 The need for these functions is that on some targets (e.g., HP-UX),
1510 gdb is unable to unwind through the dummy frame that is pushed as
1511 part of the implementation of a call command. Watchpoints can
1512 cause the inferior to stop in places where this frame is visible,
1513 and that can cause execution control to become very confused.
1515 Note that if a user sets breakpoints in an interactively called
1516 function, the call_disabled watchpoints will have been re-enabled
1517 when the first such breakpoint is reached. However, on targets
1518 that are unable to unwind through the call dummy frame, watches
1519 of stack-based storage may then be deleted, because gdb will
1520 believe that their watched storage is out of scope. (Sigh.) */
1521 extern void disable_watchpoints_before_interactive_call_start (void);
1523 extern void enable_watchpoints_after_interactive_call_stop (void);
1525 /* These functions disable and re-enable all breakpoints during
1526 inferior startup. They are intended to be called from solib
1527 code where necessary. This is needed on platforms where the
1528 main executable is relocated at some point during startup
1529 processing, making breakpoint addresses invalid.
1531 If additional breakpoints are created after the routine
1532 disable_breakpoints_before_startup but before the routine
1533 enable_breakpoints_after_startup was called, they will also
1534 be marked as disabled. */
1535 extern void disable_breakpoints_before_startup (void);
1536 extern void enable_breakpoints_after_startup (void);
1538 /* For script interpreters that need to define breakpoint commands
1539 after they've already read the commands into a struct
1541 extern enum command_control_type commands_from_control_command
1542 (const char *arg
, struct command_line
*cmd
);
1544 extern void clear_breakpoint_hit_counts (void);
1546 extern struct breakpoint
*get_breakpoint (int num
);
1548 /* The following are for displays, which aren't really breakpoints,
1549 but here is as good a place as any for them. */
1551 extern void disable_current_display (void);
1553 extern void do_displays (void);
1555 extern void disable_display (int);
1557 extern void clear_displays (void);
1559 extern void disable_breakpoint (struct breakpoint
*);
1561 extern void enable_breakpoint (struct breakpoint
*);
1563 extern void breakpoint_set_commands (struct breakpoint
*b
,
1564 counted_command_line
&&commands
);
1566 extern void breakpoint_set_silent (struct breakpoint
*b
, int silent
);
1568 extern void breakpoint_set_thread (struct breakpoint
*b
, int thread
);
1570 extern void breakpoint_set_task (struct breakpoint
*b
, int task
);
1572 /* Clear the "inserted" flag in all breakpoints. */
1573 extern void mark_breakpoints_out (void);
1575 extern struct breakpoint
*create_jit_event_breakpoint (struct gdbarch
*,
1578 extern struct breakpoint
*create_solib_event_breakpoint (struct gdbarch
*,
1581 /* Create an solib event breakpoint at ADDRESS in the current program
1582 space, and immediately try to insert it. Returns a pointer to the
1583 breakpoint on success. Deletes the new breakpoint and returns NULL
1584 if inserting the breakpoint fails. */
1585 extern struct breakpoint
*create_and_insert_solib_event_breakpoint
1586 (struct gdbarch
*gdbarch
, CORE_ADDR address
);
1588 extern struct breakpoint
*create_thread_event_breakpoint (struct gdbarch
*,
1591 extern void remove_jit_event_breakpoints (void);
1593 extern void remove_solib_event_breakpoints (void);
1595 /* Mark solib event breakpoints of the current program space with
1596 delete at next stop disposition. */
1597 extern void remove_solib_event_breakpoints_at_next_stop (void);
1599 extern void disable_breakpoints_in_shlibs (void);
1601 /* This function returns true if B is a catchpoint. */
1603 extern bool is_catchpoint (struct breakpoint
*b
);
1605 /* Shared helper function (MI and CLI) for creating and installing
1606 a shared object event catchpoint. If IS_LOAD is true then
1607 the events to be caught are load events, otherwise they are
1608 unload events. If IS_TEMP is true the catchpoint is a
1609 temporary one. If ENABLED is true the catchpoint is
1610 created in an enabled state. */
1612 extern void add_solib_catchpoint (const char *arg
, bool is_load
, bool is_temp
,
1615 /* Create and insert a new software single step breakpoint for the
1616 current thread. May be called multiple times; each time will add a
1617 new location to the set of potential addresses the next instruction
1619 extern void insert_single_step_breakpoint (struct gdbarch
*,
1620 const address_space
*,
1623 /* Insert all software single step breakpoints for the current frame.
1624 Return true if any software single step breakpoints are inserted,
1625 otherwise, return false. */
1626 extern int insert_single_step_breakpoints (struct gdbarch
*);
1628 /* Check if any hardware watchpoints have triggered, according to the
1630 int watchpoints_triggered (struct target_waitstatus
*);
1632 /* Helper for transparent breakpoint hiding for memory read and write
1635 Update one of READBUF or WRITEBUF with either the shadows
1636 (READBUF), or the breakpoint instructions (WRITEBUF) of inserted
1637 breakpoints at the memory range defined by MEMADDR and extending
1638 for LEN bytes. If writing, then WRITEBUF is a copy of WRITEBUF_ORG
1640 extern void breakpoint_xfer_memory (gdb_byte
*readbuf
, gdb_byte
*writebuf
,
1641 const gdb_byte
*writebuf_org
,
1642 ULONGEST memaddr
, LONGEST len
);
1644 /* Return true if breakpoints should be inserted now. That'll be the
1647 - the target has global breakpoints.
1649 - "breakpoint always-inserted" is on, and the target has
1652 - threads are executing.
1654 extern int breakpoints_should_be_inserted_now (void);
1656 /* Called each time new event from target is processed.
1657 Retires previously deleted breakpoint locations that
1658 in our opinion won't ever trigger. */
1659 extern void breakpoint_retire_moribund (void);
1661 /* Set break condition of breakpoint B to EXP.
1662 If FORCE, define the condition even if it is invalid in
1663 all of the breakpoint locations. */
1664 extern void set_breakpoint_condition (struct breakpoint
*b
, const char *exp
,
1665 int from_tty
, bool force
);
1667 /* Set break condition for the breakpoint with number BPNUM to EXP.
1668 Raise an error if no breakpoint with the given number is found.
1669 Also raise an error if the breakpoint already has stop conditions.
1670 If FORCE, define the condition even if it is invalid in
1671 all of the breakpoint locations. */
1672 extern void set_breakpoint_condition (int bpnum
, const char *exp
,
1673 int from_tty
, bool force
);
1675 /* Checks if we are catching syscalls or not.
1676 Returns 0 if not, greater than 0 if we are. */
1677 extern int catch_syscall_enabled (void);
1679 /* Checks if we are catching syscalls with the specific
1680 syscall_number. Used for "filtering" the catchpoints.
1681 Returns 0 if not, greater than 0 if we are. */
1682 extern int catching_syscall_number (int syscall_number
);
1684 /* Return a tracepoint with the given number if found. */
1685 extern struct tracepoint
*get_tracepoint (int num
);
1687 extern struct tracepoint
*get_tracepoint_by_number_on_target (int num
);
1689 /* Find a tracepoint by parsing a number in the supplied string. */
1690 extern struct tracepoint
*
1691 get_tracepoint_by_number (const char **arg
,
1692 number_or_range_parser
*parser
);
1694 /* Return true if B is of tracepoint kind. */
1696 extern bool is_tracepoint (const struct breakpoint
*b
);
1698 /* Return a vector of all static tracepoints defined at ADDR. */
1699 extern std::vector
<breakpoint
*> static_tracepoints_here (CORE_ADDR addr
);
1701 /* Create an instance of this to start registering breakpoint numbers
1702 for a later "commands" command. */
1704 class scoped_rbreak_breakpoints
1708 scoped_rbreak_breakpoints ();
1709 ~scoped_rbreak_breakpoints ();
1711 DISABLE_COPY_AND_ASSIGN (scoped_rbreak_breakpoints
);
1714 /* Breakpoint iterator function.
1716 Calls a callback function once for each breakpoint, so long as the
1717 callback function returns false. If the callback function returns
1718 true, the iteration will end and the current breakpoint will be
1719 returned. This can be useful for implementing a search for a
1720 breakpoint with arbitrary attributes, or for applying an operation
1721 to every breakpoint. */
1722 extern struct breakpoint
*iterate_over_breakpoints
1723 (gdb::function_view
<bool (breakpoint
*)>);
1725 /* Breakpoint linked list iterator. */
1727 using breakpoint_iterator
= next_iterator
<breakpoint
>;
1729 /* Breakpoint filter to only keep tracepoints. */
1731 struct tracepoint_filter
1733 bool operator() (breakpoint
*b
)
1734 { return is_tracepoint (b
); }
1737 /* Breakpoint linked list iterator, filtering to only keep tracepoints. */
1739 using tracepoint_iterator
1740 = filtered_iterator
<breakpoint_iterator
, tracepoint_filter
>;
1742 /* Breakpoint linked list range, filtering to only keep tracepoints. */
1744 using tracepoint_range
= next_adapter
<breakpoint
, tracepoint_iterator
>;
1746 /* Return a range to iterate over all tracepoints. */
1748 tracepoint_range
all_tracepoints ();
1750 /* Nonzero if the specified PC cannot be a location where functions
1751 have been inlined. */
1753 extern int pc_at_non_inline_function (const address_space
*aspace
,
1755 const struct target_waitstatus
*ws
);
1757 extern int user_breakpoint_p (struct breakpoint
*);
1759 /* Return true if this breakpoint is pending, false if not. */
1760 extern int pending_breakpoint_p (struct breakpoint
*);
1762 /* Attempt to determine architecture of location identified by SAL. */
1763 extern struct gdbarch
*get_sal_arch (struct symtab_and_line sal
);
1765 extern void breakpoint_free_objfile (struct objfile
*objfile
);
1767 extern const char *ep_parse_optional_if_clause (const char **arg
);
1769 /* Print the "Thread ID hit" part of "Thread ID hit Breakpoint N" to
1770 UIOUT iff debugging multiple threads. */
1771 extern void maybe_print_thread_hit_breakpoint (struct ui_out
*uiout
);
1773 /* Print the specified breakpoint. */
1774 extern void print_breakpoint (breakpoint
*bp
);
1776 /* Command element for the 'commands' command. */
1777 extern cmd_list_element
*commands_cmd_element
;
1779 /* Whether to use the fixed output when printing information about a
1780 multi-location breakpoint (see PR 9659). */
1782 extern bool fix_multi_location_breakpoint_output_globally
;
1784 /* Deal with "catch catch", "catch throw", and "catch rethrow" commands and
1785 the MI equivalents. Sets up to catch events of type EX_EVENT. When
1786 TEMPFLAG is true only the next matching event is caught after which the
1787 catch-point is deleted. If REGEX is not NULL then only exceptions whose
1788 type name matches REGEX will trigger the event. */
1790 extern void catch_exception_event (enum exception_event_kind ex_event
,
1791 const char *regex
, bool tempflag
,
1794 #endif /* !defined (BREAKPOINT_H) */