1 /* Data structures associated with breakpoints in GDB.
2 Copyright (C) 1992-2019 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19 #if !defined (BREAKPOINT_H)
20 #define BREAKPOINT_H 1
24 #include "gdbsupport/vec.h"
27 #include "gdbsupport/break-common.h"
31 #include "gdbsupport/array-view.h"
32 #include "gdbsupport/function-view.h"
33 #include "cli/cli-script.h"
36 struct gdbpy_breakpoint_object
;
37 struct gdbscm_breakpoint_object
;
38 struct number_or_range_parser
;
42 struct linespec_result
;
46 /* Enum for exception-handling support in 'catch throw', 'catch rethrow',
47 'catch catch' and the MI equivalent. */
49 enum exception_event_kind
56 /* Why are we removing the breakpoint from the target? */
60 /* A regular remove. Remove the breakpoint and forget everything
64 /* Detach the breakpoints from a fork child. */
68 /* This is the maximum number of bytes a breakpoint instruction can
69 take. Feel free to increase it. It's just used in a few places to
70 size arrays that should be independent of the target
73 #define BREAKPOINT_MAX 16
76 /* Type of breakpoint. */
80 bp_none
= 0, /* Eventpoint has been deleted */
81 bp_breakpoint
, /* Normal breakpoint */
82 bp_hardware_breakpoint
, /* Hardware assisted breakpoint */
83 bp_single_step
, /* Software single-step */
84 bp_until
, /* used by until command */
85 bp_finish
, /* used by finish command */
86 bp_watchpoint
, /* Watchpoint */
87 bp_hardware_watchpoint
, /* Hardware assisted watchpoint */
88 bp_read_watchpoint
, /* read watchpoint, (hardware assisted) */
89 bp_access_watchpoint
, /* access watchpoint, (hardware assisted) */
90 bp_longjmp
, /* secret breakpoint to find longjmp() */
91 bp_longjmp_resume
, /* secret breakpoint to escape longjmp() */
93 /* Breakpoint placed to the same location(s) like bp_longjmp but used to
94 protect against stale DUMMY_FRAME. Multiple bp_longjmp_call_dummy and
95 one bp_call_dummy are chained together by related_breakpoint for each
97 bp_longjmp_call_dummy
,
99 /* An internal breakpoint that is installed on the unwinder's
102 /* An internal breakpoint that is set at the point where an
103 exception will land. */
106 /* Used by wait_for_inferior for stepping over subroutine calls,
107 and for skipping prologues. */
110 /* Used by wait_for_inferior for stepping over signal
114 /* Used to detect when a watchpoint expression has gone out of
115 scope. These breakpoints are usually not visible to the user.
117 This breakpoint has some interesting properties:
119 1) There's always a 1:1 mapping between watchpoints
120 on local variables and watchpoint_scope breakpoints.
122 2) It automatically deletes itself and the watchpoint it's
123 associated with when hit.
125 3) It can never be disabled. */
128 /* The breakpoint at the end of a call dummy. See bp_longjmp_call_dummy it
129 is chained with by related_breakpoint. */
132 /* A breakpoint set on std::terminate, that is used to catch
133 otherwise uncaught exceptions thrown during an inferior call. */
136 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
137 code in the inferior to run when significant events occur in the
138 dynamic linker (for example a library is loaded or unloaded).
140 By placing a breakpoint in this magic code GDB will get control
141 when these significant events occur. GDB can then re-examine
142 the dynamic linker's data structures to discover any newly loaded
143 dynamic libraries. */
146 /* Some multi-threaded systems can arrange for a location in the
147 inferior to be executed when certain thread-related events occur
148 (such as thread creation or thread death).
150 By placing a breakpoint at one of these locations, GDB will get
151 control when these events occur. GDB can then update its thread
156 /* On the same principal, an overlay manager can arrange to call a
157 magic location in the inferior whenever there is an interesting
158 change in overlay status. GDB can update its overlay tables
159 and fiddle with breakpoints in overlays when this breakpoint
164 /* Master copies of longjmp breakpoints. These are always installed
165 as soon as an objfile containing longjmp is loaded, but they are
166 always disabled. While necessary, temporary clones of bp_longjmp
167 type will be created and enabled. */
171 /* Master copies of std::terminate breakpoints. */
172 bp_std_terminate_master
,
174 /* Like bp_longjmp_master, but for exceptions. */
181 bp_static_tracepoint
,
183 /* A dynamic printf stops at the given location, does a formatted
184 print, then automatically continues. (Although this is sort of
185 like a macro packaging up standard breakpoint functionality,
186 GDB doesn't have a way to construct types of breakpoint from
187 elements of behavior.) */
190 /* Event for JIT compiled code generation or deletion. */
193 /* Breakpoint is placed at the STT_GNU_IFUNC resolver. When hit GDB
194 inserts new bp_gnu_ifunc_resolver_return at the caller.
195 bp_gnu_ifunc_resolver is still being kept here as a different thread
196 may still hit it before bp_gnu_ifunc_resolver_return is hit by the
198 bp_gnu_ifunc_resolver
,
200 /* On its hit GDB now know the resolved address of the target
201 STT_GNU_IFUNC function. Associated bp_gnu_ifunc_resolver can be
202 deleted now and the breakpoint moved to the target function entry
204 bp_gnu_ifunc_resolver_return
,
207 /* States of enablement of breakpoint. */
211 bp_disabled
, /* The eventpoint is inactive, and cannot
213 bp_enabled
, /* The eventpoint is active, and can
215 bp_call_disabled
, /* The eventpoint has been disabled while a
216 call into the inferior is "in flight",
217 because some eventpoints interfere with
218 the implementation of a call on some
219 targets. The eventpoint will be
220 automatically enabled and reset when the
221 call "lands" (either completes, or stops
222 at another eventpoint). */
226 /* Disposition of breakpoint. Ie: what to do after hitting it. */
230 disp_del
, /* Delete it */
231 disp_del_at_next_stop
, /* Delete at next stop,
232 whether hit or not */
233 disp_disable
, /* Disable it */
234 disp_donttouch
/* Leave it alone */
237 /* Status of breakpoint conditions used when synchronizing
238 conditions with the target. */
240 enum condition_status
242 condition_unchanged
= 0,
247 /* Information used by targets to insert and remove breakpoints. */
249 struct bp_target_info
251 /* Address space at which the breakpoint was placed. */
252 struct address_space
*placed_address_space
;
254 /* Address at which the breakpoint was placed. This is normally
255 the same as REQUESTED_ADDRESS, except when adjustment happens in
256 gdbarch_breakpoint_from_pc. The most common form of adjustment
257 is stripping an alternate ISA marker from the PC which is used
258 to determine the type of breakpoint to insert. */
259 CORE_ADDR placed_address
;
261 /* Address at which the breakpoint was requested. */
262 CORE_ADDR reqstd_address
;
264 /* If this is a ranged breakpoint, then this field contains the
265 length of the range that will be watched for execution. */
268 /* If the breakpoint lives in memory and reading that memory would
269 give back the breakpoint, instead of the original contents, then
270 the original contents are cached here. Only SHADOW_LEN bytes of
271 this buffer are valid, and only when the breakpoint is inserted. */
272 gdb_byte shadow_contents
[BREAKPOINT_MAX
];
274 /* The length of the data cached in SHADOW_CONTENTS. */
277 /* The breakpoint's kind. It is used in 'kind' parameter in Z
281 /* Conditions the target should evaluate if it supports target-side
282 breakpoint conditions. These are non-owning pointers. */
283 std::vector
<agent_expr
*> conditions
;
285 /* Commands the target should evaluate if it supports target-side
286 breakpoint commands. These are non-owning pointers. */
287 std::vector
<agent_expr
*> tcommands
;
289 /* Flag that is true if the breakpoint should be left in place even
290 when GDB is not connected. */
294 /* GDB maintains two types of information about each breakpoint (or
295 watchpoint, or other related event). The first type corresponds
296 to struct breakpoint; this is a relatively high-level structure
297 which contains the source location(s), stopping conditions, user
298 commands to execute when the breakpoint is hit, and so forth.
300 The second type of information corresponds to struct bp_location.
301 Each breakpoint has one or (eventually) more locations associated
302 with it, which represent target-specific and machine-specific
303 mechanisms for stopping the program. For instance, a watchpoint
304 expression may require multiple hardware watchpoints in order to
305 catch all changes in the value of the expression being watched. */
309 bp_loc_software_breakpoint
,
310 bp_loc_hardware_breakpoint
,
311 bp_loc_hardware_watchpoint
,
312 bp_loc_other
/* Miscellaneous... */
318 bp_location () = default;
320 /* Construct a bp_location with the type inferred from OWNER's
322 explicit bp_location (breakpoint
*owner
);
324 /* Construct a bp_location with type TYPE. */
325 bp_location (breakpoint
*owner
, bp_loc_type type
);
327 virtual ~bp_location ();
329 /* Chain pointer to the next breakpoint location for
330 the same parent breakpoint. */
331 bp_location
*next
= NULL
;
333 /* The reference count. */
336 /* Type of this breakpoint location. */
337 bp_loc_type loc_type
{};
339 /* Each breakpoint location must belong to exactly one higher-level
340 breakpoint. This pointer is NULL iff this bp_location is no
341 longer attached to a breakpoint. For example, when a breakpoint
342 is deleted, its locations may still be found in the
343 moribund_locations list, or if we had stopped for it, in
345 breakpoint
*owner
= NULL
;
347 /* Conditional. Break only if this expression's value is nonzero.
348 Unlike string form of condition, which is associated with
349 breakpoint, this is associated with location, since if breakpoint
350 has several locations, the evaluation of expression can be
351 different for different locations. Only valid for real
352 breakpoints; a watchpoint's conditional expression is stored in
353 the owner breakpoint object. */
356 /* Conditional expression in agent expression
357 bytecode form. This is used for stub-side breakpoint
358 condition evaluation. */
359 agent_expr_up cond_bytecode
;
361 /* Signals that the condition has changed since the last time
362 we updated the global location list. This means the condition
363 needs to be sent to the target again. This is used together
364 with target-side breakpoint conditions.
366 condition_unchanged: It means there has been no condition changes.
368 condition_modified: It means this location had its condition modified.
370 condition_updated: It means we already marked all the locations that are
371 duplicates of this location and thus we don't need to call
372 force_breakpoint_reinsertion (...) for this location. */
374 condition_status condition_changed
{};
376 agent_expr_up cmd_bytecode
;
378 /* Signals that breakpoint conditions and/or commands need to be
379 re-synched with the target. This has no use other than
380 target-side breakpoints. */
381 bool needs_update
= false;
383 /* This location's address is in an unloaded solib, and so this
384 location should not be inserted. It will be automatically
385 enabled when that solib is loaded. */
386 bool shlib_disabled
= false;
388 /* Is this particular location enabled. */
389 bool enabled
= false;
391 /* True if this breakpoint is now inserted. */
392 bool inserted
= false;
394 /* True if this is a permanent breakpoint. There is a breakpoint
395 instruction hard-wired into the target's code. Don't try to
396 write another breakpoint instruction on top of it, or restore its
397 value. Step over it using the architecture's
398 gdbarch_skip_permanent_breakpoint method. */
399 bool permanent
= false;
401 /* True if this is not the first breakpoint in the list
402 for the given address. location of tracepoint can _never_
403 be duplicated with other locations of tracepoints and other
404 kinds of breakpoints, because two locations at the same
405 address may have different actions, so both of these locations
406 should be downloaded and so that `tfind N' always works. */
407 bool duplicate
= false;
409 /* If we someday support real thread-specific breakpoints, then
410 the breakpoint location will need a thread identifier. */
412 /* Data for specific breakpoint types. These could be a union, but
413 simplicity is more important than memory usage for breakpoints. */
415 /* Architecture associated with this location's address. May be
416 different from the breakpoint architecture. */
417 struct gdbarch
*gdbarch
= NULL
;
419 /* The program space associated with this breakpoint location
420 address. Note that an address space may be represented in more
421 than one program space (e.g. each uClinux program will be given
422 its own program space, but there will only be one address space
423 for all of them), but we must not insert more than one location
424 at the same address in the same address space. */
425 program_space
*pspace
= NULL
;
427 /* Note that zero is a perfectly valid code address on some platforms
428 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
429 is not a special value for this field. Valid for all types except
431 CORE_ADDR address
= 0;
433 /* For hardware watchpoints, the size of the memory region being
434 watched. For hardware ranged breakpoints, the size of the
438 /* Type of hardware watchpoint. */
439 target_hw_bp_type watchpoint_type
{};
441 /* For any breakpoint type with an address, this is the section
442 associated with the address. Used primarily for overlay
444 obj_section
*section
= NULL
;
446 /* Address at which breakpoint was requested, either by the user or
447 by GDB for internal breakpoints. This will usually be the same
448 as ``address'' (above) except for cases in which
449 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
450 which to place the breakpoint in order to comply with a
451 processor's architectual constraints. */
452 CORE_ADDR requested_address
= 0;
454 /* An additional address assigned with this location. This is currently
455 only used by STT_GNU_IFUNC resolver breakpoints to hold the address
456 of the resolver function. */
457 CORE_ADDR related_address
= 0;
459 /* If the location comes from a probe point, this is the probe associated
461 bound_probe probe
{};
463 char *function_name
= NULL
;
465 /* Details of the placed breakpoint, when inserted. */
466 bp_target_info target_info
{};
468 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
469 bp_target_info overlay_target_info
{};
471 /* In a non-stop mode, it's possible that we delete a breakpoint,
472 but as we do that, some still running thread hits that breakpoint.
473 For that reason, we need to keep locations belonging to deleted
474 breakpoints for a bit, so that don't report unexpected SIGTRAP.
475 We can't keep such locations forever, so we use a heuristic --
476 after we process certain number of inferior events since
477 breakpoint was deleted, we retire all locations of that breakpoint.
478 This variable keeps a number of events still to go, when
479 it becomes 0 this location is retired. */
480 int events_till_retirement
= 0;
482 /* Line number which was used to place this location.
484 Breakpoint placed into a comment keeps it's user specified line number
485 despite ADDRESS resolves into a different line number. */
489 /* Symtab which was used to place this location. This is used
490 to find the corresponding source file name. */
492 struct symtab
*symtab
= NULL
;
494 /* The symbol found by the location parser, if any. This may be used to
495 ascertain when an event location was set at a different location than
496 the one originally selected by parsing, e.g., inlined symbols. */
497 const struct symbol
*symbol
= NULL
;
499 /* Similarly, the minimal symbol found by the location parser, if
500 any. This may be used to ascertain if the location was
501 originally set on a GNU ifunc symbol. */
502 const minimal_symbol
*msymbol
= NULL
;
504 /* The objfile the symbol or minimal symbol were found in. */
505 const struct objfile
*objfile
= NULL
;
508 /* The possible return values for print_bpstat, print_it_normal,
509 print_it_done, print_it_noop. */
510 enum print_stop_action
512 /* We printed nothing or we need to do some more analysis. */
515 /* We printed something, and we *do* desire that something to be
516 followed by a location. */
519 /* We printed something, and we do *not* desire that something to be
520 followed by a location. */
523 /* We already printed all we needed to print, don't print anything
528 /* This structure is a collection of function pointers that, if available,
529 will be called instead of the performing the default action for this
532 struct breakpoint_ops
534 /* Allocate a location for this breakpoint. */
535 struct bp_location
* (*allocate_location
) (struct breakpoint
*);
537 /* Reevaluate a breakpoint. This is necessary after symbols change
538 (e.g., an executable or DSO was loaded, or the inferior just
540 void (*re_set
) (struct breakpoint
*self
);
542 /* Insert the breakpoint or watchpoint or activate the catchpoint.
543 Return 0 for success, 1 if the breakpoint, watchpoint or
544 catchpoint type is not supported, -1 for failure. */
545 int (*insert_location
) (struct bp_location
*);
547 /* Remove the breakpoint/catchpoint that was previously inserted
548 with the "insert" method above. Return 0 for success, 1 if the
549 breakpoint, watchpoint or catchpoint type is not supported,
551 int (*remove_location
) (struct bp_location
*, enum remove_bp_reason reason
);
553 /* Return true if it the target has stopped due to hitting
554 breakpoint location BL. This function does not check if we
555 should stop, only if BL explains the stop. ASPACE is the address
556 space in which the event occurred, BP_ADDR is the address at
557 which the inferior stopped, and WS is the target_waitstatus
558 describing the event. */
559 int (*breakpoint_hit
) (const struct bp_location
*bl
,
560 const address_space
*aspace
,
562 const struct target_waitstatus
*ws
);
564 /* Check internal conditions of the breakpoint referred to by BS.
565 If we should not stop for this breakpoint, set BS->stop to 0. */
566 void (*check_status
) (struct bpstats
*bs
);
568 /* Tell how many hardware resources (debug registers) are needed
569 for this breakpoint. If this function is not provided, then
570 the breakpoint or watchpoint needs one debug register. */
571 int (*resources_needed
) (const struct bp_location
*);
573 /* Tell whether we can downgrade from a hardware watchpoint to a software
574 one. If not, the user will not be able to enable the watchpoint when
575 there are not enough hardware resources available. */
576 int (*works_in_software_mode
) (const struct breakpoint
*);
578 /* The normal print routine for this breakpoint, called when we
580 enum print_stop_action (*print_it
) (struct bpstats
*bs
);
582 /* Display information about this breakpoint, for "info
584 void (*print_one
) (struct breakpoint
*, struct bp_location
**);
586 /* Display extra information about this breakpoint, below the normal
587 breakpoint description in "info breakpoints".
589 In the example below, the "address range" line was printed
590 by print_one_detail_ranged_breakpoint.
592 (gdb) info breakpoints
593 Num Type Disp Enb Address What
594 2 hw breakpoint keep y in main at test-watch.c:70
595 address range: [0x10000458, 0x100004c7]
598 void (*print_one_detail
) (const struct breakpoint
*, struct ui_out
*);
600 /* Display information about this breakpoint after setting it
601 (roughly speaking; this is called from "mention"). */
602 void (*print_mention
) (struct breakpoint
*);
604 /* Print to FP the CLI command that recreates this breakpoint. */
605 void (*print_recreate
) (struct breakpoint
*, struct ui_file
*fp
);
607 /* Create SALs from location, storing the result in linespec_result.
609 For an explanation about the arguments, see the function
610 `create_sals_from_location_default'.
612 This function is called inside `create_breakpoint'. */
613 void (*create_sals_from_location
) (const struct event_location
*location
,
614 struct linespec_result
*canonical
,
615 enum bptype type_wanted
);
617 /* This method will be responsible for creating a breakpoint given its SALs.
618 Usually, it just calls `create_breakpoints_sal' (for ordinary
619 breakpoints). However, there may be some special cases where we might
620 need to do some tweaks, e.g., see
621 `strace_marker_create_breakpoints_sal'.
623 This function is called inside `create_breakpoint'. */
624 void (*create_breakpoints_sal
) (struct gdbarch
*,
625 struct linespec_result
*,
626 gdb::unique_xmalloc_ptr
<char>,
627 gdb::unique_xmalloc_ptr
<char>,
628 enum bptype
, enum bpdisp
, int, int,
629 int, const struct breakpoint_ops
*,
630 int, int, int, unsigned);
632 /* Given the location (second parameter), this method decodes it and
633 returns the SAL locations related to it. For ordinary
634 breakpoints, it calls `decode_line_full'. If SEARCH_PSPACE is
635 not NULL, symbol search is restricted to just that program space.
637 This function is called inside `location_to_sals'. */
638 std::vector
<symtab_and_line
> (*decode_location
)
639 (struct breakpoint
*b
,
640 const struct event_location
*location
,
641 struct program_space
*search_pspace
);
643 /* Return true if this breakpoint explains a signal. See
644 bpstat_explains_signal. */
645 int (*explains_signal
) (struct breakpoint
*, enum gdb_signal
);
647 /* Called after evaluating the breakpoint's condition,
648 and only if it evaluated true. */
649 void (*after_condition_true
) (struct bpstats
*bs
);
652 /* Helper for breakpoint_ops->print_recreate implementations. Prints
653 the "thread" or "task" condition of B, and then a newline.
655 Necessary because most breakpoint implementations accept
656 thread/task conditions at the end of the spec line, like "break foo
657 thread 1", which needs outputting before any breakpoint-type
658 specific extra command necessary for B's recreation. */
659 extern void print_recreate_thread (struct breakpoint
*b
, struct ui_file
*fp
);
661 enum watchpoint_triggered
663 /* This watchpoint definitely did not trigger. */
664 watch_triggered_no
= 0,
666 /* Some hardware watchpoint triggered, and it might have been this
667 one, but we do not know which it was. */
668 watch_triggered_unknown
,
670 /* This hardware watchpoint definitely did trigger. */
674 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
675 a watchpoint over a memory region. If this flag is true, GDB will use
676 only one register per watchpoint, thus assuming that all acesses that
677 modify a memory location happen at its starting address. */
679 extern bool target_exact_watchpoints
;
681 /* Note that the ->silent field is not currently used by any commands
682 (though the code is in there if it was to be, and set_raw_breakpoint
683 does set it to 0). I implemented it because I thought it would be
684 useful for a hack I had to put in; I'm going to leave it in because
685 I can see how there might be times when it would indeed be useful */
687 /* This is for all kinds of breakpoints. */
691 virtual ~breakpoint ();
693 /* Methods associated with this breakpoint. */
694 const breakpoint_ops
*ops
= NULL
;
696 breakpoint
*next
= NULL
;
697 /* Type of breakpoint. */
698 bptype type
= bp_none
;
699 /* Zero means disabled; remember the info but don't break here. */
700 enum enable_state enable_state
= bp_enabled
;
701 /* What to do with this breakpoint after we hit it. */
702 bpdisp disposition
= disp_del
;
703 /* Number assigned to distinguish breakpoints. */
706 /* Location(s) associated with this high-level breakpoint. */
707 bp_location
*loc
= NULL
;
709 /* True means a silent breakpoint (don't print frame info if we stop
712 /* True means display ADDR_STRING to the user verbatim. */
713 bool display_canonical
= false;
714 /* Number of stops at this breakpoint that should be continued
715 automatically before really stopping. */
716 int ignore_count
= 0;
718 /* Number of stops at this breakpoint before it will be
720 int enable_count
= 0;
722 /* Chain of command lines to execute when this breakpoint is
724 counted_command_line commands
;
725 /* Stack depth (address of frame). If nonzero, break only if fp
727 struct frame_id frame_id
= null_frame_id
;
729 /* The program space used to set the breakpoint. This is only set
730 for breakpoints which are specific to a program space; for
731 non-thread-specific ordinary breakpoints this is NULL. */
732 program_space
*pspace
= NULL
;
734 /* Location we used to set the breakpoint. */
735 event_location_up location
;
737 /* The filter that should be passed to decode_line_full when
738 re-setting this breakpoint. This may be NULL. */
739 gdb::unique_xmalloc_ptr
<char> filter
;
741 /* For a ranged breakpoint, the location we used to find the end of
743 event_location_up location_range_end
;
745 /* Architecture we used to set the breakpoint. */
746 struct gdbarch
*gdbarch
= NULL
;
747 /* Language we used to set the breakpoint. */
748 enum language language
= language_unknown
;
749 /* Input radix we used to set the breakpoint. */
751 /* String form of the breakpoint condition (malloc'd), or NULL if
752 there is no condition. */
753 char *cond_string
= NULL
;
755 /* String form of extra parameters, or NULL if there are none.
757 char *extra_string
= NULL
;
759 /* Holds the address of the related watchpoint_scope breakpoint when
760 using watchpoints on local variables (might the concept of a
761 related breakpoint be useful elsewhere, if not just call it the
762 watchpoint_scope breakpoint or something like that. FIXME). */
763 breakpoint
*related_breakpoint
= NULL
;
765 /* Thread number for thread-specific breakpoint, or -1 if don't
769 /* Ada task number for task-specific breakpoint, or 0 if don't
773 /* Count of the number of times this breakpoint was taken, dumped
774 with the info, but not used for anything else. Useful for seeing
775 how many times you hit a break prior to the program aborting, so
776 you can back up to just before the abort. */
779 /* Is breakpoint's condition not yet parsed because we found no
780 location initially so had no context to parse the condition
782 int condition_not_parsed
= 0;
784 /* With a Python scripting enabled GDB, store a reference to the
785 Python object that has been associated with this breakpoint.
786 This is always NULL for a GDB that is not script enabled. It can
787 sometimes be NULL for enabled GDBs as not all breakpoint types
788 are tracked by the scripting language API. */
789 gdbpy_breakpoint_object
*py_bp_object
= NULL
;
791 /* Same as py_bp_object, but for Scheme. */
792 gdbscm_breakpoint_object
*scm_bp_object
= NULL
;
795 /* An instance of this type is used to represent a watchpoint. */
797 struct watchpoint
: public breakpoint
799 ~watchpoint () override
;
801 /* String form of exp to use for displaying to the user (malloc'd),
804 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
805 char *exp_string_reparse
;
807 /* The expression we are watching, or NULL if not a watchpoint. */
809 /* The largest block within which it is valid, or NULL if it is
810 valid anywhere (e.g. consists just of global symbols). */
811 const struct block
*exp_valid_block
;
812 /* The conditional expression if any. */
813 expression_up cond_exp
;
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
*cond_exp_valid_block
;
817 /* Value of the watchpoint the last time we checked it, or NULL when
818 we do not know the value yet or the value was not readable. VAL
822 /* True if VAL is valid. If VAL_VALID is set but VAL is NULL,
823 then an error occurred reading the value. */
826 /* When watching the location of a bitfield, contains the offset and size of
827 the bitfield. Otherwise contains 0. */
831 /* Holds the frame address which identifies the frame this
832 watchpoint should be evaluated in, or `null' if the watchpoint
833 should be evaluated on the outermost frame. */
834 struct frame_id watchpoint_frame
;
836 /* Holds the thread which identifies the frame this watchpoint
837 should be considered in scope for, or `null_ptid' if the
838 watchpoint should be evaluated in all threads. */
839 ptid_t watchpoint_thread
;
841 /* For hardware watchpoints, the triggered status according to the
843 enum watchpoint_triggered watchpoint_triggered
;
845 /* Whether this watchpoint is exact (see
846 target_exact_watchpoints). */
849 /* The mask address for a masked hardware watchpoint. */
850 CORE_ADDR hw_wp_mask
;
853 /* Given a function FUNC (struct breakpoint *B, void *DATA) and
854 USER_DATA, call FUNC for every known breakpoint passing USER_DATA
857 If FUNC returns 1, the loop stops and the current
858 'struct breakpoint' being processed is returned. If FUNC returns
859 zero, the loop continues.
861 This function returns either a 'struct breakpoint' pointer or NULL.
862 It was based on BFD's bfd_sections_find_if function. */
864 extern struct breakpoint
*breakpoint_find_if
865 (int (*func
) (struct breakpoint
*b
, void *d
), void *user_data
);
867 /* Return true if BPT is either a software breakpoint or a hardware
870 extern bool is_breakpoint (const struct breakpoint
*bpt
);
872 /* Return true if BPT is of any watchpoint kind, hardware or
875 extern bool is_watchpoint (const struct breakpoint
*bpt
);
877 /* Return true if BPT is a C++ exception catchpoint (catch
878 catch/throw/rethrow). */
880 extern bool is_exception_catchpoint (breakpoint
*bp
);
882 /* An instance of this type is used to represent all kinds of
885 struct tracepoint
: public breakpoint
887 /* Number of times this tracepoint should single-step and collect
891 /* Number of times this tracepoint should be hit before
895 /* The number of the tracepoint on the target. */
896 int number_on_target
;
898 /* The total space taken by all the trace frames for this
900 ULONGEST traceframe_usage
;
902 /* The static tracepoint marker id, if known. */
903 std::string static_trace_marker_id
;
905 /* LTTng/UST allow more than one marker with the same ID string,
906 although it unadvised because it confuses tools. When setting
907 static tracepoints by marker ID, this will record the index in
908 the array of markers we found for the given marker ID for which
909 this static tracepoint corresponds. When resetting breakpoints,
910 we will use this index to try to find the same marker again. */
911 int static_trace_marker_id_idx
;
915 /* The following stuff is an abstract data type "bpstat" ("breakpoint
916 status"). This provides the ability to determine whether we have
917 stopped at a breakpoint, and what we should do about it. */
919 typedef struct bpstats
*bpstat
;
921 /* Clears a chain of bpstat, freeing storage
923 extern void bpstat_clear (bpstat
*);
925 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
926 is part of the bpstat is copied as well. */
927 extern bpstat
bpstat_copy (bpstat
);
929 /* Build the (raw) bpstat chain for the stop information given by ASPACE,
930 BP_ADDR, and WS. Returns the head of the bpstat chain. */
932 extern bpstat
build_bpstat_chain (const address_space
*aspace
,
934 const struct target_waitstatus
*ws
);
936 /* Get a bpstat associated with having just stopped at address
937 BP_ADDR in thread PTID. STOP_CHAIN may be supplied as a previously
938 computed stop chain or NULL, in which case the stop chain will be
939 computed using build_bpstat_chain.
941 Determine whether we stopped at a breakpoint, etc, or whether we
942 don't understand this stop. Result is a chain of bpstat's such
945 if we don't understand the stop, the result is a null pointer.
947 if we understand why we stopped, the result is not null.
949 Each element of the chain refers to a particular breakpoint or
950 watchpoint at which we have stopped. (We may have stopped for
951 several reasons concurrently.)
953 Each element of the chain has valid next, breakpoint_at,
954 commands, FIXME??? fields. */
956 extern bpstat
bpstat_stop_status (const address_space
*aspace
,
957 CORE_ADDR pc
, thread_info
*thread
,
958 const struct target_waitstatus
*ws
,
959 bpstat stop_chain
= NULL
);
961 /* This bpstat_what stuff tells wait_for_inferior what to do with a
962 breakpoint (a challenging task).
964 The enum values order defines priority-like order of the actions.
965 Once you've decided that some action is appropriate, you'll never
966 go back and decide something of a lower priority is better. Each
967 of these actions is mutually exclusive with the others. That
968 means, that if you find yourself adding a new action class here and
969 wanting to tell GDB that you have two simultaneous actions to
970 handle, something is wrong, and you probably don't actually need a
973 Note that a step resume breakpoint overrides another breakpoint of
974 signal handling (see comment in wait_for_inferior at where we set
975 the step_resume breakpoint). */
977 enum bpstat_what_main_action
979 /* Perform various other tests; that is, this bpstat does not
980 say to perform any action (e.g. failed watchpoint and nothing
982 BPSTAT_WHAT_KEEP_CHECKING
,
984 /* Remove breakpoints, single step once, then put them back in and
985 go back to what we were doing. It's possible that this should
986 be removed from the main_action and put into a separate field,
987 to more cleanly handle
988 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
991 /* Set longjmp_resume breakpoint, remove all other breakpoints,
992 and continue. The "remove all other breakpoints" part is
993 required if we are also stepping over another breakpoint as
994 well as doing the longjmp handling. */
995 BPSTAT_WHAT_SET_LONGJMP_RESUME
,
997 /* Clear longjmp_resume breakpoint, then handle as
998 BPSTAT_WHAT_KEEP_CHECKING. */
999 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME
,
1001 /* Clear step resume breakpoint, and keep checking. */
1002 BPSTAT_WHAT_STEP_RESUME
,
1004 /* Rather than distinguish between noisy and silent stops here, it
1005 might be cleaner to have bpstat_print make that decision (also
1006 taking into account stop_print_frame and source_only). But the
1007 implications are a bit scary (interaction with auto-displays,
1008 etc.), so I won't try it. */
1010 /* Stop silently. */
1011 BPSTAT_WHAT_STOP_SILENT
,
1013 /* Stop and print. */
1014 BPSTAT_WHAT_STOP_NOISY
,
1016 /* Clear step resume breakpoint, and keep checking. High-priority
1017 step-resume breakpoints are used when even if there's a user
1018 breakpoint at the current PC when we set the step-resume
1019 breakpoint, we don't want to re-handle any breakpoint other
1020 than the step-resume when it's hit; instead we want to move
1021 past the breakpoint. This is used in the case of skipping
1023 BPSTAT_WHAT_HP_STEP_RESUME
,
1026 /* An enum indicating the kind of "stack dummy" stop. This is a bit
1027 of a misnomer because only one kind of truly a stack dummy. */
1028 enum stop_stack_kind
1030 /* We didn't stop at a stack dummy breakpoint. */
1033 /* Stopped at a stack dummy. */
1036 /* Stopped at std::terminate. */
1042 enum bpstat_what_main_action main_action
;
1044 /* Did we hit a call dummy breakpoint? This only goes with a
1045 main_action of BPSTAT_WHAT_STOP_SILENT or
1046 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
1047 dummy without popping the frame is not a useful one). */
1048 enum stop_stack_kind call_dummy
;
1050 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
1051 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
1052 longjmp, false if we are handling an exception. */
1056 /* Tell what to do about this bpstat. */
1057 struct bpstat_what
bpstat_what (bpstat
);
1059 /* Run breakpoint event callbacks associated with the breakpoints that
1061 extern void bpstat_run_callbacks (bpstat bs_head
);
1063 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
1064 bpstat
bpstat_find_breakpoint (bpstat
, struct breakpoint
*);
1066 /* True if a signal that we got in target_wait() was due to
1067 circumstances explained by the bpstat; the signal is therefore not
1069 extern bool bpstat_explains_signal (bpstat
, enum gdb_signal
);
1071 /* True if this bpstat causes a stop. */
1072 extern bool bpstat_causes_stop (bpstat
);
1074 /* True if we should step constantly (e.g. watchpoints on machines
1075 without hardware support). This isn't related to a specific bpstat,
1076 just to things like whether watchpoints are set. */
1077 extern bool bpstat_should_step ();
1079 /* Print a message indicating what happened. Returns nonzero to
1080 say that only the source line should be printed after this (zero
1081 return means print the frame as well as the source line). */
1082 extern enum print_stop_action
bpstat_print (bpstat
, int);
1084 /* Put in *NUM the breakpoint number of the first breakpoint we are
1085 stopped at. *BSP upon return is a bpstat which points to the
1086 remaining breakpoints stopped at (but which is not guaranteed to be
1087 good for anything but further calls to bpstat_num).
1089 Return 0 if passed a bpstat which does not indicate any breakpoints.
1090 Return -1 if stopped at a breakpoint that has been deleted since
1092 Return 1 otherwise. */
1093 extern int bpstat_num (bpstat
*, int *);
1095 /* Perform actions associated with the stopped inferior. Actually, we
1096 just use this for breakpoint commands. Perhaps other actions will
1097 go here later, but this is executed at a late time (from the
1099 extern void bpstat_do_actions (void);
1101 /* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will
1102 not be performed. */
1103 extern void bpstat_clear_actions (void);
1105 /* Implementation: */
1107 /* Values used to tell the printing routine how to behave for this
1111 /* This is used when we want to do a normal printing of the reason
1112 for stopping. The output will depend on the type of eventpoint
1113 we are dealing with. This is the default value, most commonly
1116 /* This is used when nothing should be printed for this bpstat
1119 /* This is used when everything which needs to be printed has
1120 already been printed. But we still want to print the frame. */
1127 bpstats (struct bp_location
*bl
, bpstat
**bs_link_pointer
);
1130 bpstats (const bpstats
&);
1131 bpstats
&operator= (const bpstats
&) = delete;
1133 /* Linked list because there can be more than one breakpoint at
1134 the same place, and a bpstat reflects the fact that all have
1138 /* Location that caused the stop. Locations are refcounted, so
1139 this will never be NULL. Note that this location may end up
1140 detached from a breakpoint, but that does not necessary mean
1141 that the struct breakpoint is gone. E.g., consider a
1142 watchpoint with a condition that involves an inferior function
1143 call. Watchpoint locations are recreated often (on resumes,
1144 hence on infcalls too). Between creating the bpstat and after
1145 evaluating the watchpoint condition, this location may hence
1146 end up detached from its original owner watchpoint, even though
1147 the watchpoint is still listed. If it's condition evaluates as
1148 true, we still want this location to cause a stop, and we will
1149 still need to know which watchpoint it was originally attached.
1150 What this means is that we should not (in most cases) follow
1151 the `bpstat->bp_location->owner' link, but instead use the
1152 `breakpoint_at' field below. */
1153 struct bp_location
*bp_location_at
;
1155 /* Breakpoint that caused the stop. This is nullified if the
1156 breakpoint ends up being deleted. See comments on
1157 `bp_location_at' above for why do we need this field instead of
1158 following the location's owner. */
1159 struct breakpoint
*breakpoint_at
;
1161 /* The associated command list. */
1162 counted_command_line commands
;
1164 /* Old value associated with a watchpoint. */
1165 value_ref_ptr old_val
;
1167 /* Nonzero if this breakpoint tells us to print the frame. */
1170 /* Nonzero if this breakpoint tells us to stop. */
1173 /* Tell bpstat_print and print_bp_stop_message how to print stuff
1174 associated with this element of the bpstat chain. */
1175 enum bp_print_how print_it
;
1186 /* The possible return values for breakpoint_here_p.
1187 We guarantee that zero always means "no breakpoint here". */
1188 enum breakpoint_here
1190 no_breakpoint_here
= 0,
1191 ordinary_breakpoint_here
,
1192 permanent_breakpoint_here
1196 /* Prototypes for breakpoint-related functions. */
1198 /* Return 1 if there's a program/permanent breakpoint planted in
1199 memory at ADDRESS, return 0 otherwise. */
1201 extern int program_breakpoint_here_p (struct gdbarch
*gdbarch
, CORE_ADDR address
);
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 hbreak_command_wrapper (const char *, int);
1304 extern void thbreak_command_wrapper (const char *, int);
1305 extern void rbreak_command_wrapper (const char *, int);
1306 extern void watch_command_wrapper (const char *, int, int);
1307 extern void awatch_command_wrapper (const char *, int, int);
1308 extern void rwatch_command_wrapper (const char *, int, int);
1309 extern void tbreak_command (const char *, int);
1311 extern struct breakpoint_ops base_breakpoint_ops
;
1312 extern struct breakpoint_ops bkpt_breakpoint_ops
;
1313 extern struct breakpoint_ops tracepoint_breakpoint_ops
;
1314 extern struct breakpoint_ops dprintf_breakpoint_ops
;
1316 extern void initialize_breakpoint_ops (void);
1318 /* Arguments to pass as context to some catch command handlers. */
1319 #define CATCH_PERMANENT ((void *) (uintptr_t) 0)
1320 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
1322 /* Like add_cmd, but add the command to both the "catch" and "tcatch"
1323 lists, and pass some additional user data to the command
1327 add_catch_command (const char *name
, const char *docstring
,
1328 cmd_const_sfunc_ftype
*sfunc
,
1329 completer_ftype
*completer
,
1330 void *user_data_catch
,
1331 void *user_data_tcatch
);
1333 /* Initialize a breakpoint struct for Ada exception catchpoints. */
1336 init_ada_exception_breakpoint (struct breakpoint
*b
,
1337 struct gdbarch
*gdbarch
,
1338 struct symtab_and_line sal
,
1339 const char *addr_string
,
1340 const struct breakpoint_ops
*ops
,
1345 extern void init_catchpoint (struct breakpoint
*b
,
1346 struct gdbarch
*gdbarch
, int tempflag
,
1347 const char *cond_string
,
1348 const struct breakpoint_ops
*ops
);
1350 /* Add breakpoint B on the breakpoint list, and notify the user, the
1351 target and breakpoint_created observers of its existence. If
1352 INTERNAL is non-zero, the breakpoint number will be allocated from
1353 the internal breakpoint count. If UPDATE_GLL is non-zero,
1354 update_global_location_list will be called. */
1356 extern void install_breakpoint (int internal
, std::unique_ptr
<breakpoint
> &&b
,
1359 /* Flags that can be passed down to create_breakpoint, etc., to affect
1360 breakpoint creation in several ways. */
1362 enum breakpoint_create_flags
1364 /* We're adding a breakpoint to our tables that is already
1365 inserted in the target. */
1366 CREATE_BREAKPOINT_FLAGS_INSERTED
= 1 << 0
1369 /* Set a breakpoint. This function is shared between CLI and MI functions
1370 for setting a breakpoint at LOCATION.
1372 This function has two major modes of operations, selected by the
1373 PARSE_EXTRA parameter.
1375 If PARSE_EXTRA is zero, LOCATION is just the breakpoint's location,
1376 with condition, thread, and extra string specified by the COND_STRING,
1377 THREAD, and EXTRA_STRING parameters.
1379 If PARSE_EXTRA is non-zero, this function will attempt to extract
1380 the condition, thread, and extra string from EXTRA_STRING, ignoring
1381 the similarly named parameters.
1383 If INTERNAL is non-zero, the breakpoint number will be allocated
1384 from the internal breakpoint count.
1386 Returns true if any breakpoint was created; false otherwise. */
1388 extern int create_breakpoint (struct gdbarch
*gdbarch
,
1389 const struct event_location
*location
,
1390 const char *cond_string
, int thread
,
1391 const char *extra_string
,
1393 int tempflag
, enum bptype wanted_type
,
1395 enum auto_boolean pending_break_support
,
1396 const struct breakpoint_ops
*ops
,
1399 int internal
, unsigned flags
);
1401 extern void insert_breakpoints (void);
1403 extern int remove_breakpoints (void);
1405 /* Remove breakpoints of inferior INF. */
1407 extern void remove_breakpoints_inf (inferior
*inf
);
1409 /* This function can be used to update the breakpoint package's state
1410 after an exec() system call has been executed.
1412 This function causes the following:
1414 - All eventpoints are marked "not inserted".
1415 - All eventpoints with a symbolic address are reset such that
1416 the symbolic address must be reevaluated before the eventpoints
1418 - The solib breakpoints are explicitly removed from the breakpoint
1420 - A step-resume breakpoint, if any, is explicitly removed from the
1422 - All eventpoints without a symbolic address are removed from the
1424 extern void update_breakpoints_after_exec (void);
1426 /* This function can be used to physically remove hardware breakpoints
1427 and watchpoints from the specified traced inferior process, without
1428 modifying the breakpoint package's state. This can be useful for
1429 those targets which support following the processes of a fork() or
1430 vfork() system call, when one of the resulting two processes is to
1431 be detached and allowed to run free.
1433 It is an error to use this function on the process whose id is
1435 extern int detach_breakpoints (ptid_t ptid
);
1437 /* This function is called when program space PSPACE is about to be
1438 deleted. It takes care of updating breakpoints to not reference
1439 this PSPACE anymore. */
1440 extern void breakpoint_program_space_exit (struct program_space
*pspace
);
1442 extern void set_longjmp_breakpoint (struct thread_info
*tp
,
1443 struct frame_id frame
);
1444 extern void delete_longjmp_breakpoint (int thread
);
1446 /* Mark all longjmp breakpoints from THREAD for later deletion. */
1447 extern void delete_longjmp_breakpoint_at_next_stop (int thread
);
1449 extern struct breakpoint
*set_longjmp_breakpoint_for_call_dummy (void);
1450 extern void check_longjmp_breakpoint_for_call_dummy (struct thread_info
*tp
);
1452 extern void enable_overlay_breakpoints (void);
1453 extern void disable_overlay_breakpoints (void);
1455 extern void set_std_terminate_breakpoint (void);
1456 extern void delete_std_terminate_breakpoint (void);
1458 /* These functions respectively disable or reenable all currently
1459 enabled watchpoints. When disabled, the watchpoints are marked
1460 call_disabled. When re-enabled, they are marked enabled.
1462 The intended client of these functions is call_function_by_hand.
1464 The inferior must be stopped, and all breakpoints removed, when
1465 these functions are used.
1467 The need for these functions is that on some targets (e.g., HP-UX),
1468 gdb is unable to unwind through the dummy frame that is pushed as
1469 part of the implementation of a call command. Watchpoints can
1470 cause the inferior to stop in places where this frame is visible,
1471 and that can cause execution control to become very confused.
1473 Note that if a user sets breakpoints in an interactively called
1474 function, the call_disabled watchpoints will have been re-enabled
1475 when the first such breakpoint is reached. However, on targets
1476 that are unable to unwind through the call dummy frame, watches
1477 of stack-based storage may then be deleted, because gdb will
1478 believe that their watched storage is out of scope. (Sigh.) */
1479 extern void disable_watchpoints_before_interactive_call_start (void);
1481 extern void enable_watchpoints_after_interactive_call_stop (void);
1483 /* These functions disable and re-enable all breakpoints during
1484 inferior startup. They are intended to be called from solib
1485 code where necessary. This is needed on platforms where the
1486 main executable is relocated at some point during startup
1487 processing, making breakpoint addresses invalid.
1489 If additional breakpoints are created after the routine
1490 disable_breakpoints_before_startup but before the routine
1491 enable_breakpoints_after_startup was called, they will also
1492 be marked as disabled. */
1493 extern void disable_breakpoints_before_startup (void);
1494 extern void enable_breakpoints_after_startup (void);
1496 /* For script interpreters that need to define breakpoint commands
1497 after they've already read the commands into a struct
1499 extern enum command_control_type commands_from_control_command
1500 (const char *arg
, struct command_line
*cmd
);
1502 extern void clear_breakpoint_hit_counts (void);
1504 extern struct breakpoint
*get_breakpoint (int num
);
1506 /* The following are for displays, which aren't really breakpoints,
1507 but here is as good a place as any for them. */
1509 extern void disable_current_display (void);
1511 extern void do_displays (void);
1513 extern void disable_display (int);
1515 extern void clear_displays (void);
1517 extern void disable_breakpoint (struct breakpoint
*);
1519 extern void enable_breakpoint (struct breakpoint
*);
1521 extern void breakpoint_set_commands (struct breakpoint
*b
,
1522 counted_command_line
&&commands
);
1524 extern void breakpoint_set_silent (struct breakpoint
*b
, int silent
);
1526 extern void breakpoint_set_thread (struct breakpoint
*b
, int thread
);
1528 extern void breakpoint_set_task (struct breakpoint
*b
, int task
);
1530 /* Clear the "inserted" flag in all breakpoints. */
1531 extern void mark_breakpoints_out (void);
1533 extern struct breakpoint
*create_jit_event_breakpoint (struct gdbarch
*,
1536 extern struct breakpoint
*create_solib_event_breakpoint (struct gdbarch
*,
1539 /* Create an solib event breakpoint at ADDRESS in the current program
1540 space, and immediately try to insert it. Returns a pointer to the
1541 breakpoint on success. Deletes the new breakpoint and returns NULL
1542 if inserting the breakpoint fails. */
1543 extern struct breakpoint
*create_and_insert_solib_event_breakpoint
1544 (struct gdbarch
*gdbarch
, CORE_ADDR address
);
1546 extern struct breakpoint
*create_thread_event_breakpoint (struct gdbarch
*,
1549 extern void remove_jit_event_breakpoints (void);
1551 extern void remove_solib_event_breakpoints (void);
1553 /* Mark solib event breakpoints of the current program space with
1554 delete at next stop disposition. */
1555 extern void remove_solib_event_breakpoints_at_next_stop (void);
1557 extern void disable_breakpoints_in_shlibs (void);
1559 /* This function returns true if B is a catchpoint. */
1561 extern bool is_catchpoint (struct breakpoint
*b
);
1563 /* Shared helper function (MI and CLI) for creating and installing
1564 a shared object event catchpoint. */
1565 extern void add_solib_catchpoint (const char *arg
, int is_load
, int is_temp
,
1568 /* Create and insert a new software single step breakpoint for the
1569 current thread. May be called multiple times; each time will add a
1570 new location to the set of potential addresses the next instruction
1572 extern void insert_single_step_breakpoint (struct gdbarch
*,
1573 const address_space
*,
1576 /* Insert all software single step breakpoints for the current frame.
1577 Return true if any software single step breakpoints are inserted,
1578 otherwise, return false. */
1579 extern int insert_single_step_breakpoints (struct gdbarch
*);
1581 /* Check if any hardware watchpoints have triggered, according to the
1583 int watchpoints_triggered (struct target_waitstatus
*);
1585 /* Helper for transparent breakpoint hiding for memory read and write
1588 Update one of READBUF or WRITEBUF with either the shadows
1589 (READBUF), or the breakpoint instructions (WRITEBUF) of inserted
1590 breakpoints at the memory range defined by MEMADDR and extending
1591 for LEN bytes. If writing, then WRITEBUF is a copy of WRITEBUF_ORG
1593 extern void breakpoint_xfer_memory (gdb_byte
*readbuf
, gdb_byte
*writebuf
,
1594 const gdb_byte
*writebuf_org
,
1595 ULONGEST memaddr
, LONGEST len
);
1597 /* Return true if breakpoints should be inserted now. That'll be the
1600 - the target has global breakpoints.
1602 - "breakpoint always-inserted" is on, and the target has
1605 - threads are executing.
1607 extern int breakpoints_should_be_inserted_now (void);
1609 /* Called each time new event from target is processed.
1610 Retires previously deleted breakpoint locations that
1611 in our opinion won't ever trigger. */
1612 extern void breakpoint_retire_moribund (void);
1614 /* Set break condition of breakpoint B to EXP. */
1615 extern void set_breakpoint_condition (struct breakpoint
*b
, const char *exp
,
1618 /* Checks if we are catching syscalls or not.
1619 Returns 0 if not, greater than 0 if we are. */
1620 extern int catch_syscall_enabled (void);
1622 /* Checks if we are catching syscalls with the specific
1623 syscall_number. Used for "filtering" the catchpoints.
1624 Returns 0 if not, greater than 0 if we are. */
1625 extern int catching_syscall_number (int syscall_number
);
1627 /* Return a tracepoint with the given number if found. */
1628 extern struct tracepoint
*get_tracepoint (int num
);
1630 extern struct tracepoint
*get_tracepoint_by_number_on_target (int num
);
1632 /* Find a tracepoint by parsing a number in the supplied string. */
1633 extern struct tracepoint
*
1634 get_tracepoint_by_number (const char **arg
,
1635 number_or_range_parser
*parser
);
1637 /* Return a vector of all tracepoints currently defined. */
1638 extern std::vector
<breakpoint
*> all_tracepoints (void);
1640 /* Return true if B is of tracepoint kind. */
1642 extern bool is_tracepoint (const struct breakpoint
*b
);
1644 /* Return a vector of all static tracepoints defined at ADDR. */
1645 extern std::vector
<breakpoint
*> static_tracepoints_here (CORE_ADDR addr
);
1647 /* Create an instance of this to start registering breakpoint numbers
1648 for a later "commands" command. */
1650 class scoped_rbreak_breakpoints
1654 scoped_rbreak_breakpoints ();
1655 ~scoped_rbreak_breakpoints ();
1657 DISABLE_COPY_AND_ASSIGN (scoped_rbreak_breakpoints
);
1660 /* Breakpoint iterator function.
1662 Calls a callback function once for each breakpoint, so long as the
1663 callback function returns false. If the callback function returns
1664 true, the iteration will end and the current breakpoint will be
1665 returned. This can be useful for implementing a search for a
1666 breakpoint with arbitrary attributes, or for applying an operation
1667 to every breakpoint. */
1668 extern struct breakpoint
*iterate_over_breakpoints
1669 (gdb::function_view
<bool (breakpoint
*)>);
1671 /* Nonzero if the specified PC cannot be a location where functions
1672 have been inlined. */
1674 extern int pc_at_non_inline_function (const address_space
*aspace
,
1676 const struct target_waitstatus
*ws
);
1678 extern int user_breakpoint_p (struct breakpoint
*);
1680 /* Return true if this breakpoint is pending, false if not. */
1681 extern int pending_breakpoint_p (struct breakpoint
*);
1683 /* Attempt to determine architecture of location identified by SAL. */
1684 extern struct gdbarch
*get_sal_arch (struct symtab_and_line sal
);
1686 extern void breakpoint_free_objfile (struct objfile
*objfile
);
1688 extern const char *ep_parse_optional_if_clause (const char **arg
);
1690 /* Print the "Thread ID hit" part of "Thread ID hit Breakpoint N" to
1691 UIOUT iff debugging multiple threads. */
1692 extern void maybe_print_thread_hit_breakpoint (struct ui_out
*uiout
);
1694 /* Print the specified breakpoint. */
1695 extern void print_breakpoint (breakpoint
*bp
);
1697 /* Command element for the 'commands' command. */
1698 extern cmd_list_element
*commands_cmd_element
;
1700 /* Whether to use the fixed output when printing information about a
1701 multi-location breakpoint (see PR 9659). */
1703 extern bool fix_multi_location_breakpoint_output_globally
;
1705 /* Deal with "catch catch", "catch throw", and "catch rethrow" commands and
1706 the MI equivalents. Sets up to catch events of type EX_EVENT. When
1707 TEMPFLAG is true only the next matching event is caught after which the
1708 catch-point is deleted. If REGEX is not NULL then only exceptions whose
1709 type name matches REGEX will trigger the event. */
1711 extern void catch_exception_event (enum exception_event_kind ex_event
,
1712 const char *regex
, bool tempflag
,
1715 #endif /* !defined (BREAKPOINT_H) */