1 /* Data structures associated with breakpoints in GDB.
2 Copyright (C) 1992-2017 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19 #if !defined (BREAKPOINT_H)
20 #define BREAKPOINT_H 1
27 #include "break-common.h"
34 struct gdbpy_breakpoint_object
;
35 struct gdbscm_breakpoint_object
;
36 struct number_or_range_parser
;
40 struct linespec_result
;
43 /* Why are we removing the breakpoint from the target? */
47 /* A regular remove. Remove the breakpoint and forget everything
51 /* Detach the breakpoints from a fork child. */
55 /* This is the maximum number of bytes a breakpoint instruction can
56 take. Feel free to increase it. It's just used in a few places to
57 size arrays that should be independent of the target
60 #define BREAKPOINT_MAX 16
63 /* Type of breakpoint. */
67 bp_none
= 0, /* Eventpoint has been deleted */
68 bp_breakpoint
, /* Normal breakpoint */
69 bp_hardware_breakpoint
, /* Hardware assisted breakpoint */
70 bp_single_step
, /* Software single-step */
71 bp_until
, /* used by until command */
72 bp_finish
, /* used by finish command */
73 bp_watchpoint
, /* Watchpoint */
74 bp_hardware_watchpoint
, /* Hardware assisted watchpoint */
75 bp_read_watchpoint
, /* read watchpoint, (hardware assisted) */
76 bp_access_watchpoint
, /* access watchpoint, (hardware assisted) */
77 bp_longjmp
, /* secret breakpoint to find longjmp() */
78 bp_longjmp_resume
, /* secret breakpoint to escape longjmp() */
80 /* Breakpoint placed to the same location(s) like bp_longjmp but used to
81 protect against stale DUMMY_FRAME. Multiple bp_longjmp_call_dummy and
82 one bp_call_dummy are chained together by related_breakpoint for each
84 bp_longjmp_call_dummy
,
86 /* An internal breakpoint that is installed on the unwinder's
89 /* An internal breakpoint that is set at the point where an
90 exception will land. */
93 /* Used by wait_for_inferior for stepping over subroutine calls,
94 and for skipping prologues. */
97 /* Used by wait_for_inferior for stepping over signal
101 /* Used to detect when a watchpoint expression has gone out of
102 scope. These breakpoints are usually not visible to the user.
104 This breakpoint has some interesting properties:
106 1) There's always a 1:1 mapping between watchpoints
107 on local variables and watchpoint_scope breakpoints.
109 2) It automatically deletes itself and the watchpoint it's
110 associated with when hit.
112 3) It can never be disabled. */
115 /* The breakpoint at the end of a call dummy. See bp_longjmp_call_dummy it
116 is chained with by related_breakpoint. */
119 /* A breakpoint set on std::terminate, that is used to catch
120 otherwise uncaught exceptions thrown during an inferior call. */
123 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
124 code in the inferior to run when significant events occur in the
125 dynamic linker (for example a library is loaded or unloaded).
127 By placing a breakpoint in this magic code GDB will get control
128 when these significant events occur. GDB can then re-examine
129 the dynamic linker's data structures to discover any newly loaded
130 dynamic libraries. */
133 /* Some multi-threaded systems can arrange for a location in the
134 inferior to be executed when certain thread-related events occur
135 (such as thread creation or thread death).
137 By placing a breakpoint at one of these locations, GDB will get
138 control when these events occur. GDB can then update its thread
143 /* On the same principal, an overlay manager can arrange to call a
144 magic location in the inferior whenever there is an interesting
145 change in overlay status. GDB can update its overlay tables
146 and fiddle with breakpoints in overlays when this breakpoint
151 /* Master copies of longjmp breakpoints. These are always installed
152 as soon as an objfile containing longjmp is loaded, but they are
153 always disabled. While necessary, temporary clones of bp_longjmp
154 type will be created and enabled. */
158 /* Master copies of std::terminate breakpoints. */
159 bp_std_terminate_master
,
161 /* Like bp_longjmp_master, but for exceptions. */
168 bp_static_tracepoint
,
170 /* A dynamic printf stops at the given location, does a formatted
171 print, then automatically continues. (Although this is sort of
172 like a macro packaging up standard breakpoint functionality,
173 GDB doesn't have a way to construct types of breakpoint from
174 elements of behavior.) */
177 /* Event for JIT compiled code generation or deletion. */
180 /* Breakpoint is placed at the STT_GNU_IFUNC resolver. When hit GDB
181 inserts new bp_gnu_ifunc_resolver_return at the caller.
182 bp_gnu_ifunc_resolver is still being kept here as a different thread
183 may still hit it before bp_gnu_ifunc_resolver_return is hit by the
185 bp_gnu_ifunc_resolver
,
187 /* On its hit GDB now know the resolved address of the target
188 STT_GNU_IFUNC function. Associated bp_gnu_ifunc_resolver can be
189 deleted now and the breakpoint moved to the target function entry
191 bp_gnu_ifunc_resolver_return
,
194 /* States of enablement of breakpoint. */
198 bp_disabled
, /* The eventpoint is inactive, and cannot
200 bp_enabled
, /* The eventpoint is active, and can
202 bp_call_disabled
, /* The eventpoint has been disabled while a
203 call into the inferior is "in flight",
204 because some eventpoints interfere with
205 the implementation of a call on some
206 targets. The eventpoint will be
207 automatically enabled and reset when the
208 call "lands" (either completes, or stops
209 at another eventpoint). */
213 /* Disposition of breakpoint. Ie: what to do after hitting it. */
217 disp_del
, /* Delete it */
218 disp_del_at_next_stop
, /* Delete at next stop,
219 whether hit or not */
220 disp_disable
, /* Disable it */
221 disp_donttouch
/* Leave it alone */
224 /* Status of breakpoint conditions used when synchronizing
225 conditions with the target. */
227 enum condition_status
229 condition_unchanged
= 0,
234 /* Information used by targets to insert and remove breakpoints. */
236 struct bp_target_info
238 /* Address space at which the breakpoint was placed. */
239 struct address_space
*placed_address_space
;
241 /* Address at which the breakpoint was placed. This is normally
242 the same as REQUESTED_ADDRESS, except when adjustment happens in
243 gdbarch_breakpoint_from_pc. The most common form of adjustment
244 is stripping an alternate ISA marker from the PC which is used
245 to determine the type of breakpoint to insert. */
246 CORE_ADDR placed_address
;
248 /* Address at which the breakpoint was requested. */
249 CORE_ADDR reqstd_address
;
251 /* If this is a ranged breakpoint, then this field contains the
252 length of the range that will be watched for execution. */
255 /* If the breakpoint lives in memory and reading that memory would
256 give back the breakpoint, instead of the original contents, then
257 the original contents are cached here. Only SHADOW_LEN bytes of
258 this buffer are valid, and only when the breakpoint is inserted. */
259 gdb_byte shadow_contents
[BREAKPOINT_MAX
];
261 /* The length of the data cached in SHADOW_CONTENTS. */
264 /* The breakpoint's kind. It is used in 'kind' parameter in Z
268 /* Conditions the target should evaluate if it supports target-side
269 breakpoint conditions. These are non-owning pointers. */
270 std::vector
<agent_expr
*> conditions
;
272 /* Commands the target should evaluate if it supports target-side
273 breakpoint commands. These are non-owning pointers. */
274 std::vector
<agent_expr
*> tcommands
;
276 /* Flag that is true if the breakpoint should be left in place even
277 when GDB is not connected. */
281 /* GDB maintains two types of information about each breakpoint (or
282 watchpoint, or other related event). The first type corresponds
283 to struct breakpoint; this is a relatively high-level structure
284 which contains the source location(s), stopping conditions, user
285 commands to execute when the breakpoint is hit, and so forth.
287 The second type of information corresponds to struct bp_location.
288 Each breakpoint has one or (eventually) more locations associated
289 with it, which represent target-specific and machine-specific
290 mechanisms for stopping the program. For instance, a watchpoint
291 expression may require multiple hardware watchpoints in order to
292 catch all changes in the value of the expression being watched. */
296 bp_loc_software_breakpoint
,
297 bp_loc_hardware_breakpoint
,
298 bp_loc_hardware_watchpoint
,
299 bp_loc_other
/* Miscellaneous... */
302 /* This structure is a collection of function pointers that, if
303 available, will be called instead of performing the default action
304 for this bp_loc_type. */
306 struct bp_location_ops
308 /* Destructor. Releases everything from SELF (but not SELF
310 void (*dtor
) (struct bp_location
*self
);
316 bp_location () = default;
318 bp_location (const bp_location_ops
*ops
, breakpoint
*owner
);
320 /* Chain pointer to the next breakpoint location for
321 the same parent breakpoint. */
322 bp_location
*next
= NULL
;
324 /* Methods associated with this location. */
325 const bp_location_ops
*ops
= NULL
;
327 /* The reference count. */
330 /* Type of this breakpoint location. */
331 bp_loc_type loc_type
{};
333 /* Each breakpoint location must belong to exactly one higher-level
334 breakpoint. This pointer is NULL iff this bp_location is no
335 longer attached to a breakpoint. For example, when a breakpoint
336 is deleted, its locations may still be found in the
337 moribund_locations list, or if we had stopped for it, in
339 breakpoint
*owner
= NULL
;
341 /* Conditional. Break only if this expression's value is nonzero.
342 Unlike string form of condition, which is associated with
343 breakpoint, this is associated with location, since if breakpoint
344 has several locations, the evaluation of expression can be
345 different for different locations. Only valid for real
346 breakpoints; a watchpoint's conditional expression is stored in
347 the owner breakpoint object. */
350 /* Conditional expression in agent expression
351 bytecode form. This is used for stub-side breakpoint
352 condition evaluation. */
353 agent_expr_up cond_bytecode
;
355 /* Signals that the condition has changed since the last time
356 we updated the global location list. This means the condition
357 needs to be sent to the target again. This is used together
358 with target-side breakpoint conditions.
360 condition_unchanged: It means there has been no condition changes.
362 condition_modified: It means this location had its condition modified.
364 condition_updated: It means we already marked all the locations that are
365 duplicates of this location and thus we don't need to call
366 force_breakpoint_reinsertion (...) for this location. */
368 condition_status condition_changed
{};
370 agent_expr_up cmd_bytecode
;
372 /* Signals that breakpoint conditions and/or commands need to be
373 re-synched with the target. This has no use other than
374 target-side breakpoints. */
375 bool needs_update
= false;
377 /* This location's address is in an unloaded solib, and so this
378 location should not be inserted. It will be automatically
379 enabled when that solib is loaded. */
380 bool shlib_disabled
= false;
382 /* Is this particular location enabled. */
383 bool enabled
= false;
385 /* Nonzero if this breakpoint is now inserted. */
386 bool inserted
= false;
388 /* Nonzero if this is a permanent breakpoint. There is a breakpoint
389 instruction hard-wired into the target's code. Don't try to
390 write another breakpoint instruction on top of it, or restore its
391 value. Step over it using the architecture's
392 gdbarch_skip_permanent_breakpoint method. */
393 bool permanent
= false;
395 /* Nonzero if this is not the first breakpoint in the list
396 for the given address. location of tracepoint can _never_
397 be duplicated with other locations of tracepoints and other
398 kinds of breakpoints, because two locations at the same
399 address may have different actions, so both of these locations
400 should be downloaded and so that `tfind N' always works. */
401 bool duplicate
= false;
403 /* If we someday support real thread-specific breakpoints, then
404 the breakpoint location will need a thread identifier. */
406 /* Data for specific breakpoint types. These could be a union, but
407 simplicity is more important than memory usage for breakpoints. */
409 /* Architecture associated with this location's address. May be
410 different from the breakpoint architecture. */
411 struct gdbarch
*gdbarch
= NULL
;
413 /* The program space associated with this breakpoint location
414 address. Note that an address space may be represented in more
415 than one program space (e.g. each uClinux program will be given
416 its own program space, but there will only be one address space
417 for all of them), but we must not insert more than one location
418 at the same address in the same address space. */
419 program_space
*pspace
= NULL
;
421 /* Note that zero is a perfectly valid code address on some platforms
422 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
423 is not a special value for this field. Valid for all types except
425 CORE_ADDR address
= 0;
427 /* For hardware watchpoints, the size of the memory region being
428 watched. For hardware ranged breakpoints, the size of the
432 /* Type of hardware watchpoint. */
433 target_hw_bp_type watchpoint_type
{};
435 /* For any breakpoint type with an address, this is the section
436 associated with the address. Used primarily for overlay
438 obj_section
*section
= NULL
;
440 /* Address at which breakpoint was requested, either by the user or
441 by GDB for internal breakpoints. This will usually be the same
442 as ``address'' (above) except for cases in which
443 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
444 which to place the breakpoint in order to comply with a
445 processor's architectual constraints. */
446 CORE_ADDR requested_address
= 0;
448 /* An additional address assigned with this location. This is currently
449 only used by STT_GNU_IFUNC resolver breakpoints to hold the address
450 of the resolver function. */
451 CORE_ADDR related_address
= 0;
453 /* If the location comes from a probe point, this is the probe associated
455 bound_probe probe
{};
457 char *function_name
= NULL
;
459 /* Details of the placed breakpoint, when inserted. */
460 bp_target_info target_info
{};
462 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
463 bp_target_info overlay_target_info
{};
465 /* In a non-stop mode, it's possible that we delete a breakpoint,
466 but as we do that, some still running thread hits that breakpoint.
467 For that reason, we need to keep locations belonging to deleted
468 breakpoints for a bit, so that don't report unexpected SIGTRAP.
469 We can't keep such locations forever, so we use a heuristic --
470 after we process certain number of inferior events since
471 breakpoint was deleted, we retire all locations of that breakpoint.
472 This variable keeps a number of events still to go, when
473 it becomes 0 this location is retired. */
474 int events_till_retirement
= 0;
476 /* Line number which was used to place this location.
478 Breakpoint placed into a comment keeps it's user specified line number
479 despite ADDRESS resolves into a different line number. */
483 /* Symtab which was used to place this location. This is used
484 to find the corresponding source file name. */
486 struct symtab
*symtab
= NULL
;
489 /* The possible return values for print_bpstat, print_it_normal,
490 print_it_done, print_it_noop. */
491 enum print_stop_action
493 /* We printed nothing or we need to do some more analysis. */
496 /* We printed something, and we *do* desire that something to be
497 followed by a location. */
500 /* We printed something, and we do *not* desire that something to be
501 followed by a location. */
504 /* We already printed all we needed to print, don't print anything
509 /* This structure is a collection of function pointers that, if available,
510 will be called instead of the performing the default action for this
513 struct breakpoint_ops
515 /* Allocate a location for this breakpoint. */
516 struct bp_location
* (*allocate_location
) (struct breakpoint
*);
518 /* Reevaluate a breakpoint. This is necessary after symbols change
519 (e.g., an executable or DSO was loaded, or the inferior just
521 void (*re_set
) (struct breakpoint
*self
);
523 /* Insert the breakpoint or watchpoint or activate the catchpoint.
524 Return 0 for success, 1 if the breakpoint, watchpoint or
525 catchpoint type is not supported, -1 for failure. */
526 int (*insert_location
) (struct bp_location
*);
528 /* Remove the breakpoint/catchpoint that was previously inserted
529 with the "insert" method above. Return 0 for success, 1 if the
530 breakpoint, watchpoint or catchpoint type is not supported,
532 int (*remove_location
) (struct bp_location
*, enum remove_bp_reason reason
);
534 /* Return true if it the target has stopped due to hitting
535 breakpoint location BL. This function does not check if we
536 should stop, only if BL explains the stop. ASPACE is the address
537 space in which the event occurred, BP_ADDR is the address at
538 which the inferior stopped, and WS is the target_waitstatus
539 describing the event. */
540 int (*breakpoint_hit
) (const struct bp_location
*bl
,
541 struct address_space
*aspace
,
543 const struct target_waitstatus
*ws
);
545 /* Check internal conditions of the breakpoint referred to by BS.
546 If we should not stop for this breakpoint, set BS->stop to 0. */
547 void (*check_status
) (struct bpstats
*bs
);
549 /* Tell how many hardware resources (debug registers) are needed
550 for this breakpoint. If this function is not provided, then
551 the breakpoint or watchpoint needs one debug register. */
552 int (*resources_needed
) (const struct bp_location
*);
554 /* Tell whether we can downgrade from a hardware watchpoint to a software
555 one. If not, the user will not be able to enable the watchpoint when
556 there are not enough hardware resources available. */
557 int (*works_in_software_mode
) (const struct breakpoint
*);
559 /* The normal print routine for this breakpoint, called when we
561 enum print_stop_action (*print_it
) (struct bpstats
*bs
);
563 /* Display information about this breakpoint, for "info
565 void (*print_one
) (struct breakpoint
*, struct bp_location
**);
567 /* Display extra information about this breakpoint, below the normal
568 breakpoint description in "info breakpoints".
570 In the example below, the "address range" line was printed
571 by print_one_detail_ranged_breakpoint.
573 (gdb) info breakpoints
574 Num Type Disp Enb Address What
575 2 hw breakpoint keep y in main at test-watch.c:70
576 address range: [0x10000458, 0x100004c7]
579 void (*print_one_detail
) (const struct breakpoint
*, struct ui_out
*);
581 /* Display information about this breakpoint after setting it
582 (roughly speaking; this is called from "mention"). */
583 void (*print_mention
) (struct breakpoint
*);
585 /* Print to FP the CLI command that recreates this breakpoint. */
586 void (*print_recreate
) (struct breakpoint
*, struct ui_file
*fp
);
588 /* Create SALs from location, storing the result in linespec_result.
590 For an explanation about the arguments, see the function
591 `create_sals_from_location_default'.
593 This function is called inside `create_breakpoint'. */
594 void (*create_sals_from_location
) (const struct event_location
*location
,
595 struct linespec_result
*canonical
,
596 enum bptype type_wanted
);
598 /* This method will be responsible for creating a breakpoint given its SALs.
599 Usually, it just calls `create_breakpoints_sal' (for ordinary
600 breakpoints). However, there may be some special cases where we might
601 need to do some tweaks, e.g., see
602 `strace_marker_create_breakpoints_sal'.
604 This function is called inside `create_breakpoint'. */
605 void (*create_breakpoints_sal
) (struct gdbarch
*,
606 struct linespec_result
*,
607 gdb::unique_xmalloc_ptr
<char>,
608 gdb::unique_xmalloc_ptr
<char>,
609 enum bptype
, enum bpdisp
, int, int,
610 int, const struct breakpoint_ops
*,
611 int, int, int, unsigned);
613 /* Given the location (second parameter), this method decodes it and
614 provides the SAL locations related to it. For ordinary
615 breakpoints, it calls `decode_line_full'. If SEARCH_PSPACE is
616 not NULL, symbol search is restricted to just that program space.
618 This function is called inside `location_to_sals'. */
619 void (*decode_location
) (struct breakpoint
*b
,
620 const struct event_location
*location
,
621 struct program_space
*search_pspace
,
622 struct symtabs_and_lines
*sals
);
624 /* Return true if this breakpoint explains a signal. See
625 bpstat_explains_signal. */
626 int (*explains_signal
) (struct breakpoint
*, enum gdb_signal
);
628 /* Called after evaluating the breakpoint's condition,
629 and only if it evaluated true. */
630 void (*after_condition_true
) (struct bpstats
*bs
);
633 /* Helper for breakpoint_ops->print_recreate implementations. Prints
634 the "thread" or "task" condition of B, and then a newline.
636 Necessary because most breakpoint implementations accept
637 thread/task conditions at the end of the spec line, like "break foo
638 thread 1", which needs outputting before any breakpoint-type
639 specific extra command necessary for B's recreation. */
640 extern void print_recreate_thread (struct breakpoint
*b
, struct ui_file
*fp
);
642 enum watchpoint_triggered
644 /* This watchpoint definitely did not trigger. */
645 watch_triggered_no
= 0,
647 /* Some hardware watchpoint triggered, and it might have been this
648 one, but we do not know which it was. */
649 watch_triggered_unknown
,
651 /* This hardware watchpoint definitely did trigger. */
655 typedef struct bp_location
*bp_location_p
;
656 DEF_VEC_P(bp_location_p
);
658 /* A reference-counted struct command_line. This lets multiple
659 breakpoints share a single command list. This is an implementation
660 detail to the breakpoints module. */
661 struct counted_command_line
;
663 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
664 a watchpoint over a memory region. If this flag is true, GDB will use
665 only one register per watchpoint, thus assuming that all acesses that
666 modify a memory location happen at its starting address. */
668 extern int target_exact_watchpoints
;
670 /* Note that the ->silent field is not currently used by any commands
671 (though the code is in there if it was to be, and set_raw_breakpoint
672 does set it to 0). I implemented it because I thought it would be
673 useful for a hack I had to put in; I'm going to leave it in because
674 I can see how there might be times when it would indeed be useful */
676 /* This is for all kinds of breakpoints. */
680 virtual ~breakpoint ();
682 /* Methods associated with this breakpoint. */
683 const breakpoint_ops
*ops
= NULL
;
685 breakpoint
*next
= NULL
;
686 /* Type of breakpoint. */
687 bptype type
= bp_none
;
688 /* Zero means disabled; remember the info but don't break here. */
689 enum enable_state enable_state
= bp_enabled
;
690 /* What to do with this breakpoint after we hit it. */
691 bpdisp disposition
= disp_del
;
692 /* Number assigned to distinguish breakpoints. */
695 /* Location(s) associated with this high-level breakpoint. */
696 bp_location
*loc
= NULL
;
698 /* True means a silent breakpoint (don't print frame info if we stop
701 /* True means display ADDR_STRING to the user verbatim. */
702 bool display_canonical
= false;
703 /* Number of stops at this breakpoint that should be continued
704 automatically before really stopping. */
705 int ignore_count
= 0;
707 /* Number of stops at this breakpoint before it will be
709 int enable_count
= 0;
711 /* Chain of command lines to execute when this breakpoint is
713 counted_command_line
*commands
= NULL
;
714 /* Stack depth (address of frame). If nonzero, break only if fp
716 struct frame_id frame_id
= null_frame_id
;
718 /* The program space used to set the breakpoint. This is only set
719 for breakpoints which are specific to a program space; for
720 non-thread-specific ordinary breakpoints this is NULL. */
721 program_space
*pspace
= NULL
;
723 /* Location we used to set the breakpoint. */
724 event_location_up location
;
726 /* The filter that should be passed to decode_line_full when
727 re-setting this breakpoint. This may be NULL, but otherwise is
728 allocated with xmalloc. */
731 /* For a ranged breakpoint, the location we used to find the end of
733 event_location_up location_range_end
;
735 /* Architecture we used to set the breakpoint. */
736 struct gdbarch
*gdbarch
= NULL
;
737 /* Language we used to set the breakpoint. */
738 enum language language
= language_unknown
;
739 /* Input radix we used to set the breakpoint. */
741 /* String form of the breakpoint condition (malloc'd), or NULL if
742 there is no condition. */
743 char *cond_string
= NULL
;
745 /* String form of extra parameters, or NULL if there are none.
747 char *extra_string
= NULL
;
749 /* Holds the address of the related watchpoint_scope breakpoint when
750 using watchpoints on local variables (might the concept of a
751 related breakpoint be useful elsewhere, if not just call it the
752 watchpoint_scope breakpoint or something like that. FIXME). */
753 breakpoint
*related_breakpoint
= NULL
;
755 /* Thread number for thread-specific breakpoint, or -1 if don't
759 /* Ada task number for task-specific breakpoint, or 0 if don't
763 /* Count of the number of times this breakpoint was taken, dumped
764 with the info, but not used for anything else. Useful for seeing
765 how many times you hit a break prior to the program aborting, so
766 you can back up to just before the abort. */
769 /* Is breakpoint's condition not yet parsed because we found no
770 location initially so had no context to parse the condition
772 int condition_not_parsed
= 0;
774 /* With a Python scripting enabled GDB, store a reference to the
775 Python object that has been associated with this breakpoint.
776 This is always NULL for a GDB that is not script enabled. It can
777 sometimes be NULL for enabled GDBs as not all breakpoint types
778 are tracked by the scripting language API. */
779 gdbpy_breakpoint_object
*py_bp_object
= NULL
;
781 /* Same as py_bp_object, but for Scheme. */
782 gdbscm_breakpoint_object
*scm_bp_object
= NULL
;
785 /* An instance of this type is used to represent a watchpoint. */
787 struct watchpoint
: public breakpoint
789 ~watchpoint () override
;
791 /* String form of exp to use for displaying to the user (malloc'd),
794 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
795 char *exp_string_reparse
;
797 /* The expression we are watching, or NULL if not a watchpoint. */
799 /* The largest block within which it is valid, or NULL if it is
800 valid anywhere (e.g. consists just of global symbols). */
801 const struct block
*exp_valid_block
;
802 /* The conditional expression if any. */
803 expression_up cond_exp
;
804 /* The largest block within which it is valid, or NULL if it is
805 valid anywhere (e.g. consists just of global symbols). */
806 const struct block
*cond_exp_valid_block
;
807 /* Value of the watchpoint the last time we checked it, or NULL when
808 we do not know the value yet or the value was not readable. VAL
811 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
812 then an error occurred reading the value. */
815 /* When watching the location of a bitfield, contains the offset and size of
816 the bitfield. Otherwise contains 0. */
820 /* Holds the frame address which identifies the frame this
821 watchpoint should be evaluated in, or `null' if the watchpoint
822 should be evaluated on the outermost frame. */
823 struct frame_id watchpoint_frame
;
825 /* Holds the thread which identifies the frame this watchpoint
826 should be considered in scope for, or `null_ptid' if the
827 watchpoint should be evaluated in all threads. */
828 ptid_t watchpoint_thread
;
830 /* For hardware watchpoints, the triggered status according to the
832 enum watchpoint_triggered watchpoint_triggered
;
834 /* Whether this watchpoint is exact (see
835 target_exact_watchpoints). */
838 /* The mask address for a masked hardware watchpoint. */
839 CORE_ADDR hw_wp_mask
;
842 /* Given a function FUNC (struct breakpoint *B, void *DATA) and
843 USER_DATA, call FUNC for every known breakpoint passing USER_DATA
846 If FUNC returns 1, the loop stops and the current
847 'struct breakpoint' being processed is returned. If FUNC returns
848 zero, the loop continues.
850 This function returns either a 'struct breakpoint' pointer or NULL.
851 It was based on BFD's bfd_sections_find_if function. */
853 extern struct breakpoint
*breakpoint_find_if
854 (int (*func
) (struct breakpoint
*b
, void *d
), void *user_data
);
856 /* Return true if BPT is either a software breakpoint or a hardware
859 extern int is_breakpoint (const struct breakpoint
*bpt
);
861 /* Returns true if BPT is really a watchpoint. */
863 extern int is_watchpoint (const struct breakpoint
*bpt
);
865 /* An instance of this type is used to represent all kinds of
868 struct tracepoint
: public breakpoint
870 /* Number of times this tracepoint should single-step and collect
874 /* Number of times this tracepoint should be hit before
878 /* The number of the tracepoint on the target. */
879 int number_on_target
;
881 /* The total space taken by all the trace frames for this
883 ULONGEST traceframe_usage
;
885 /* The static tracepoint marker id, if known. */
886 char *static_trace_marker_id
;
888 /* LTTng/UST allow more than one marker with the same ID string,
889 although it unadvised because it confuses tools. When setting
890 static tracepoints by marker ID, this will record the index in
891 the array of markers we found for the given marker ID for which
892 this static tracepoint corresponds. When resetting breakpoints,
893 we will use this index to try to find the same marker again. */
894 int static_trace_marker_id_idx
;
897 typedef struct breakpoint
*breakpoint_p
;
898 DEF_VEC_P(breakpoint_p
);
900 /* The following stuff is an abstract data type "bpstat" ("breakpoint
901 status"). This provides the ability to determine whether we have
902 stopped at a breakpoint, and what we should do about it. */
904 typedef struct bpstats
*bpstat
;
906 /* Clears a chain of bpstat, freeing storage
908 extern void bpstat_clear (bpstat
*);
910 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
911 is part of the bpstat is copied as well. */
912 extern bpstat
bpstat_copy (bpstat
);
914 extern bpstat
bpstat_stop_status (struct address_space
*aspace
,
915 CORE_ADDR pc
, ptid_t ptid
,
916 const struct target_waitstatus
*ws
);
918 /* This bpstat_what stuff tells wait_for_inferior what to do with a
919 breakpoint (a challenging task).
921 The enum values order defines priority-like order of the actions.
922 Once you've decided that some action is appropriate, you'll never
923 go back and decide something of a lower priority is better. Each
924 of these actions is mutually exclusive with the others. That
925 means, that if you find yourself adding a new action class here and
926 wanting to tell GDB that you have two simultaneous actions to
927 handle, something is wrong, and you probably don't actually need a
930 Note that a step resume breakpoint overrides another breakpoint of
931 signal handling (see comment in wait_for_inferior at where we set
932 the step_resume breakpoint). */
934 enum bpstat_what_main_action
936 /* Perform various other tests; that is, this bpstat does not
937 say to perform any action (e.g. failed watchpoint and nothing
939 BPSTAT_WHAT_KEEP_CHECKING
,
941 /* Remove breakpoints, single step once, then put them back in and
942 go back to what we were doing. It's possible that this should
943 be removed from the main_action and put into a separate field,
944 to more cleanly handle
945 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
948 /* Set longjmp_resume breakpoint, remove all other breakpoints,
949 and continue. The "remove all other breakpoints" part is
950 required if we are also stepping over another breakpoint as
951 well as doing the longjmp handling. */
952 BPSTAT_WHAT_SET_LONGJMP_RESUME
,
954 /* Clear longjmp_resume breakpoint, then handle as
955 BPSTAT_WHAT_KEEP_CHECKING. */
956 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME
,
958 /* Clear step resume breakpoint, and keep checking. */
959 BPSTAT_WHAT_STEP_RESUME
,
961 /* Rather than distinguish between noisy and silent stops here, it
962 might be cleaner to have bpstat_print make that decision (also
963 taking into account stop_print_frame and source_only). But the
964 implications are a bit scary (interaction with auto-displays,
965 etc.), so I won't try it. */
968 BPSTAT_WHAT_STOP_SILENT
,
970 /* Stop and print. */
971 BPSTAT_WHAT_STOP_NOISY
,
973 /* Clear step resume breakpoint, and keep checking. High-priority
974 step-resume breakpoints are used when even if there's a user
975 breakpoint at the current PC when we set the step-resume
976 breakpoint, we don't want to re-handle any breakpoint other
977 than the step-resume when it's hit; instead we want to move
978 past the breakpoint. This is used in the case of skipping
980 BPSTAT_WHAT_HP_STEP_RESUME
,
983 /* An enum indicating the kind of "stack dummy" stop. This is a bit
984 of a misnomer because only one kind of truly a stack dummy. */
987 /* We didn't stop at a stack dummy breakpoint. */
990 /* Stopped at a stack dummy. */
993 /* Stopped at std::terminate. */
999 enum bpstat_what_main_action main_action
;
1001 /* Did we hit a call dummy breakpoint? This only goes with a
1002 main_action of BPSTAT_WHAT_STOP_SILENT or
1003 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
1004 dummy without popping the frame is not a useful one). */
1005 enum stop_stack_kind call_dummy
;
1007 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
1008 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
1009 longjmp, false if we are handling an exception. */
1013 /* Tell what to do about this bpstat. */
1014 struct bpstat_what
bpstat_what (bpstat
);
1016 /* Run breakpoint event callbacks associated with the breakpoints that
1018 extern void bpstat_run_callbacks (bpstat bs_head
);
1020 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
1021 bpstat
bpstat_find_breakpoint (bpstat
, struct breakpoint
*);
1023 /* Nonzero if a signal that we got in target_wait() was due to
1024 circumstances explained by the bpstat; the signal is therefore not
1026 extern int bpstat_explains_signal (bpstat
, enum gdb_signal
);
1028 /* Nonzero is this bpstat causes a stop. */
1029 extern int bpstat_causes_stop (bpstat
);
1031 /* Nonzero if we should step constantly (e.g. watchpoints on machines
1032 without hardware support). This isn't related to a specific bpstat,
1033 just to things like whether watchpoints are set. */
1034 extern int bpstat_should_step (void);
1036 /* Print a message indicating what happened. Returns nonzero to
1037 say that only the source line should be printed after this (zero
1038 return means print the frame as well as the source line). */
1039 extern enum print_stop_action
bpstat_print (bpstat
, int);
1041 /* Put in *NUM the breakpoint number of the first breakpoint we are
1042 stopped at. *BSP upon return is a bpstat which points to the
1043 remaining breakpoints stopped at (but which is not guaranteed to be
1044 good for anything but further calls to bpstat_num).
1046 Return 0 if passed a bpstat which does not indicate any breakpoints.
1047 Return -1 if stopped at a breakpoint that has been deleted since
1049 Return 1 otherwise. */
1050 extern int bpstat_num (bpstat
*, int *);
1052 /* Perform actions associated with the stopped inferior. Actually, we
1053 just use this for breakpoint commands. Perhaps other actions will
1054 go here later, but this is executed at a late time (from the
1056 extern void bpstat_do_actions (void);
1058 /* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will
1059 not be performed. */
1060 extern void bpstat_clear_actions (void);
1062 /* Implementation: */
1064 /* Values used to tell the printing routine how to behave for this
1068 /* This is used when we want to do a normal printing of the reason
1069 for stopping. The output will depend on the type of eventpoint
1070 we are dealing with. This is the default value, most commonly
1073 /* This is used when nothing should be printed for this bpstat
1076 /* This is used when everything which needs to be printed has
1077 already been printed. But we still want to print the frame. */
1083 /* Linked list because there can be more than one breakpoint at
1084 the same place, and a bpstat reflects the fact that all have
1088 /* Location that caused the stop. Locations are refcounted, so
1089 this will never be NULL. Note that this location may end up
1090 detached from a breakpoint, but that does not necessary mean
1091 that the struct breakpoint is gone. E.g., consider a
1092 watchpoint with a condition that involves an inferior function
1093 call. Watchpoint locations are recreated often (on resumes,
1094 hence on infcalls too). Between creating the bpstat and after
1095 evaluating the watchpoint condition, this location may hence
1096 end up detached from its original owner watchpoint, even though
1097 the watchpoint is still listed. If it's condition evaluates as
1098 true, we still want this location to cause a stop, and we will
1099 still need to know which watchpoint it was originally attached.
1100 What this means is that we should not (in most cases) follow
1101 the `bpstat->bp_location->owner' link, but instead use the
1102 `breakpoint_at' field below. */
1103 struct bp_location
*bp_location_at
;
1105 /* Breakpoint that caused the stop. This is nullified if the
1106 breakpoint ends up being deleted. See comments on
1107 `bp_location_at' above for why do we need this field instead of
1108 following the location's owner. */
1109 struct breakpoint
*breakpoint_at
;
1111 /* The associated command list. */
1112 struct counted_command_line
*commands
;
1114 /* Old value associated with a watchpoint. */
1115 struct value
*old_val
;
1117 /* Nonzero if this breakpoint tells us to print the frame. */
1120 /* Nonzero if this breakpoint tells us to stop. */
1123 /* Tell bpstat_print and print_bp_stop_message how to print stuff
1124 associated with this element of the bpstat chain. */
1125 enum bp_print_how print_it
;
1136 /* The possible return values for breakpoint_here_p.
1137 We guarantee that zero always means "no breakpoint here". */
1138 enum breakpoint_here
1140 no_breakpoint_here
= 0,
1141 ordinary_breakpoint_here
,
1142 permanent_breakpoint_here
1146 /* Prototypes for breakpoint-related functions. */
1148 /* Return 1 if there's a program/permanent breakpoint planted in
1149 memory at ADDRESS, return 0 otherwise. */
1151 extern int program_breakpoint_here_p (struct gdbarch
*gdbarch
, CORE_ADDR address
);
1153 extern enum breakpoint_here
breakpoint_here_p (struct address_space
*,
1156 /* Return true if an enabled breakpoint exists in the range defined by
1157 ADDR and LEN, in ASPACE. */
1158 extern int breakpoint_in_range_p (struct address_space
*aspace
,
1159 CORE_ADDR addr
, ULONGEST len
);
1161 extern int moribund_breakpoint_here_p (struct address_space
*, CORE_ADDR
);
1163 extern int breakpoint_inserted_here_p (struct address_space
*, CORE_ADDR
);
1165 extern int regular_breakpoint_inserted_here_p (struct address_space
*,
1168 extern int software_breakpoint_inserted_here_p (struct address_space
*,
1171 /* Return non-zero iff there is a hardware breakpoint inserted at
1173 extern int hardware_breakpoint_inserted_here_p (struct address_space
*,
1176 /* Check whether any location of BP is inserted at PC. */
1178 extern int breakpoint_has_location_inserted_here (struct breakpoint
*bp
,
1179 struct address_space
*aspace
,
1182 extern int single_step_breakpoint_inserted_here_p (struct address_space
*,
1185 /* Returns true if there's a hardware watchpoint or access watchpoint
1186 inserted in the range defined by ADDR and LEN. */
1187 extern int hardware_watchpoint_inserted_in_range (struct address_space
*,
1191 /* Returns true if {ASPACE1,ADDR1} and {ASPACE2,ADDR2} represent the
1192 same breakpoint location. In most targets, this can only be true
1193 if ASPACE1 matches ASPACE2. On targets that have global
1194 breakpoints, the address space doesn't really matter. */
1196 extern int breakpoint_address_match (struct address_space
*aspace1
,
1198 struct address_space
*aspace2
,
1201 extern void until_break_command (char *, int, int);
1203 /* Initialize a struct bp_location. */
1205 extern void update_breakpoint_locations (struct breakpoint
*b
,
1206 struct program_space
*filter_pspace
,
1207 struct symtabs_and_lines sals
,
1208 struct symtabs_and_lines sals_end
);
1210 extern void breakpoint_re_set (void);
1212 extern void breakpoint_re_set_thread (struct breakpoint
*);
1214 extern struct breakpoint
*set_momentary_breakpoint
1215 (struct gdbarch
*, struct symtab_and_line
, struct frame_id
, enum bptype
);
1217 extern struct breakpoint
*set_momentary_breakpoint_at_pc
1218 (struct gdbarch
*, CORE_ADDR pc
, enum bptype type
);
1220 extern struct breakpoint
*clone_momentary_breakpoint (struct breakpoint
*bpkt
);
1222 extern void set_ignore_count (int, int, int);
1224 extern void breakpoint_init_inferior (enum inf_context
);
1226 extern struct cleanup
*make_cleanup_delete_breakpoint (struct breakpoint
*);
1228 extern void delete_breakpoint (struct breakpoint
*);
1230 extern void breakpoint_auto_delete (bpstat
);
1232 typedef void (*walk_bp_location_callback
) (struct bp_location
*, void *);
1234 extern void iterate_over_bp_locations (walk_bp_location_callback
);
1236 /* Return the chain of command lines to execute when this breakpoint
1238 extern struct command_line
*breakpoint_commands (struct breakpoint
*b
);
1240 /* Return a string image of DISP. The string is static, and thus should
1241 NOT be deallocated after use. */
1242 const char *bpdisp_text (enum bpdisp disp
);
1244 extern void break_command (char *, int);
1246 extern void hbreak_command_wrapper (char *, int);
1247 extern void thbreak_command_wrapper (char *, int);
1248 extern void rbreak_command_wrapper (char *, int);
1249 extern void watch_command_wrapper (char *, int, int);
1250 extern void awatch_command_wrapper (char *, int, int);
1251 extern void rwatch_command_wrapper (char *, int, int);
1252 extern void tbreak_command (char *, int);
1254 extern struct breakpoint_ops base_breakpoint_ops
;
1255 extern struct breakpoint_ops bkpt_breakpoint_ops
;
1256 extern struct breakpoint_ops tracepoint_breakpoint_ops
;
1257 extern struct breakpoint_ops dprintf_breakpoint_ops
;
1259 extern void initialize_breakpoint_ops (void);
1261 /* Arguments to pass as context to some catch command handlers. */
1262 #define CATCH_PERMANENT ((void *) (uintptr_t) 0)
1263 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
1265 /* Like add_cmd, but add the command to both the "catch" and "tcatch"
1266 lists, and pass some additional user data to the command
1270 add_catch_command (const char *name
, const char *docstring
,
1271 cmd_sfunc_ftype
*sfunc
,
1272 completer_ftype
*completer
,
1273 void *user_data_catch
,
1274 void *user_data_tcatch
);
1276 /* Initialize a breakpoint struct for Ada exception catchpoints. */
1279 init_ada_exception_breakpoint (struct breakpoint
*b
,
1280 struct gdbarch
*gdbarch
,
1281 struct symtab_and_line sal
,
1283 const struct breakpoint_ops
*ops
,
1288 extern void init_catchpoint (struct breakpoint
*b
,
1289 struct gdbarch
*gdbarch
, int tempflag
,
1290 const char *cond_string
,
1291 const struct breakpoint_ops
*ops
);
1293 /* Add breakpoint B on the breakpoint list, and notify the user, the
1294 target and breakpoint_created observers of its existence. If
1295 INTERNAL is non-zero, the breakpoint number will be allocated from
1296 the internal breakpoint count. If UPDATE_GLL is non-zero,
1297 update_global_location_list will be called. */
1299 extern void install_breakpoint (int internal
, std::unique_ptr
<breakpoint
> &&b
,
1302 /* Flags that can be passed down to create_breakpoint, etc., to affect
1303 breakpoint creation in several ways. */
1305 enum breakpoint_create_flags
1307 /* We're adding a breakpoint to our tables that is already
1308 inserted in the target. */
1309 CREATE_BREAKPOINT_FLAGS_INSERTED
= 1 << 0
1312 /* Set a breakpoint. This function is shared between CLI and MI functions
1313 for setting a breakpoint at LOCATION.
1315 This function has two major modes of operations, selected by the
1316 PARSE_EXTRA parameter.
1318 If PARSE_EXTRA is zero, LOCATION is just the breakpoint's location,
1319 with condition, thread, and extra string specified by the COND_STRING,
1320 THREAD, and EXTRA_STRING parameters.
1322 If PARSE_EXTRA is non-zero, this function will attempt to extract
1323 the condition, thread, and extra string from EXTRA_STRING, ignoring
1324 the similarly named parameters.
1326 If INTERNAL is non-zero, the breakpoint number will be allocated
1327 from the internal breakpoint count.
1329 Returns true if any breakpoint was created; false otherwise. */
1331 extern int create_breakpoint (struct gdbarch
*gdbarch
,
1332 const struct event_location
*location
,
1333 const char *cond_string
, int thread
,
1334 const char *extra_string
,
1336 int tempflag
, enum bptype wanted_type
,
1338 enum auto_boolean pending_break_support
,
1339 const struct breakpoint_ops
*ops
,
1342 int internal
, unsigned flags
);
1344 extern void insert_breakpoints (void);
1346 extern int remove_breakpoints (void);
1348 extern int remove_breakpoints_pid (int pid
);
1350 /* This function can be used to physically insert eventpoints from the
1351 specified traced inferior process, without modifying the breakpoint
1352 package's state. This can be useful for those targets which
1353 support following the processes of a fork() or vfork() system call,
1354 when both of the resulting two processes are to be followed. */
1355 extern int reattach_breakpoints (int);
1357 /* This function can be used to update the breakpoint package's state
1358 after an exec() system call has been executed.
1360 This function causes the following:
1362 - All eventpoints are marked "not inserted".
1363 - All eventpoints with a symbolic address are reset such that
1364 the symbolic address must be reevaluated before the eventpoints
1366 - The solib breakpoints are explicitly removed from the breakpoint
1368 - A step-resume breakpoint, if any, is explicitly removed from the
1370 - All eventpoints without a symbolic address are removed from the
1372 extern void update_breakpoints_after_exec (void);
1374 /* This function can be used to physically remove hardware breakpoints
1375 and watchpoints from the specified traced inferior process, without
1376 modifying the breakpoint package's state. This can be useful for
1377 those targets which support following the processes of a fork() or
1378 vfork() system call, when one of the resulting two processes is to
1379 be detached and allowed to run free.
1381 It is an error to use this function on the process whose id is
1383 extern int detach_breakpoints (ptid_t ptid
);
1385 /* This function is called when program space PSPACE is about to be
1386 deleted. It takes care of updating breakpoints to not reference
1387 this PSPACE anymore. */
1388 extern void breakpoint_program_space_exit (struct program_space
*pspace
);
1390 extern void set_longjmp_breakpoint (struct thread_info
*tp
,
1391 struct frame_id frame
);
1392 extern void delete_longjmp_breakpoint (int thread
);
1394 /* Mark all longjmp breakpoints from THREAD for later deletion. */
1395 extern void delete_longjmp_breakpoint_at_next_stop (int thread
);
1397 extern struct breakpoint
*set_longjmp_breakpoint_for_call_dummy (void);
1398 extern void check_longjmp_breakpoint_for_call_dummy (struct thread_info
*tp
);
1400 extern void enable_overlay_breakpoints (void);
1401 extern void disable_overlay_breakpoints (void);
1403 extern void set_std_terminate_breakpoint (void);
1404 extern void delete_std_terminate_breakpoint (void);
1406 /* These functions respectively disable or reenable all currently
1407 enabled watchpoints. When disabled, the watchpoints are marked
1408 call_disabled. When re-enabled, they are marked enabled.
1410 The intended client of these functions is call_function_by_hand.
1412 The inferior must be stopped, and all breakpoints removed, when
1413 these functions are used.
1415 The need for these functions is that on some targets (e.g., HP-UX),
1416 gdb is unable to unwind through the dummy frame that is pushed as
1417 part of the implementation of a call command. Watchpoints can
1418 cause the inferior to stop in places where this frame is visible,
1419 and that can cause execution control to become very confused.
1421 Note that if a user sets breakpoints in an interactively called
1422 function, the call_disabled watchpoints will have been re-enabled
1423 when the first such breakpoint is reached. However, on targets
1424 that are unable to unwind through the call dummy frame, watches
1425 of stack-based storage may then be deleted, because gdb will
1426 believe that their watched storage is out of scope. (Sigh.) */
1427 extern void disable_watchpoints_before_interactive_call_start (void);
1429 extern void enable_watchpoints_after_interactive_call_stop (void);
1431 /* These functions disable and re-enable all breakpoints during
1432 inferior startup. They are intended to be called from solib
1433 code where necessary. This is needed on platforms where the
1434 main executable is relocated at some point during startup
1435 processing, making breakpoint addresses invalid.
1437 If additional breakpoints are created after the routine
1438 disable_breakpoints_before_startup but before the routine
1439 enable_breakpoints_after_startup was called, they will also
1440 be marked as disabled. */
1441 extern void disable_breakpoints_before_startup (void);
1442 extern void enable_breakpoints_after_startup (void);
1444 /* For script interpreters that need to define breakpoint commands
1445 after they've already read the commands into a struct
1447 extern enum command_control_type commands_from_control_command
1448 (const char *arg
, struct command_line
*cmd
);
1450 extern void clear_breakpoint_hit_counts (void);
1452 extern struct breakpoint
*get_breakpoint (int num
);
1454 /* The following are for displays, which aren't really breakpoints,
1455 but here is as good a place as any for them. */
1457 extern void disable_current_display (void);
1459 extern void do_displays (void);
1461 extern void disable_display (int);
1463 extern void clear_displays (void);
1465 extern void disable_breakpoint (struct breakpoint
*);
1467 extern void enable_breakpoint (struct breakpoint
*);
1469 extern void breakpoint_set_commands (struct breakpoint
*b
,
1470 command_line_up
&&commands
);
1472 extern void breakpoint_set_silent (struct breakpoint
*b
, int silent
);
1474 extern void breakpoint_set_thread (struct breakpoint
*b
, int thread
);
1476 extern void breakpoint_set_task (struct breakpoint
*b
, int task
);
1478 /* Clear the "inserted" flag in all breakpoints. */
1479 extern void mark_breakpoints_out (void);
1481 extern struct breakpoint
*create_jit_event_breakpoint (struct gdbarch
*,
1484 extern struct breakpoint
*create_solib_event_breakpoint (struct gdbarch
*,
1487 /* Create an solib event breakpoint at ADDRESS in the current program
1488 space, and immediately try to insert it. Returns a pointer to the
1489 breakpoint on success. Deletes the new breakpoint and returns NULL
1490 if inserting the breakpoint fails. */
1491 extern struct breakpoint
*create_and_insert_solib_event_breakpoint
1492 (struct gdbarch
*gdbarch
, CORE_ADDR address
);
1494 extern struct breakpoint
*create_thread_event_breakpoint (struct gdbarch
*,
1497 extern void remove_jit_event_breakpoints (void);
1499 extern void remove_solib_event_breakpoints (void);
1501 /* Mark solib event breakpoints of the current program space with
1502 delete at next stop disposition. */
1503 extern void remove_solib_event_breakpoints_at_next_stop (void);
1505 extern void disable_breakpoints_in_shlibs (void);
1507 /* This function returns TRUE if ep is a catchpoint. */
1508 extern int is_catchpoint (struct breakpoint
*);
1510 /* Shared helper function (MI and CLI) for creating and installing
1511 a shared object event catchpoint. */
1512 extern void add_solib_catchpoint (const char *arg
, int is_load
, int is_temp
,
1515 /* Enable breakpoints and delete when hit. Called with ARG == NULL
1516 deletes all breakpoints. */
1517 extern void delete_command (char *arg
, int from_tty
);
1519 /* Create and insert a new software single step breakpoint for the
1520 current thread. May be called multiple times; each time will add a
1521 new location to the set of potential addresses the next instruction
1523 extern void insert_single_step_breakpoint (struct gdbarch
*,
1524 struct address_space
*,
1527 /* Insert all software single step breakpoints for the current frame.
1528 Return true if any software single step breakpoints are inserted,
1529 otherwise, return false. */
1530 extern int insert_single_step_breakpoints (struct gdbarch
*);
1532 /* Check if any hardware watchpoints have triggered, according to the
1534 int watchpoints_triggered (struct target_waitstatus
*);
1536 /* Helper for transparent breakpoint hiding for memory read and write
1539 Update one of READBUF or WRITEBUF with either the shadows
1540 (READBUF), or the breakpoint instructions (WRITEBUF) of inserted
1541 breakpoints at the memory range defined by MEMADDR and extending
1542 for LEN bytes. If writing, then WRITEBUF is a copy of WRITEBUF_ORG
1544 extern void breakpoint_xfer_memory (gdb_byte
*readbuf
, gdb_byte
*writebuf
,
1545 const gdb_byte
*writebuf_org
,
1546 ULONGEST memaddr
, LONGEST len
);
1548 /* Return true if breakpoints should be inserted now. That'll be the
1551 - the target has global breakpoints.
1553 - "breakpoint always-inserted" is on, and the target has
1556 - threads are executing.
1558 extern int breakpoints_should_be_inserted_now (void);
1560 /* Called each time new event from target is processed.
1561 Retires previously deleted breakpoint locations that
1562 in our opinion won't ever trigger. */
1563 extern void breakpoint_retire_moribund (void);
1565 /* Set break condition of breakpoint B to EXP. */
1566 extern void set_breakpoint_condition (struct breakpoint
*b
, const char *exp
,
1569 /* Checks if we are catching syscalls or not.
1570 Returns 0 if not, greater than 0 if we are. */
1571 extern int catch_syscall_enabled (void);
1573 /* Checks if we are catching syscalls with the specific
1574 syscall_number. Used for "filtering" the catchpoints.
1575 Returns 0 if not, greater than 0 if we are. */
1576 extern int catching_syscall_number (int syscall_number
);
1578 /* Return a tracepoint with the given number if found. */
1579 extern struct tracepoint
*get_tracepoint (int num
);
1581 extern struct tracepoint
*get_tracepoint_by_number_on_target (int num
);
1583 /* Find a tracepoint by parsing a number in the supplied string. */
1584 extern struct tracepoint
*
1585 get_tracepoint_by_number (char **arg
,
1586 number_or_range_parser
*parser
);
1588 /* Return a vector of all tracepoints currently defined. The vector
1589 is newly allocated; the caller should free when done with it. */
1590 extern VEC(breakpoint_p
) *all_tracepoints (void);
1592 extern int is_tracepoint (const struct breakpoint
*b
);
1594 /* Return a vector of all static tracepoints defined at ADDR. The
1595 vector is newly allocated; the caller should free when done with
1597 extern VEC(breakpoint_p
) *static_tracepoints_here (CORE_ADDR addr
);
1599 /* Function that can be passed to read_command_line to validate
1600 that each command is suitable for tracepoint command list. */
1601 extern void check_tracepoint_command (char *line
, void *closure
);
1603 /* Call at the start and end of an "rbreak" command to register
1604 breakpoint numbers for a later "commands" command. */
1605 extern void start_rbreak_breakpoints (void);
1606 extern void end_rbreak_breakpoints (void);
1608 /* Breakpoint iterator function.
1610 Calls a callback function once for each breakpoint, so long as the
1611 callback function returns false. If the callback function returns
1612 true, the iteration will end and the current breakpoint will be
1613 returned. This can be useful for implementing a search for a
1614 breakpoint with arbitrary attributes, or for applying an operation
1615 to every breakpoint. */
1616 extern struct breakpoint
*iterate_over_breakpoints (int (*) (struct breakpoint
*,
1619 /* Nonzero if the specified PC cannot be a location where functions
1620 have been inlined. */
1622 extern int pc_at_non_inline_function (struct address_space
*aspace
,
1624 const struct target_waitstatus
*ws
);
1626 extern int user_breakpoint_p (struct breakpoint
*);
1628 /* Return true if this breakpoint is pending, false if not. */
1629 extern int pending_breakpoint_p (struct breakpoint
*);
1631 /* Attempt to determine architecture of location identified by SAL. */
1632 extern struct gdbarch
*get_sal_arch (struct symtab_and_line sal
);
1634 extern void breakpoint_free_objfile (struct objfile
*objfile
);
1636 extern const char *ep_parse_optional_if_clause (const char **arg
);
1638 /* Print the "Thread ID hit" part of "Thread ID hit Breakpoint N" to
1639 UIOUT iff debugging multiple threads. */
1640 extern void maybe_print_thread_hit_breakpoint (struct ui_out
*uiout
);
1642 #endif /* !defined (BREAKPOINT_H) */