1 /* Data structures associated with breakpoints in GDB.
2 Copyright (C) 1992-2020 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/function-view.h"
32 #include "cli/cli-script.h"
35 struct gdbpy_breakpoint_object
;
36 struct gdbscm_breakpoint_object
;
37 struct number_or_range_parser
;
41 struct linespec_result
;
45 /* Enum for exception-handling support in 'catch throw', 'catch rethrow',
46 'catch catch' and the MI equivalent. */
48 enum exception_event_kind
55 /* Why are we removing the breakpoint from the target? */
59 /* A regular remove. Remove the breakpoint and forget everything
63 /* Detach the breakpoints from a fork child. */
67 /* This is the maximum number of bytes a breakpoint instruction can
68 take. Feel free to increase it. It's just used in a few places to
69 size arrays that should be independent of the target
72 #define BREAKPOINT_MAX 16
75 /* Type of breakpoint. */
79 bp_none
= 0, /* Eventpoint has been deleted */
80 bp_breakpoint
, /* Normal breakpoint */
81 bp_hardware_breakpoint
, /* Hardware assisted breakpoint */
82 bp_single_step
, /* Software single-step */
83 bp_until
, /* used by until command */
84 bp_finish
, /* used by finish command */
85 bp_watchpoint
, /* Watchpoint */
86 bp_hardware_watchpoint
, /* Hardware assisted watchpoint */
87 bp_read_watchpoint
, /* read watchpoint, (hardware assisted) */
88 bp_access_watchpoint
, /* access watchpoint, (hardware assisted) */
89 bp_longjmp
, /* secret breakpoint to find longjmp() */
90 bp_longjmp_resume
, /* secret breakpoint to escape longjmp() */
92 /* Breakpoint placed to the same location(s) like bp_longjmp but used to
93 protect against stale DUMMY_FRAME. Multiple bp_longjmp_call_dummy and
94 one bp_call_dummy are chained together by related_breakpoint for each
96 bp_longjmp_call_dummy
,
98 /* An internal breakpoint that is installed on the unwinder's
101 /* An internal breakpoint that is set at the point where an
102 exception will land. */
105 /* Used by wait_for_inferior for stepping over subroutine calls,
106 and for skipping prologues. */
109 /* Used by wait_for_inferior for stepping over signal
113 /* Used to detect when a watchpoint expression has gone out of
114 scope. These breakpoints are usually not visible to the user.
116 This breakpoint has some interesting properties:
118 1) There's always a 1:1 mapping between watchpoints
119 on local variables and watchpoint_scope breakpoints.
121 2) It automatically deletes itself and the watchpoint it's
122 associated with when hit.
124 3) It can never be disabled. */
127 /* The breakpoint at the end of a call dummy. See bp_longjmp_call_dummy it
128 is chained with by related_breakpoint. */
131 /* A breakpoint set on std::terminate, that is used to catch
132 otherwise uncaught exceptions thrown during an inferior call. */
135 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
136 code in the inferior to run when significant events occur in the
137 dynamic linker (for example a library is loaded or unloaded).
139 By placing a breakpoint in this magic code GDB will get control
140 when these significant events occur. GDB can then re-examine
141 the dynamic linker's data structures to discover any newly loaded
142 dynamic libraries. */
145 /* Some multi-threaded systems can arrange for a location in the
146 inferior to be executed when certain thread-related events occur
147 (such as thread creation or thread death).
149 By placing a breakpoint at one of these locations, GDB will get
150 control when these events occur. GDB can then update its thread
155 /* On the same principal, an overlay manager can arrange to call a
156 magic location in the inferior whenever there is an interesting
157 change in overlay status. GDB can update its overlay tables
158 and fiddle with breakpoints in overlays when this breakpoint
163 /* Master copies of longjmp breakpoints. These are always installed
164 as soon as an objfile containing longjmp is loaded, but they are
165 always disabled. While necessary, temporary clones of bp_longjmp
166 type will be created and enabled. */
170 /* Master copies of std::terminate breakpoints. */
171 bp_std_terminate_master
,
173 /* Like bp_longjmp_master, but for exceptions. */
180 bp_static_tracepoint
,
182 /* A dynamic printf stops at the given location, does a formatted
183 print, then automatically continues. (Although this is sort of
184 like a macro packaging up standard breakpoint functionality,
185 GDB doesn't have a way to construct types of breakpoint from
186 elements of behavior.) */
189 /* Event for JIT compiled code generation or deletion. */
192 /* Breakpoint is placed at the STT_GNU_IFUNC resolver. When hit GDB
193 inserts new bp_gnu_ifunc_resolver_return at the caller.
194 bp_gnu_ifunc_resolver is still being kept here as a different thread
195 may still hit it before bp_gnu_ifunc_resolver_return is hit by the
197 bp_gnu_ifunc_resolver
,
199 /* On its hit GDB now know the resolved address of the target
200 STT_GNU_IFUNC function. Associated bp_gnu_ifunc_resolver can be
201 deleted now and the breakpoint moved to the target function entry
203 bp_gnu_ifunc_resolver_return
,
206 /* States of enablement of breakpoint. */
210 bp_disabled
, /* The eventpoint is inactive, and cannot
212 bp_enabled
, /* The eventpoint is active, and can
214 bp_call_disabled
, /* The eventpoint has been disabled while a
215 call into the inferior is "in flight",
216 because some eventpoints interfere with
217 the implementation of a call on some
218 targets. The eventpoint will be
219 automatically enabled and reset when the
220 call "lands" (either completes, or stops
221 at another eventpoint). */
225 /* Disposition of breakpoint. Ie: what to do after hitting it. */
229 disp_del
, /* Delete it */
230 disp_del_at_next_stop
, /* Delete at next stop,
231 whether hit or not */
232 disp_disable
, /* Disable it */
233 disp_donttouch
/* Leave it alone */
236 /* Status of breakpoint conditions used when synchronizing
237 conditions with the target. */
239 enum condition_status
241 condition_unchanged
= 0,
246 /* Information used by targets to insert and remove breakpoints. */
248 struct bp_target_info
250 /* Address space at which the breakpoint was placed. */
251 struct address_space
*placed_address_space
;
253 /* Address at which the breakpoint was placed. This is normally
254 the same as REQUESTED_ADDRESS, except when adjustment happens in
255 gdbarch_breakpoint_from_pc. The most common form of adjustment
256 is stripping an alternate ISA marker from the PC which is used
257 to determine the type of breakpoint to insert. */
258 CORE_ADDR placed_address
;
260 /* Address at which the breakpoint was requested. */
261 CORE_ADDR reqstd_address
;
263 /* If this is a ranged breakpoint, then this field contains the
264 length of the range that will be watched for execution. */
267 /* If the breakpoint lives in memory and reading that memory would
268 give back the breakpoint, instead of the original contents, then
269 the original contents are cached here. Only SHADOW_LEN bytes of
270 this buffer are valid, and only when the breakpoint is inserted. */
271 gdb_byte shadow_contents
[BREAKPOINT_MAX
];
273 /* The length of the data cached in SHADOW_CONTENTS. */
276 /* The breakpoint's kind. It is used in 'kind' parameter in Z
280 /* Conditions the target should evaluate if it supports target-side
281 breakpoint conditions. These are non-owning pointers. */
282 std::vector
<agent_expr
*> conditions
;
284 /* Commands the target should evaluate if it supports target-side
285 breakpoint commands. These are non-owning pointers. */
286 std::vector
<agent_expr
*> tcommands
;
288 /* Flag that is true if the breakpoint should be left in place even
289 when GDB is not connected. */
293 /* GDB maintains two types of information about each breakpoint (or
294 watchpoint, or other related event). The first type corresponds
295 to struct breakpoint; this is a relatively high-level structure
296 which contains the source location(s), stopping conditions, user
297 commands to execute when the breakpoint is hit, and so forth.
299 The second type of information corresponds to struct bp_location.
300 Each breakpoint has one or (eventually) more locations associated
301 with it, which represent target-specific and machine-specific
302 mechanisms for stopping the program. For instance, a watchpoint
303 expression may require multiple hardware watchpoints in order to
304 catch all changes in the value of the expression being watched. */
308 bp_loc_software_breakpoint
,
309 bp_loc_hardware_breakpoint
,
310 bp_loc_hardware_watchpoint
,
311 bp_loc_other
/* Miscellaneous... */
317 bp_location () = default;
319 /* Construct a bp_location with the type inferred from OWNER's
321 explicit bp_location (breakpoint
*owner
);
323 /* Construct a bp_location with type TYPE. */
324 bp_location (breakpoint
*owner
, bp_loc_type type
);
326 virtual ~bp_location ();
328 /* Chain pointer to the next breakpoint location for
329 the same parent breakpoint. */
330 bp_location
*next
= NULL
;
332 /* The reference count. */
335 /* Type of this breakpoint location. */
336 bp_loc_type loc_type
{};
338 /* Each breakpoint location must belong to exactly one higher-level
339 breakpoint. This pointer is NULL iff this bp_location is no
340 longer attached to a breakpoint. For example, when a breakpoint
341 is deleted, its locations may still be found in the
342 moribund_locations list, or if we had stopped for it, in
344 breakpoint
*owner
= NULL
;
346 /* Conditional. Break only if this expression's value is nonzero.
347 Unlike string form of condition, which is associated with
348 breakpoint, this is associated with location, since if breakpoint
349 has several locations, the evaluation of expression can be
350 different for different locations. Only valid for real
351 breakpoints; a watchpoint's conditional expression is stored in
352 the owner breakpoint object. */
355 /* Conditional expression in agent expression
356 bytecode form. This is used for stub-side breakpoint
357 condition evaluation. */
358 agent_expr_up cond_bytecode
;
360 /* Signals that the condition has changed since the last time
361 we updated the global location list. This means the condition
362 needs to be sent to the target again. This is used together
363 with target-side breakpoint conditions.
365 condition_unchanged: It means there has been no condition changes.
367 condition_modified: It means this location had its condition modified.
369 condition_updated: It means we already marked all the locations that are
370 duplicates of this location and thus we don't need to call
371 force_breakpoint_reinsertion (...) for this location. */
373 condition_status condition_changed
{};
375 agent_expr_up cmd_bytecode
;
377 /* Signals that breakpoint conditions and/or commands need to be
378 re-synced with the target. This has no use other than
379 target-side breakpoints. */
380 bool needs_update
= false;
382 /* This location's address is in an unloaded solib, and so this
383 location should not be inserted. It will be automatically
384 enabled when that solib is loaded. */
385 bool shlib_disabled
= false;
387 /* Is this particular location enabled. */
388 bool enabled
= false;
390 /* Is this particular location disabled because the condition
391 expression is invalid at this location. For a location to be
392 reported as enabled, the ENABLED field above has to be true *and*
393 the DISABLED_BY_COND field has to be false. */
394 bool disabled_by_cond
= false;
396 /* True if this breakpoint is now inserted. */
397 bool inserted
= false;
399 /* True if this is a permanent breakpoint. There is a breakpoint
400 instruction hard-wired into the target's code. Don't try to
401 write another breakpoint instruction on top of it, or restore its
402 value. Step over it using the architecture's
403 gdbarch_skip_permanent_breakpoint method. */
404 bool permanent
= false;
406 /* True if this is not the first breakpoint in the list
407 for the given address. location of tracepoint can _never_
408 be duplicated with other locations of tracepoints and other
409 kinds of breakpoints, because two locations at the same
410 address may have different actions, so both of these locations
411 should be downloaded and so that `tfind N' always works. */
412 bool duplicate
= false;
414 /* If we someday support real thread-specific breakpoints, then
415 the breakpoint location will need a thread identifier. */
417 /* Data for specific breakpoint types. These could be a union, but
418 simplicity is more important than memory usage for breakpoints. */
420 /* Architecture associated with this location's address. May be
421 different from the breakpoint architecture. */
422 struct gdbarch
*gdbarch
= NULL
;
424 /* The program space associated with this breakpoint location
425 address. Note that an address space may be represented in more
426 than one program space (e.g. each uClinux program will be given
427 its own program space, but there will only be one address space
428 for all of them), but we must not insert more than one location
429 at the same address in the same address space. */
430 program_space
*pspace
= NULL
;
432 /* Note that zero is a perfectly valid code address on some platforms
433 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
434 is not a special value for this field. Valid for all types except
436 CORE_ADDR address
= 0;
438 /* For hardware watchpoints, the size of the memory region being
439 watched. For hardware ranged breakpoints, the size of the
443 /* Type of hardware watchpoint. */
444 target_hw_bp_type watchpoint_type
{};
446 /* For any breakpoint type with an address, this is the section
447 associated with the address. Used primarily for overlay
449 obj_section
*section
= NULL
;
451 /* Address at which breakpoint was requested, either by the user or
452 by GDB for internal breakpoints. This will usually be the same
453 as ``address'' (above) except for cases in which
454 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
455 which to place the breakpoint in order to comply with a
456 processor's architectual constraints. */
457 CORE_ADDR requested_address
= 0;
459 /* An additional address assigned with this location. This is currently
460 only used by STT_GNU_IFUNC resolver breakpoints to hold the address
461 of the resolver function. */
462 CORE_ADDR related_address
= 0;
464 /* If the location comes from a probe point, this is the probe associated
466 bound_probe probe
{};
468 char *function_name
= NULL
;
470 /* Details of the placed breakpoint, when inserted. */
471 bp_target_info target_info
{};
473 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
474 bp_target_info overlay_target_info
{};
476 /* In a non-stop mode, it's possible that we delete a breakpoint,
477 but as we do that, some still running thread hits that breakpoint.
478 For that reason, we need to keep locations belonging to deleted
479 breakpoints for a bit, so that don't report unexpected SIGTRAP.
480 We can't keep such locations forever, so we use a heuristic --
481 after we process certain number of inferior events since
482 breakpoint was deleted, we retire all locations of that breakpoint.
483 This variable keeps a number of events still to go, when
484 it becomes 0 this location is retired. */
485 int events_till_retirement
= 0;
487 /* Line number which was used to place this location.
489 Breakpoint placed into a comment keeps it's user specified line number
490 despite ADDRESS resolves into a different line number. */
494 /* Symtab which was used to place this location. This is used
495 to find the corresponding source file name. */
497 struct symtab
*symtab
= NULL
;
499 /* The symbol found by the location parser, if any. This may be used to
500 ascertain when an event location was set at a different location than
501 the one originally selected by parsing, e.g., inlined symbols. */
502 const struct symbol
*symbol
= NULL
;
504 /* Similarly, the minimal symbol found by the location parser, if
505 any. This may be used to ascertain if the location was
506 originally set on a GNU ifunc symbol. */
507 const minimal_symbol
*msymbol
= NULL
;
509 /* The objfile the symbol or minimal symbol were found in. */
510 const struct objfile
*objfile
= NULL
;
513 /* The possible return values for print_bpstat, print_it_normal,
514 print_it_done, print_it_noop. */
515 enum print_stop_action
517 /* We printed nothing or we need to do some more analysis. */
520 /* We printed something, and we *do* desire that something to be
521 followed by a location. */
524 /* We printed something, and we do *not* desire that something to be
525 followed by a location. */
528 /* We already printed all we needed to print, don't print anything
533 /* This structure is a collection of function pointers that, if available,
534 will be called instead of the performing the default action for this
537 struct breakpoint_ops
539 /* Allocate a location for this breakpoint. */
540 struct bp_location
* (*allocate_location
) (struct breakpoint
*);
542 /* Reevaluate a breakpoint. This is necessary after symbols change
543 (e.g., an executable or DSO was loaded, or the inferior just
545 void (*re_set
) (struct breakpoint
*self
);
547 /* Insert the breakpoint or watchpoint or activate the catchpoint.
548 Return 0 for success, 1 if the breakpoint, watchpoint or
549 catchpoint type is not supported, -1 for failure. */
550 int (*insert_location
) (struct bp_location
*);
552 /* Remove the breakpoint/catchpoint that was previously inserted
553 with the "insert" method above. Return 0 for success, 1 if the
554 breakpoint, watchpoint or catchpoint type is not supported,
556 int (*remove_location
) (struct bp_location
*, enum remove_bp_reason reason
);
558 /* Return true if it the target has stopped due to hitting
559 breakpoint location BL. This function does not check if we
560 should stop, only if BL explains the stop. ASPACE is the address
561 space in which the event occurred, BP_ADDR is the address at
562 which the inferior stopped, and WS is the target_waitstatus
563 describing the event. */
564 int (*breakpoint_hit
) (const struct bp_location
*bl
,
565 const address_space
*aspace
,
567 const struct target_waitstatus
*ws
);
569 /* Check internal conditions of the breakpoint referred to by BS.
570 If we should not stop for this breakpoint, set BS->stop to 0. */
571 void (*check_status
) (struct bpstats
*bs
);
573 /* Tell how many hardware resources (debug registers) are needed
574 for this breakpoint. If this function is not provided, then
575 the breakpoint or watchpoint needs one debug register. */
576 int (*resources_needed
) (const struct bp_location
*);
578 /* Tell whether we can downgrade from a hardware watchpoint to a software
579 one. If not, the user will not be able to enable the watchpoint when
580 there are not enough hardware resources available. */
581 int (*works_in_software_mode
) (const struct breakpoint
*);
583 /* The normal print routine for this breakpoint, called when we
585 enum print_stop_action (*print_it
) (struct bpstats
*bs
);
587 /* Display information about this breakpoint, for "info
589 void (*print_one
) (struct breakpoint
*, struct bp_location
**);
591 /* Display extra information about this breakpoint, below the normal
592 breakpoint description in "info breakpoints".
594 In the example below, the "address range" line was printed
595 by print_one_detail_ranged_breakpoint.
597 (gdb) info breakpoints
598 Num Type Disp Enb Address What
599 2 hw breakpoint keep y in main at test-watch.c:70
600 address range: [0x10000458, 0x100004c7]
603 void (*print_one_detail
) (const struct breakpoint
*, struct ui_out
*);
605 /* Display information about this breakpoint after setting it
606 (roughly speaking; this is called from "mention"). */
607 void (*print_mention
) (struct breakpoint
*);
609 /* Print to FP the CLI command that recreates this breakpoint. */
610 void (*print_recreate
) (struct breakpoint
*, struct ui_file
*fp
);
612 /* Create SALs from location, storing the result in linespec_result.
614 For an explanation about the arguments, see the function
615 `create_sals_from_location_default'.
617 This function is called inside `create_breakpoint'. */
618 void (*create_sals_from_location
) (struct event_location
*location
,
619 struct linespec_result
*canonical
,
620 enum bptype type_wanted
);
622 /* This method will be responsible for creating a breakpoint given its SALs.
623 Usually, it just calls `create_breakpoints_sal' (for ordinary
624 breakpoints). However, there may be some special cases where we might
625 need to do some tweaks, e.g., see
626 `strace_marker_create_breakpoints_sal'.
628 This function is called inside `create_breakpoint'. */
629 void (*create_breakpoints_sal
) (struct gdbarch
*,
630 struct linespec_result
*,
631 gdb::unique_xmalloc_ptr
<char>,
632 gdb::unique_xmalloc_ptr
<char>,
633 enum bptype
, enum bpdisp
, int, int,
634 int, const struct breakpoint_ops
*,
635 int, int, int, unsigned);
637 /* Given the location (second parameter), this method decodes it and
638 returns the SAL locations related to it. For ordinary
639 breakpoints, it calls `decode_line_full'. If SEARCH_PSPACE is
640 not NULL, symbol search is restricted to just that program space.
642 This function is called inside `location_to_sals'. */
643 std::vector
<symtab_and_line
> (*decode_location
)
644 (struct breakpoint
*b
,
645 struct event_location
*location
,
646 struct program_space
*search_pspace
);
648 /* Return true if this breakpoint explains a signal. See
649 bpstat_explains_signal. */
650 int (*explains_signal
) (struct breakpoint
*, enum gdb_signal
);
652 /* Called after evaluating the breakpoint's condition,
653 and only if it evaluated true. */
654 void (*after_condition_true
) (struct bpstats
*bs
);
657 /* Helper for breakpoint_ops->print_recreate implementations. Prints
658 the "thread" or "task" condition of B, and then a newline.
660 Necessary because most breakpoint implementations accept
661 thread/task conditions at the end of the spec line, like "break foo
662 thread 1", which needs outputting before any breakpoint-type
663 specific extra command necessary for B's recreation. */
664 extern void print_recreate_thread (struct breakpoint
*b
, struct ui_file
*fp
);
666 enum watchpoint_triggered
668 /* This watchpoint definitely did not trigger. */
669 watch_triggered_no
= 0,
671 /* Some hardware watchpoint triggered, and it might have been this
672 one, but we do not know which it was. */
673 watch_triggered_unknown
,
675 /* This hardware watchpoint definitely did trigger. */
679 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
680 a watchpoint over a memory region. If this flag is true, GDB will use
681 only one register per watchpoint, thus assuming that all accesses that
682 modify a memory location happen at its starting address. */
684 extern bool target_exact_watchpoints
;
686 /* Note that the ->silent field is not currently used by any commands
687 (though the code is in there if it was to be, and set_raw_breakpoint
688 does set it to 0). I implemented it because I thought it would be
689 useful for a hack I had to put in; I'm going to leave it in because
690 I can see how there might be times when it would indeed be useful */
692 /* This is for all kinds of breakpoints. */
696 virtual ~breakpoint ();
698 /* Methods associated with this breakpoint. */
699 const breakpoint_ops
*ops
= NULL
;
701 breakpoint
*next
= NULL
;
702 /* Type of breakpoint. */
703 bptype type
= bp_none
;
704 /* Zero means disabled; remember the info but don't break here. */
705 enum enable_state enable_state
= bp_enabled
;
706 /* What to do with this breakpoint after we hit it. */
707 bpdisp disposition
= disp_del
;
708 /* Number assigned to distinguish breakpoints. */
711 /* Location(s) associated with this high-level breakpoint. */
712 bp_location
*loc
= NULL
;
714 /* True means a silent breakpoint (don't print frame info if we stop
717 /* True means display ADDR_STRING to the user verbatim. */
718 bool display_canonical
= false;
719 /* Number of stops at this breakpoint that should be continued
720 automatically before really stopping. */
721 int ignore_count
= 0;
723 /* Number of stops at this breakpoint before it will be
725 int enable_count
= 0;
727 /* Chain of command lines to execute when this breakpoint is
729 counted_command_line commands
;
730 /* Stack depth (address of frame). If nonzero, break only if fp
732 struct frame_id frame_id
= null_frame_id
;
734 /* The program space used to set the breakpoint. This is only set
735 for breakpoints which are specific to a program space; for
736 non-thread-specific ordinary breakpoints this is NULL. */
737 program_space
*pspace
= NULL
;
739 /* Location we used to set the breakpoint. */
740 event_location_up location
;
742 /* The filter that should be passed to decode_line_full when
743 re-setting this breakpoint. This may be NULL. */
744 gdb::unique_xmalloc_ptr
<char> filter
;
746 /* For a ranged breakpoint, the location we used to find the end of
748 event_location_up location_range_end
;
750 /* Architecture we used to set the breakpoint. */
751 struct gdbarch
*gdbarch
= NULL
;
752 /* Language we used to set the breakpoint. */
753 enum language language
= language_unknown
;
754 /* Input radix we used to set the breakpoint. */
756 /* String form of the breakpoint condition (malloc'd), or NULL if
757 there is no condition. */
758 char *cond_string
= NULL
;
760 /* String form of extra parameters, or NULL if there are none.
762 char *extra_string
= NULL
;
764 /* Holds the address of the related watchpoint_scope breakpoint when
765 using watchpoints on local variables (might the concept of a
766 related breakpoint be useful elsewhere, if not just call it the
767 watchpoint_scope breakpoint or something like that. FIXME). */
768 breakpoint
*related_breakpoint
= NULL
;
770 /* Thread number for thread-specific breakpoint, or -1 if don't
774 /* Ada task number for task-specific breakpoint, or 0 if don't
778 /* Count of the number of times this breakpoint was taken, dumped
779 with the info, but not used for anything else. Useful for seeing
780 how many times you hit a break prior to the program aborting, so
781 you can back up to just before the abort. */
784 /* Is breakpoint's condition not yet parsed because we found no
785 location initially so had no context to parse the condition
787 int condition_not_parsed
= 0;
789 /* With a Python scripting enabled GDB, store a reference to the
790 Python object that has been associated with this breakpoint.
791 This is always NULL for a GDB that is not script enabled. It can
792 sometimes be NULL for enabled GDBs as not all breakpoint types
793 are tracked by the scripting language API. */
794 gdbpy_breakpoint_object
*py_bp_object
= NULL
;
796 /* Same as py_bp_object, but for Scheme. */
797 gdbscm_breakpoint_object
*scm_bp_object
= NULL
;
800 /* An instance of this type is used to represent a watchpoint. */
802 struct watchpoint
: public breakpoint
804 ~watchpoint () override
;
806 /* String form of exp to use for displaying to the user (malloc'd),
809 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
810 char *exp_string_reparse
;
812 /* The expression we are watching, or NULL if not a watchpoint. */
814 /* The largest block within which it is valid, or NULL if it is
815 valid anywhere (e.g. consists just of global symbols). */
816 const struct block
*exp_valid_block
;
817 /* The conditional expression if any. */
818 expression_up cond_exp
;
819 /* The largest block within which it is valid, or NULL if it is
820 valid anywhere (e.g. consists just of global symbols). */
821 const struct block
*cond_exp_valid_block
;
822 /* Value of the watchpoint the last time we checked it, or NULL when
823 we do not know the value yet or the value was not readable. VAL
827 /* True if VAL is valid. If VAL_VALID is set but VAL is NULL,
828 then an error occurred reading the value. */
831 /* When watching the location of a bitfield, contains the offset and size of
832 the bitfield. Otherwise contains 0. */
836 /* Holds the frame address which identifies the frame this
837 watchpoint should be evaluated in, or `null' if the watchpoint
838 should be evaluated on the outermost frame. */
839 struct frame_id watchpoint_frame
;
841 /* Holds the thread which identifies the frame this watchpoint
842 should be considered in scope for, or `null_ptid' if the
843 watchpoint should be evaluated in all threads. */
844 ptid_t watchpoint_thread
;
846 /* For hardware watchpoints, the triggered status according to the
848 enum watchpoint_triggered watchpoint_triggered
;
850 /* Whether this watchpoint is exact (see
851 target_exact_watchpoints). */
854 /* The mask address for a masked hardware watchpoint. */
855 CORE_ADDR hw_wp_mask
;
858 /* Given a function FUNC (struct breakpoint *B, void *DATA) and
859 USER_DATA, call FUNC for every known breakpoint passing USER_DATA
862 If FUNC returns 1, the loop stops and the current
863 'struct breakpoint' being processed is returned. If FUNC returns
864 zero, the loop continues.
866 This function returns either a 'struct breakpoint' pointer or NULL.
867 It was based on BFD's bfd_sections_find_if function. */
869 extern struct breakpoint
*breakpoint_find_if
870 (int (*func
) (struct breakpoint
*b
, void *d
), void *user_data
);
872 /* Return true if BPT is either a software breakpoint or a hardware
875 extern bool is_breakpoint (const struct breakpoint
*bpt
);
877 /* Return true if BPT is of any watchpoint kind, hardware or
880 extern bool is_watchpoint (const struct breakpoint
*bpt
);
882 /* Return true if BPT is a C++ exception catchpoint (catch
883 catch/throw/rethrow). */
885 extern bool is_exception_catchpoint (breakpoint
*bp
);
887 /* An instance of this type is used to represent all kinds of
890 struct tracepoint
: public breakpoint
892 /* Number of times this tracepoint should single-step and collect
896 /* Number of times this tracepoint should be hit before
900 /* The number of the tracepoint on the target. */
901 int number_on_target
;
903 /* The total space taken by all the trace frames for this
905 ULONGEST traceframe_usage
;
907 /* The static tracepoint marker id, if known. */
908 std::string static_trace_marker_id
;
910 /* LTTng/UST allow more than one marker with the same ID string,
911 although it unadvised because it confuses tools. When setting
912 static tracepoints by marker ID, this will record the index in
913 the array of markers we found for the given marker ID for which
914 this static tracepoint corresponds. When resetting breakpoints,
915 we will use this index to try to find the same marker again. */
916 int static_trace_marker_id_idx
;
920 /* The following stuff is an abstract data type "bpstat" ("breakpoint
921 status"). This provides the ability to determine whether we have
922 stopped at a breakpoint, and what we should do about it. */
924 typedef struct bpstats
*bpstat
;
926 /* Clears a chain of bpstat, freeing storage
928 extern void bpstat_clear (bpstat
*);
930 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
931 is part of the bpstat is copied as well. */
932 extern bpstat
bpstat_copy (bpstat
);
934 /* Build the (raw) bpstat chain for the stop information given by ASPACE,
935 BP_ADDR, and WS. Returns the head of the bpstat chain. */
937 extern bpstat
build_bpstat_chain (const address_space
*aspace
,
939 const struct target_waitstatus
*ws
);
941 /* Get a bpstat associated with having just stopped at address
942 BP_ADDR in thread PTID. STOP_CHAIN may be supplied as a previously
943 computed stop chain or NULL, in which case the stop chain will be
944 computed using build_bpstat_chain.
946 Determine whether we stopped at a breakpoint, etc, or whether we
947 don't understand this stop. Result is a chain of bpstat's such
950 if we don't understand the stop, the result is a null pointer.
952 if we understand why we stopped, the result is not null.
954 Each element of the chain refers to a particular breakpoint or
955 watchpoint at which we have stopped. (We may have stopped for
956 several reasons concurrently.)
958 Each element of the chain has valid next, breakpoint_at,
959 commands, FIXME??? fields. */
961 extern bpstat
bpstat_stop_status (const address_space
*aspace
,
962 CORE_ADDR pc
, thread_info
*thread
,
963 const struct target_waitstatus
*ws
,
964 bpstat stop_chain
= NULL
);
966 /* This bpstat_what stuff tells wait_for_inferior what to do with a
967 breakpoint (a challenging task).
969 The enum values order defines priority-like order of the actions.
970 Once you've decided that some action is appropriate, you'll never
971 go back and decide something of a lower priority is better. Each
972 of these actions is mutually exclusive with the others. That
973 means, that if you find yourself adding a new action class here and
974 wanting to tell GDB that you have two simultaneous actions to
975 handle, something is wrong, and you probably don't actually need a
978 Note that a step resume breakpoint overrides another breakpoint of
979 signal handling (see comment in wait_for_inferior at where we set
980 the step_resume breakpoint). */
982 enum bpstat_what_main_action
984 /* Perform various other tests; that is, this bpstat does not
985 say to perform any action (e.g. failed watchpoint and nothing
987 BPSTAT_WHAT_KEEP_CHECKING
,
989 /* Remove breakpoints, single step once, then put them back in and
990 go back to what we were doing. It's possible that this should
991 be removed from the main_action and put into a separate field,
992 to more cleanly handle
993 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
996 /* Set longjmp_resume breakpoint, remove all other breakpoints,
997 and continue. The "remove all other breakpoints" part is
998 required if we are also stepping over another breakpoint as
999 well as doing the longjmp handling. */
1000 BPSTAT_WHAT_SET_LONGJMP_RESUME
,
1002 /* Clear longjmp_resume breakpoint, then handle as
1003 BPSTAT_WHAT_KEEP_CHECKING. */
1004 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME
,
1006 /* Clear step resume breakpoint, and keep checking. */
1007 BPSTAT_WHAT_STEP_RESUME
,
1009 /* Rather than distinguish between noisy and silent stops here, it
1010 might be cleaner to have bpstat_print make that decision (also
1011 taking into account stop_print_frame and source_only). But the
1012 implications are a bit scary (interaction with auto-displays,
1013 etc.), so I won't try it. */
1015 /* Stop silently. */
1016 BPSTAT_WHAT_STOP_SILENT
,
1018 /* Stop and print. */
1019 BPSTAT_WHAT_STOP_NOISY
,
1021 /* Clear step resume breakpoint, and keep checking. High-priority
1022 step-resume breakpoints are used when even if there's a user
1023 breakpoint at the current PC when we set the step-resume
1024 breakpoint, we don't want to re-handle any breakpoint other
1025 than the step-resume when it's hit; instead we want to move
1026 past the breakpoint. This is used in the case of skipping
1028 BPSTAT_WHAT_HP_STEP_RESUME
,
1031 /* An enum indicating the kind of "stack dummy" stop. This is a bit
1032 of a misnomer because only one kind of truly a stack dummy. */
1033 enum stop_stack_kind
1035 /* We didn't stop at a stack dummy breakpoint. */
1038 /* Stopped at a stack dummy. */
1041 /* Stopped at std::terminate. */
1047 enum bpstat_what_main_action main_action
;
1049 /* Did we hit a call dummy breakpoint? This only goes with a
1050 main_action of BPSTAT_WHAT_STOP_SILENT or
1051 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
1052 dummy without popping the frame is not a useful one). */
1053 enum stop_stack_kind call_dummy
;
1055 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
1056 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
1057 longjmp, false if we are handling an exception. */
1061 /* Tell what to do about this bpstat. */
1062 struct bpstat_what
bpstat_what (bpstat
);
1064 /* Run breakpoint event callbacks associated with the breakpoints that
1066 extern void bpstat_run_callbacks (bpstat bs_head
);
1068 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
1069 bpstat
bpstat_find_breakpoint (bpstat
, struct breakpoint
*);
1071 /* True if a signal that we got in target_wait() was due to
1072 circumstances explained by the bpstat; the signal is therefore not
1074 extern bool bpstat_explains_signal (bpstat
, enum gdb_signal
);
1076 /* True if this bpstat causes a stop. */
1077 extern bool bpstat_causes_stop (bpstat
);
1079 /* True if we should step constantly (e.g. watchpoints on machines
1080 without hardware support). This isn't related to a specific bpstat,
1081 just to things like whether watchpoints are set. */
1082 extern bool bpstat_should_step ();
1084 /* Print a message indicating what happened. Returns nonzero to
1085 say that only the source line should be printed after this (zero
1086 return means print the frame as well as the source line). */
1087 extern enum print_stop_action
bpstat_print (bpstat
, int);
1089 /* Put in *NUM the breakpoint number of the first breakpoint we are
1090 stopped at. *BSP upon return is a bpstat which points to the
1091 remaining breakpoints stopped at (but which is not guaranteed to be
1092 good for anything but further calls to bpstat_num).
1094 Return 0 if passed a bpstat which does not indicate any breakpoints.
1095 Return -1 if stopped at a breakpoint that has been deleted since
1097 Return 1 otherwise. */
1098 extern int bpstat_num (bpstat
*, int *);
1100 /* Perform actions associated with the stopped inferior. Actually, we
1101 just use this for breakpoint commands. Perhaps other actions will
1102 go here later, but this is executed at a late time (from the
1104 extern void bpstat_do_actions (void);
1106 /* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will
1107 not be performed. */
1108 extern void bpstat_clear_actions (void);
1110 /* Implementation: */
1112 /* Values used to tell the printing routine how to behave for this
1116 /* This is used when we want to do a normal printing of the reason
1117 for stopping. The output will depend on the type of eventpoint
1118 we are dealing with. This is the default value, most commonly
1121 /* This is used when nothing should be printed for this bpstat
1124 /* This is used when everything which needs to be printed has
1125 already been printed. But we still want to print the frame. */
1132 bpstats (struct bp_location
*bl
, bpstat
**bs_link_pointer
);
1135 bpstats (const bpstats
&);
1136 bpstats
&operator= (const bpstats
&) = delete;
1138 /* Linked list because there can be more than one breakpoint at
1139 the same place, and a bpstat reflects the fact that all have
1143 /* Location that caused the stop. Locations are refcounted, so
1144 this will never be NULL. Note that this location may end up
1145 detached from a breakpoint, but that does not necessary mean
1146 that the struct breakpoint is gone. E.g., consider a
1147 watchpoint with a condition that involves an inferior function
1148 call. Watchpoint locations are recreated often (on resumes,
1149 hence on infcalls too). Between creating the bpstat and after
1150 evaluating the watchpoint condition, this location may hence
1151 end up detached from its original owner watchpoint, even though
1152 the watchpoint is still listed. If it's condition evaluates as
1153 true, we still want this location to cause a stop, and we will
1154 still need to know which watchpoint it was originally attached.
1155 What this means is that we should not (in most cases) follow
1156 the `bpstat->bp_location->owner' link, but instead use the
1157 `breakpoint_at' field below. */
1158 struct bp_location
*bp_location_at
;
1160 /* Breakpoint that caused the stop. This is nullified if the
1161 breakpoint ends up being deleted. See comments on
1162 `bp_location_at' above for why do we need this field instead of
1163 following the location's owner. */
1164 struct breakpoint
*breakpoint_at
;
1166 /* The associated command list. */
1167 counted_command_line commands
;
1169 /* Old value associated with a watchpoint. */
1170 value_ref_ptr old_val
;
1172 /* Nonzero if this breakpoint tells us to print the frame. */
1175 /* Nonzero if this breakpoint tells us to stop. */
1178 /* Tell bpstat_print and print_bp_stop_message how to print stuff
1179 associated with this element of the bpstat chain. */
1180 enum bp_print_how print_it
;
1191 /* The possible return values for breakpoint_here_p.
1192 We guarantee that zero always means "no breakpoint here". */
1193 enum breakpoint_here
1195 no_breakpoint_here
= 0,
1196 ordinary_breakpoint_here
,
1197 permanent_breakpoint_here
1201 /* Prototypes for breakpoint-related functions. */
1203 extern enum breakpoint_here
breakpoint_here_p (const address_space
*,
1206 /* Return true if an enabled breakpoint exists in the range defined by
1207 ADDR and LEN, in ASPACE. */
1208 extern int breakpoint_in_range_p (const address_space
*aspace
,
1209 CORE_ADDR addr
, ULONGEST len
);
1211 extern int moribund_breakpoint_here_p (const address_space
*, CORE_ADDR
);
1213 extern int breakpoint_inserted_here_p (const address_space
*,
1216 extern int software_breakpoint_inserted_here_p (const address_space
*,
1219 /* Return non-zero iff there is a hardware breakpoint inserted at
1221 extern int hardware_breakpoint_inserted_here_p (const address_space
*,
1224 /* Check whether any location of BP is inserted at PC. */
1226 extern int breakpoint_has_location_inserted_here (struct breakpoint
*bp
,
1227 const address_space
*aspace
,
1230 extern int single_step_breakpoint_inserted_here_p (const address_space
*,
1233 /* Returns true if there's a hardware watchpoint or access watchpoint
1234 inserted in the range defined by ADDR and LEN. */
1235 extern int hardware_watchpoint_inserted_in_range (const address_space
*,
1239 /* Returns true if {ASPACE1,ADDR1} and {ASPACE2,ADDR2} represent the
1240 same breakpoint location. In most targets, this can only be true
1241 if ASPACE1 matches ASPACE2. On targets that have global
1242 breakpoints, the address space doesn't really matter. */
1244 extern int breakpoint_address_match (const address_space
*aspace1
,
1246 const address_space
*aspace2
,
1249 extern void until_break_command (const char *, int, int);
1251 /* Initialize a struct bp_location. */
1253 extern void update_breakpoint_locations
1254 (struct breakpoint
*b
,
1255 struct program_space
*filter_pspace
,
1256 gdb::array_view
<const symtab_and_line
> sals
,
1257 gdb::array_view
<const symtab_and_line
> sals_end
);
1259 extern void breakpoint_re_set (void);
1261 extern void breakpoint_re_set_thread (struct breakpoint
*);
1263 extern void delete_breakpoint (struct breakpoint
*);
1265 struct breakpoint_deleter
1267 void operator() (struct breakpoint
*b
) const
1269 delete_breakpoint (b
);
1273 typedef std::unique_ptr
<struct breakpoint
, breakpoint_deleter
> breakpoint_up
;
1275 extern breakpoint_up set_momentary_breakpoint
1276 (struct gdbarch
*, struct symtab_and_line
, struct frame_id
, enum bptype
);
1278 extern breakpoint_up set_momentary_breakpoint_at_pc
1279 (struct gdbarch
*, CORE_ADDR pc
, enum bptype type
);
1281 extern struct breakpoint
*clone_momentary_breakpoint (struct breakpoint
*bpkt
);
1283 extern void set_ignore_count (int, int, int);
1285 extern void breakpoint_init_inferior (enum inf_context
);
1287 extern void breakpoint_auto_delete (bpstat
);
1289 typedef void (*walk_bp_location_callback
) (struct bp_location
*, void *);
1291 extern void iterate_over_bp_locations (walk_bp_location_callback
);
1293 /* Return the chain of command lines to execute when this breakpoint
1295 extern struct command_line
*breakpoint_commands (struct breakpoint
*b
);
1297 /* Return a string image of DISP. The string is static, and thus should
1298 NOT be deallocated after use. */
1299 const char *bpdisp_text (enum bpdisp disp
);
1301 extern void break_command (const char *, int);
1303 extern void watch_command_wrapper (const char *, int, int);
1304 extern void awatch_command_wrapper (const char *, int, int);
1305 extern void rwatch_command_wrapper (const char *, int, int);
1306 extern void tbreak_command (const char *, int);
1308 extern struct breakpoint_ops base_breakpoint_ops
;
1309 extern struct breakpoint_ops bkpt_breakpoint_ops
;
1310 extern struct breakpoint_ops tracepoint_breakpoint_ops
;
1311 extern struct breakpoint_ops dprintf_breakpoint_ops
;
1313 extern void initialize_breakpoint_ops (void);
1315 /* Arguments to pass as context to some catch command handlers. */
1316 #define CATCH_PERMANENT ((void *) (uintptr_t) 0)
1317 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
1319 /* Like add_cmd, but add the command to both the "catch" and "tcatch"
1320 lists, and pass some additional user data to the command
1324 add_catch_command (const char *name
, const char *docstring
,
1325 cmd_const_sfunc_ftype
*sfunc
,
1326 completer_ftype
*completer
,
1327 void *user_data_catch
,
1328 void *user_data_tcatch
);
1330 /* Initialize a breakpoint struct for Ada exception catchpoints. */
1333 init_ada_exception_breakpoint (struct breakpoint
*b
,
1334 struct gdbarch
*gdbarch
,
1335 struct symtab_and_line sal
,
1336 const char *addr_string
,
1337 const struct breakpoint_ops
*ops
,
1342 /* Initialize a new breakpoint of the bp_catchpoint kind. If TEMP
1343 is true, then make the breakpoint temporary. If COND_STRING is
1344 not NULL, then store it in the breakpoint. OPS, if not NULL, is
1345 the breakpoint_ops structure associated to the catchpoint. */
1347 extern void init_catchpoint (struct breakpoint
*b
,
1348 struct gdbarch
*gdbarch
, bool temp
,
1349 const char *cond_string
,
1350 const struct breakpoint_ops
*ops
);
1352 /* Add breakpoint B on the breakpoint list, and notify the user, the
1353 target and breakpoint_created observers of its existence. If
1354 INTERNAL is non-zero, the breakpoint number will be allocated from
1355 the internal breakpoint count. If UPDATE_GLL is non-zero,
1356 update_global_location_list will be called. */
1358 extern void install_breakpoint (int internal
, std::unique_ptr
<breakpoint
> &&b
,
1361 /* Returns the breakpoint ops appropriate for use with with LOCATION and
1362 according to IS_TRACEPOINT. Use this to ensure, for example, that you pass
1363 the correct ops to create_breakpoint for probe locations. If LOCATION is
1364 NULL, returns bkpt_breakpoint_ops (or tracepoint_breakpoint_ops, if
1365 IS_TRACEPOINT is true). */
1367 extern const struct breakpoint_ops
*breakpoint_ops_for_event_location
1368 (const struct event_location
*location
, bool is_tracepoint
);
1370 /* Flags that can be passed down to create_breakpoint, etc., to affect
1371 breakpoint creation in several ways. */
1373 enum breakpoint_create_flags
1375 /* We're adding a breakpoint to our tables that is already
1376 inserted in the target. */
1377 CREATE_BREAKPOINT_FLAGS_INSERTED
= 1 << 0
1380 /* Set a breakpoint. This function is shared between CLI and MI functions
1381 for setting a breakpoint at LOCATION.
1383 This function has two major modes of operations, selected by the
1384 PARSE_EXTRA parameter.
1386 If PARSE_EXTRA is zero, LOCATION is just the breakpoint's location,
1387 with condition, thread, and extra string specified by the COND_STRING,
1388 THREAD, and EXTRA_STRING parameters.
1390 If PARSE_EXTRA is non-zero, this function will attempt to extract
1391 the condition, thread, and extra string from EXTRA_STRING, ignoring
1392 the similarly named parameters.
1394 If INTERNAL is non-zero, the breakpoint number will be allocated
1395 from the internal breakpoint count.
1397 Returns true if any breakpoint was created; false otherwise. */
1399 extern int create_breakpoint (struct gdbarch
*gdbarch
,
1400 struct event_location
*location
,
1401 const char *cond_string
, int thread
,
1402 const char *extra_string
,
1404 int tempflag
, enum bptype wanted_type
,
1406 enum auto_boolean pending_break_support
,
1407 const struct breakpoint_ops
*ops
,
1410 int internal
, unsigned flags
);
1412 extern void insert_breakpoints (void);
1414 extern int remove_breakpoints (void);
1416 /* Remove breakpoints of inferior INF. */
1418 extern void remove_breakpoints_inf (inferior
*inf
);
1420 /* This function can be used to update the breakpoint package's state
1421 after an exec() system call has been executed.
1423 This function causes the following:
1425 - All eventpoints are marked "not inserted".
1426 - All eventpoints with a symbolic address are reset such that
1427 the symbolic address must be reevaluated before the eventpoints
1429 - The solib breakpoints are explicitly removed from the breakpoint
1431 - A step-resume breakpoint, if any, is explicitly removed from the
1433 - All eventpoints without a symbolic address are removed from the
1435 extern void update_breakpoints_after_exec (void);
1437 /* This function can be used to physically remove hardware breakpoints
1438 and watchpoints from the specified traced inferior process, without
1439 modifying the breakpoint package's state. This can be useful for
1440 those targets which support following the processes of a fork() or
1441 vfork() system call, when one of the resulting two processes is to
1442 be detached and allowed to run free.
1444 It is an error to use this function on the process whose id is
1446 extern int detach_breakpoints (ptid_t ptid
);
1448 /* This function is called when program space PSPACE is about to be
1449 deleted. It takes care of updating breakpoints to not reference
1450 this PSPACE anymore. */
1451 extern void breakpoint_program_space_exit (struct program_space
*pspace
);
1453 extern void set_longjmp_breakpoint (struct thread_info
*tp
,
1454 struct frame_id frame
);
1455 extern void delete_longjmp_breakpoint (int thread
);
1457 /* Mark all longjmp breakpoints from THREAD for later deletion. */
1458 extern void delete_longjmp_breakpoint_at_next_stop (int thread
);
1460 extern struct breakpoint
*set_longjmp_breakpoint_for_call_dummy (void);
1461 extern void check_longjmp_breakpoint_for_call_dummy (struct thread_info
*tp
);
1463 extern void enable_overlay_breakpoints (void);
1464 extern void disable_overlay_breakpoints (void);
1466 extern void set_std_terminate_breakpoint (void);
1467 extern void delete_std_terminate_breakpoint (void);
1469 /* These functions respectively disable or reenable all currently
1470 enabled watchpoints. When disabled, the watchpoints are marked
1471 call_disabled. When re-enabled, they are marked enabled.
1473 The intended client of these functions is call_function_by_hand.
1475 The inferior must be stopped, and all breakpoints removed, when
1476 these functions are used.
1478 The need for these functions is that on some targets (e.g., HP-UX),
1479 gdb is unable to unwind through the dummy frame that is pushed as
1480 part of the implementation of a call command. Watchpoints can
1481 cause the inferior to stop in places where this frame is visible,
1482 and that can cause execution control to become very confused.
1484 Note that if a user sets breakpoints in an interactively called
1485 function, the call_disabled watchpoints will have been re-enabled
1486 when the first such breakpoint is reached. However, on targets
1487 that are unable to unwind through the call dummy frame, watches
1488 of stack-based storage may then be deleted, because gdb will
1489 believe that their watched storage is out of scope. (Sigh.) */
1490 extern void disable_watchpoints_before_interactive_call_start (void);
1492 extern void enable_watchpoints_after_interactive_call_stop (void);
1494 /* These functions disable and re-enable all breakpoints during
1495 inferior startup. They are intended to be called from solib
1496 code where necessary. This is needed on platforms where the
1497 main executable is relocated at some point during startup
1498 processing, making breakpoint addresses invalid.
1500 If additional breakpoints are created after the routine
1501 disable_breakpoints_before_startup but before the routine
1502 enable_breakpoints_after_startup was called, they will also
1503 be marked as disabled. */
1504 extern void disable_breakpoints_before_startup (void);
1505 extern void enable_breakpoints_after_startup (void);
1507 /* For script interpreters that need to define breakpoint commands
1508 after they've already read the commands into a struct
1510 extern enum command_control_type commands_from_control_command
1511 (const char *arg
, struct command_line
*cmd
);
1513 extern void clear_breakpoint_hit_counts (void);
1515 extern struct breakpoint
*get_breakpoint (int num
);
1517 /* The following are for displays, which aren't really breakpoints,
1518 but here is as good a place as any for them. */
1520 extern void disable_current_display (void);
1522 extern void do_displays (void);
1524 extern void disable_display (int);
1526 extern void clear_displays (void);
1528 extern void disable_breakpoint (struct breakpoint
*);
1530 extern void enable_breakpoint (struct breakpoint
*);
1532 extern void breakpoint_set_commands (struct breakpoint
*b
,
1533 counted_command_line
&&commands
);
1535 extern void breakpoint_set_silent (struct breakpoint
*b
, int silent
);
1537 extern void breakpoint_set_thread (struct breakpoint
*b
, int thread
);
1539 extern void breakpoint_set_task (struct breakpoint
*b
, int task
);
1541 /* Clear the "inserted" flag in all breakpoints. */
1542 extern void mark_breakpoints_out (void);
1544 extern struct breakpoint
*create_jit_event_breakpoint (struct gdbarch
*,
1547 extern struct breakpoint
*create_solib_event_breakpoint (struct gdbarch
*,
1550 /* Create an solib event breakpoint at ADDRESS in the current program
1551 space, and immediately try to insert it. Returns a pointer to the
1552 breakpoint on success. Deletes the new breakpoint and returns NULL
1553 if inserting the breakpoint fails. */
1554 extern struct breakpoint
*create_and_insert_solib_event_breakpoint
1555 (struct gdbarch
*gdbarch
, CORE_ADDR address
);
1557 extern struct breakpoint
*create_thread_event_breakpoint (struct gdbarch
*,
1560 extern void remove_jit_event_breakpoints (void);
1562 extern void remove_solib_event_breakpoints (void);
1564 /* Mark solib event breakpoints of the current program space with
1565 delete at next stop disposition. */
1566 extern void remove_solib_event_breakpoints_at_next_stop (void);
1568 extern void disable_breakpoints_in_shlibs (void);
1570 /* This function returns true if B is a catchpoint. */
1572 extern bool is_catchpoint (struct breakpoint
*b
);
1574 /* Shared helper function (MI and CLI) for creating and installing
1575 a shared object event catchpoint. If IS_LOAD is true then
1576 the events to be caught are load events, otherwise they are
1577 unload events. If IS_TEMP is true the catchpoint is a
1578 temporary one. If ENABLED is true the catchpoint is
1579 created in an enabled state. */
1581 extern void add_solib_catchpoint (const char *arg
, bool is_load
, bool is_temp
,
1584 /* Create and insert a new software single step breakpoint for the
1585 current thread. May be called multiple times; each time will add a
1586 new location to the set of potential addresses the next instruction
1588 extern void insert_single_step_breakpoint (struct gdbarch
*,
1589 const address_space
*,
1592 /* Insert all software single step breakpoints for the current frame.
1593 Return true if any software single step breakpoints are inserted,
1594 otherwise, return false. */
1595 extern int insert_single_step_breakpoints (struct gdbarch
*);
1597 /* Check if any hardware watchpoints have triggered, according to the
1599 int watchpoints_triggered (struct target_waitstatus
*);
1601 /* Helper for transparent breakpoint hiding for memory read and write
1604 Update one of READBUF or WRITEBUF with either the shadows
1605 (READBUF), or the breakpoint instructions (WRITEBUF) of inserted
1606 breakpoints at the memory range defined by MEMADDR and extending
1607 for LEN bytes. If writing, then WRITEBUF is a copy of WRITEBUF_ORG
1609 extern void breakpoint_xfer_memory (gdb_byte
*readbuf
, gdb_byte
*writebuf
,
1610 const gdb_byte
*writebuf_org
,
1611 ULONGEST memaddr
, LONGEST len
);
1613 /* Return true if breakpoints should be inserted now. That'll be the
1616 - the target has global breakpoints.
1618 - "breakpoint always-inserted" is on, and the target has
1621 - threads are executing.
1623 extern int breakpoints_should_be_inserted_now (void);
1625 /* Called each time new event from target is processed.
1626 Retires previously deleted breakpoint locations that
1627 in our opinion won't ever trigger. */
1628 extern void breakpoint_retire_moribund (void);
1630 /* Set break condition of breakpoint B to EXP. */
1631 extern void set_breakpoint_condition (struct breakpoint
*b
, const char *exp
,
1634 /* Checks if we are catching syscalls or not.
1635 Returns 0 if not, greater than 0 if we are. */
1636 extern int catch_syscall_enabled (void);
1638 /* Checks if we are catching syscalls with the specific
1639 syscall_number. Used for "filtering" the catchpoints.
1640 Returns 0 if not, greater than 0 if we are. */
1641 extern int catching_syscall_number (int syscall_number
);
1643 /* Return a tracepoint with the given number if found. */
1644 extern struct tracepoint
*get_tracepoint (int num
);
1646 extern struct tracepoint
*get_tracepoint_by_number_on_target (int num
);
1648 /* Find a tracepoint by parsing a number in the supplied string. */
1649 extern struct tracepoint
*
1650 get_tracepoint_by_number (const char **arg
,
1651 number_or_range_parser
*parser
);
1653 /* Return a vector of all tracepoints currently defined. */
1654 extern std::vector
<breakpoint
*> all_tracepoints (void);
1656 /* Return true if B is of tracepoint kind. */
1658 extern bool is_tracepoint (const struct breakpoint
*b
);
1660 /* Return a vector of all static tracepoints defined at ADDR. */
1661 extern std::vector
<breakpoint
*> static_tracepoints_here (CORE_ADDR addr
);
1663 /* Create an instance of this to start registering breakpoint numbers
1664 for a later "commands" command. */
1666 class scoped_rbreak_breakpoints
1670 scoped_rbreak_breakpoints ();
1671 ~scoped_rbreak_breakpoints ();
1673 DISABLE_COPY_AND_ASSIGN (scoped_rbreak_breakpoints
);
1676 /* Breakpoint iterator function.
1678 Calls a callback function once for each breakpoint, so long as the
1679 callback function returns false. If the callback function returns
1680 true, the iteration will end and the current breakpoint will be
1681 returned. This can be useful for implementing a search for a
1682 breakpoint with arbitrary attributes, or for applying an operation
1683 to every breakpoint. */
1684 extern struct breakpoint
*iterate_over_breakpoints
1685 (gdb::function_view
<bool (breakpoint
*)>);
1687 /* Nonzero if the specified PC cannot be a location where functions
1688 have been inlined. */
1690 extern int pc_at_non_inline_function (const address_space
*aspace
,
1692 const struct target_waitstatus
*ws
);
1694 extern int user_breakpoint_p (struct breakpoint
*);
1696 /* Return true if this breakpoint is pending, false if not. */
1697 extern int pending_breakpoint_p (struct breakpoint
*);
1699 /* Attempt to determine architecture of location identified by SAL. */
1700 extern struct gdbarch
*get_sal_arch (struct symtab_and_line sal
);
1702 extern void breakpoint_free_objfile (struct objfile
*objfile
);
1704 extern const char *ep_parse_optional_if_clause (const char **arg
);
1706 /* Print the "Thread ID hit" part of "Thread ID hit Breakpoint N" to
1707 UIOUT iff debugging multiple threads. */
1708 extern void maybe_print_thread_hit_breakpoint (struct ui_out
*uiout
);
1710 /* Print the specified breakpoint. */
1711 extern void print_breakpoint (breakpoint
*bp
);
1713 /* Command element for the 'commands' command. */
1714 extern cmd_list_element
*commands_cmd_element
;
1716 /* Whether to use the fixed output when printing information about a
1717 multi-location breakpoint (see PR 9659). */
1719 extern bool fix_multi_location_breakpoint_output_globally
;
1721 /* Deal with "catch catch", "catch throw", and "catch rethrow" commands and
1722 the MI equivalents. Sets up to catch events of type EX_EVENT. When
1723 TEMPFLAG is true only the next matching event is caught after which the
1724 catch-point is deleted. If REGEX is not NULL then only exceptions whose
1725 type name matches REGEX will trigger the event. */
1727 extern void catch_exception_event (enum exception_event_kind ex_event
,
1728 const char *regex
, bool tempflag
,
1731 #endif /* !defined (BREAKPOINT_H) */