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"
31 #include "common/array-view.h"
32 #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;
45 /* Why are we removing the breakpoint from the target? */
49 /* A regular remove. Remove the breakpoint and forget everything
53 /* Detach the breakpoints from a fork child. */
57 /* This is the maximum number of bytes a breakpoint instruction can
58 take. Feel free to increase it. It's just used in a few places to
59 size arrays that should be independent of the target
62 #define BREAKPOINT_MAX 16
65 /* Type of breakpoint. */
69 bp_none = 0, /* Eventpoint has been deleted */
70 bp_breakpoint, /* Normal breakpoint */
71 bp_hardware_breakpoint, /* Hardware assisted breakpoint */
72 bp_single_step, /* Software single-step */
73 bp_until, /* used by until command */
74 bp_finish, /* used by finish command */
75 bp_watchpoint, /* Watchpoint */
76 bp_hardware_watchpoint, /* Hardware assisted watchpoint */
77 bp_read_watchpoint, /* read watchpoint, (hardware assisted) */
78 bp_access_watchpoint, /* access watchpoint, (hardware assisted) */
79 bp_longjmp, /* secret breakpoint to find longjmp() */
80 bp_longjmp_resume, /* secret breakpoint to escape longjmp() */
82 /* Breakpoint placed to the same location(s) like bp_longjmp but used to
83 protect against stale DUMMY_FRAME. Multiple bp_longjmp_call_dummy and
84 one bp_call_dummy are chained together by related_breakpoint for each
86 bp_longjmp_call_dummy,
88 /* An internal breakpoint that is installed on the unwinder's
91 /* An internal breakpoint that is set at the point where an
92 exception will land. */
95 /* Used by wait_for_inferior for stepping over subroutine calls,
96 and for skipping prologues. */
99 /* Used by wait_for_inferior for stepping over signal
103 /* Used to detect when a watchpoint expression has gone out of
104 scope. These breakpoints are usually not visible to the user.
106 This breakpoint has some interesting properties:
108 1) There's always a 1:1 mapping between watchpoints
109 on local variables and watchpoint_scope breakpoints.
111 2) It automatically deletes itself and the watchpoint it's
112 associated with when hit.
114 3) It can never be disabled. */
117 /* The breakpoint at the end of a call dummy. See bp_longjmp_call_dummy it
118 is chained with by related_breakpoint. */
121 /* A breakpoint set on std::terminate, that is used to catch
122 otherwise uncaught exceptions thrown during an inferior call. */
125 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
126 code in the inferior to run when significant events occur in the
127 dynamic linker (for example a library is loaded or unloaded).
129 By placing a breakpoint in this magic code GDB will get control
130 when these significant events occur. GDB can then re-examine
131 the dynamic linker's data structures to discover any newly loaded
132 dynamic libraries. */
135 /* Some multi-threaded systems can arrange for a location in the
136 inferior to be executed when certain thread-related events occur
137 (such as thread creation or thread death).
139 By placing a breakpoint at one of these locations, GDB will get
140 control when these events occur. GDB can then update its thread
145 /* On the same principal, an overlay manager can arrange to call a
146 magic location in the inferior whenever there is an interesting
147 change in overlay status. GDB can update its overlay tables
148 and fiddle with breakpoints in overlays when this breakpoint
153 /* Master copies of longjmp breakpoints. These are always installed
154 as soon as an objfile containing longjmp is loaded, but they are
155 always disabled. While necessary, temporary clones of bp_longjmp
156 type will be created and enabled. */
160 /* Master copies of std::terminate breakpoints. */
161 bp_std_terminate_master,
163 /* Like bp_longjmp_master, but for exceptions. */
170 bp_static_tracepoint,
172 /* A dynamic printf stops at the given location, does a formatted
173 print, then automatically continues. (Although this is sort of
174 like a macro packaging up standard breakpoint functionality,
175 GDB doesn't have a way to construct types of breakpoint from
176 elements of behavior.) */
179 /* Event for JIT compiled code generation or deletion. */
182 /* Breakpoint is placed at the STT_GNU_IFUNC resolver. When hit GDB
183 inserts new bp_gnu_ifunc_resolver_return at the caller.
184 bp_gnu_ifunc_resolver is still being kept here as a different thread
185 may still hit it before bp_gnu_ifunc_resolver_return is hit by the
187 bp_gnu_ifunc_resolver,
189 /* On its hit GDB now know the resolved address of the target
190 STT_GNU_IFUNC function. Associated bp_gnu_ifunc_resolver can be
191 deleted now and the breakpoint moved to the target function entry
193 bp_gnu_ifunc_resolver_return,
196 /* States of enablement of breakpoint. */
200 bp_disabled, /* The eventpoint is inactive, and cannot
202 bp_enabled, /* The eventpoint is active, and can
204 bp_call_disabled, /* The eventpoint has been disabled while a
205 call into the inferior is "in flight",
206 because some eventpoints interfere with
207 the implementation of a call on some
208 targets. The eventpoint will be
209 automatically enabled and reset when the
210 call "lands" (either completes, or stops
211 at another eventpoint). */
215 /* Disposition of breakpoint. Ie: what to do after hitting it. */
219 disp_del, /* Delete it */
220 disp_del_at_next_stop, /* Delete at next stop,
221 whether hit or not */
222 disp_disable, /* Disable it */
223 disp_donttouch /* Leave it alone */
226 /* Status of breakpoint conditions used when synchronizing
227 conditions with the target. */
229 enum condition_status
231 condition_unchanged = 0,
236 /* Information used by targets to insert and remove breakpoints. */
238 struct bp_target_info
240 /* Address space at which the breakpoint was placed. */
241 struct address_space *placed_address_space;
243 /* Address at which the breakpoint was placed. This is normally
244 the same as REQUESTED_ADDRESS, except when adjustment happens in
245 gdbarch_breakpoint_from_pc. The most common form of adjustment
246 is stripping an alternate ISA marker from the PC which is used
247 to determine the type of breakpoint to insert. */
248 CORE_ADDR placed_address;
250 /* Address at which the breakpoint was requested. */
251 CORE_ADDR reqstd_address;
253 /* If this is a ranged breakpoint, then this field contains the
254 length of the range that will be watched for execution. */
257 /* If the breakpoint lives in memory and reading that memory would
258 give back the breakpoint, instead of the original contents, then
259 the original contents are cached here. Only SHADOW_LEN bytes of
260 this buffer are valid, and only when the breakpoint is inserted. */
261 gdb_byte shadow_contents[BREAKPOINT_MAX];
263 /* The length of the data cached in SHADOW_CONTENTS. */
266 /* The breakpoint's kind. It is used in 'kind' parameter in Z
270 /* Conditions the target should evaluate if it supports target-side
271 breakpoint conditions. These are non-owning pointers. */
272 std::vector<agent_expr *> conditions;
274 /* Commands the target should evaluate if it supports target-side
275 breakpoint commands. These are non-owning pointers. */
276 std::vector<agent_expr *> tcommands;
278 /* Flag that is true if the breakpoint should be left in place even
279 when GDB is not connected. */
283 /* GDB maintains two types of information about each breakpoint (or
284 watchpoint, or other related event). The first type corresponds
285 to struct breakpoint; this is a relatively high-level structure
286 which contains the source location(s), stopping conditions, user
287 commands to execute when the breakpoint is hit, and so forth.
289 The second type of information corresponds to struct bp_location.
290 Each breakpoint has one or (eventually) more locations associated
291 with it, which represent target-specific and machine-specific
292 mechanisms for stopping the program. For instance, a watchpoint
293 expression may require multiple hardware watchpoints in order to
294 catch all changes in the value of the expression being watched. */
298 bp_loc_software_breakpoint,
299 bp_loc_hardware_breakpoint,
300 bp_loc_hardware_watchpoint,
301 bp_loc_other /* Miscellaneous... */
304 /* This structure is a collection of function pointers that, if
305 available, will be called instead of performing the default action
306 for this bp_loc_type. */
308 struct bp_location_ops
310 /* Destructor. Releases everything from SELF (but not SELF
312 void (*dtor) (struct bp_location *self);
318 bp_location () = default;
320 bp_location (const bp_location_ops *ops, breakpoint *owner);
322 /* Chain pointer to the next breakpoint location for
323 the same parent breakpoint. */
324 bp_location *next = NULL;
326 /* Methods associated with this location. */
327 const bp_location_ops *ops = NULL;
329 /* The reference count. */
332 /* Type of this breakpoint location. */
333 bp_loc_type loc_type {};
335 /* Each breakpoint location must belong to exactly one higher-level
336 breakpoint. This pointer is NULL iff this bp_location is no
337 longer attached to a breakpoint. For example, when a breakpoint
338 is deleted, its locations may still be found in the
339 moribund_locations list, or if we had stopped for it, in
341 breakpoint *owner = NULL;
343 /* Conditional. Break only if this expression's value is nonzero.
344 Unlike string form of condition, which is associated with
345 breakpoint, this is associated with location, since if breakpoint
346 has several locations, the evaluation of expression can be
347 different for different locations. Only valid for real
348 breakpoints; a watchpoint's conditional expression is stored in
349 the owner breakpoint object. */
352 /* Conditional expression in agent expression
353 bytecode form. This is used for stub-side breakpoint
354 condition evaluation. */
355 agent_expr_up cond_bytecode;
357 /* Signals that the condition has changed since the last time
358 we updated the global location list. This means the condition
359 needs to be sent to the target again. This is used together
360 with target-side breakpoint conditions.
362 condition_unchanged: It means there has been no condition changes.
364 condition_modified: It means this location had its condition modified.
366 condition_updated: It means we already marked all the locations that are
367 duplicates of this location and thus we don't need to call
368 force_breakpoint_reinsertion (...) for this location. */
370 condition_status condition_changed {};
372 agent_expr_up cmd_bytecode;
374 /* Signals that breakpoint conditions and/or commands need to be
375 re-synched with the target. This has no use other than
376 target-side breakpoints. */
377 bool needs_update = false;
379 /* This location's address is in an unloaded solib, and so this
380 location should not be inserted. It will be automatically
381 enabled when that solib is loaded. */
382 bool shlib_disabled = false;
384 /* Is this particular location enabled. */
385 bool enabled = false;
387 /* Nonzero if this breakpoint is now inserted. */
388 bool inserted = false;
390 /* Nonzero if this is a permanent breakpoint. There is a breakpoint
391 instruction hard-wired into the target's code. Don't try to
392 write another breakpoint instruction on top of it, or restore its
393 value. Step over it using the architecture's
394 gdbarch_skip_permanent_breakpoint method. */
395 bool permanent = false;
397 /* Nonzero if this is not the first breakpoint in the list
398 for the given address. location of tracepoint can _never_
399 be duplicated with other locations of tracepoints and other
400 kinds of breakpoints, because two locations at the same
401 address may have different actions, so both of these locations
402 should be downloaded and so that `tfind N' always works. */
403 bool duplicate = false;
405 /* If we someday support real thread-specific breakpoints, then
406 the breakpoint location will need a thread identifier. */
408 /* Data for specific breakpoint types. These could be a union, but
409 simplicity is more important than memory usage for breakpoints. */
411 /* Architecture associated with this location's address. May be
412 different from the breakpoint architecture. */
413 struct gdbarch *gdbarch = NULL;
415 /* The program space associated with this breakpoint location
416 address. Note that an address space may be represented in more
417 than one program space (e.g. each uClinux program will be given
418 its own program space, but there will only be one address space
419 for all of them), but we must not insert more than one location
420 at the same address in the same address space. */
421 program_space *pspace = NULL;
423 /* Note that zero is a perfectly valid code address on some platforms
424 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
425 is not a special value for this field. Valid for all types except
427 CORE_ADDR address = 0;
429 /* For hardware watchpoints, the size of the memory region being
430 watched. For hardware ranged breakpoints, the size of the
434 /* Type of hardware watchpoint. */
435 target_hw_bp_type watchpoint_type {};
437 /* For any breakpoint type with an address, this is the section
438 associated with the address. Used primarily for overlay
440 obj_section *section = NULL;
442 /* Address at which breakpoint was requested, either by the user or
443 by GDB for internal breakpoints. This will usually be the same
444 as ``address'' (above) except for cases in which
445 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
446 which to place the breakpoint in order to comply with a
447 processor's architectual constraints. */
448 CORE_ADDR requested_address = 0;
450 /* An additional address assigned with this location. This is currently
451 only used by STT_GNU_IFUNC resolver breakpoints to hold the address
452 of the resolver function. */
453 CORE_ADDR related_address = 0;
455 /* If the location comes from a probe point, this is the probe associated
457 bound_probe probe {};
459 char *function_name = NULL;
461 /* Details of the placed breakpoint, when inserted. */
462 bp_target_info target_info {};
464 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
465 bp_target_info overlay_target_info {};
467 /* In a non-stop mode, it's possible that we delete a breakpoint,
468 but as we do that, some still running thread hits that breakpoint.
469 For that reason, we need to keep locations belonging to deleted
470 breakpoints for a bit, so that don't report unexpected SIGTRAP.
471 We can't keep such locations forever, so we use a heuristic --
472 after we process certain number of inferior events since
473 breakpoint was deleted, we retire all locations of that breakpoint.
474 This variable keeps a number of events still to go, when
475 it becomes 0 this location is retired. */
476 int events_till_retirement = 0;
478 /* Line number which was used to place this location.
480 Breakpoint placed into a comment keeps it's user specified line number
481 despite ADDRESS resolves into a different line number. */
485 /* Symtab which was used to place this location. This is used
486 to find the corresponding source file name. */
488 struct symtab *symtab = NULL;
490 /* The symbol found by the location parser, if any. This may be used to
491 ascertain when an event location was set at a different location than
492 the one originally selected by parsing, e.g., inlined symbols. */
493 const struct symbol *symbol = NULL;
496 /* The possible return values for print_bpstat, print_it_normal,
497 print_it_done, print_it_noop. */
498 enum print_stop_action
500 /* We printed nothing or we need to do some more analysis. */
503 /* We printed something, and we *do* desire that something to be
504 followed by a location. */
507 /* We printed something, and we do *not* desire that something to be
508 followed by a location. */
511 /* We already printed all we needed to print, don't print anything
516 /* This structure is a collection of function pointers that, if available,
517 will be called instead of the performing the default action for this
520 struct breakpoint_ops
522 /* Allocate a location for this breakpoint. */
523 struct bp_location * (*allocate_location) (struct breakpoint *);
525 /* Reevaluate a breakpoint. This is necessary after symbols change
526 (e.g., an executable or DSO was loaded, or the inferior just
528 void (*re_set) (struct breakpoint *self);
530 /* Insert the breakpoint or watchpoint or activate the catchpoint.
531 Return 0 for success, 1 if the breakpoint, watchpoint or
532 catchpoint type is not supported, -1 for failure. */
533 int (*insert_location) (struct bp_location *);
535 /* Remove the breakpoint/catchpoint that was previously inserted
536 with the "insert" method above. Return 0 for success, 1 if the
537 breakpoint, watchpoint or catchpoint type is not supported,
539 int (*remove_location) (struct bp_location *, enum remove_bp_reason reason);
541 /* Return true if it the target has stopped due to hitting
542 breakpoint location BL. This function does not check if we
543 should stop, only if BL explains the stop. ASPACE is the address
544 space in which the event occurred, BP_ADDR is the address at
545 which the inferior stopped, and WS is the target_waitstatus
546 describing the event. */
547 int (*breakpoint_hit) (const struct bp_location *bl,
548 const address_space *aspace,
550 const struct target_waitstatus *ws);
552 /* Check internal conditions of the breakpoint referred to by BS.
553 If we should not stop for this breakpoint, set BS->stop to 0. */
554 void (*check_status) (struct bpstats *bs);
556 /* Tell how many hardware resources (debug registers) are needed
557 for this breakpoint. If this function is not provided, then
558 the breakpoint or watchpoint needs one debug register. */
559 int (*resources_needed) (const struct bp_location *);
561 /* Tell whether we can downgrade from a hardware watchpoint to a software
562 one. If not, the user will not be able to enable the watchpoint when
563 there are not enough hardware resources available. */
564 int (*works_in_software_mode) (const struct breakpoint *);
566 /* The normal print routine for this breakpoint, called when we
568 enum print_stop_action (*print_it) (struct bpstats *bs);
570 /* Display information about this breakpoint, for "info
572 void (*print_one) (struct breakpoint *, struct bp_location **);
574 /* Display extra information about this breakpoint, below the normal
575 breakpoint description in "info breakpoints".
577 In the example below, the "address range" line was printed
578 by print_one_detail_ranged_breakpoint.
580 (gdb) info breakpoints
581 Num Type Disp Enb Address What
582 2 hw breakpoint keep y in main at test-watch.c:70
583 address range: [0x10000458, 0x100004c7]
586 void (*print_one_detail) (const struct breakpoint *, struct ui_out *);
588 /* Display information about this breakpoint after setting it
589 (roughly speaking; this is called from "mention"). */
590 void (*print_mention) (struct breakpoint *);
592 /* Print to FP the CLI command that recreates this breakpoint. */
593 void (*print_recreate) (struct breakpoint *, struct ui_file *fp);
595 /* Create SALs from location, storing the result in linespec_result.
597 For an explanation about the arguments, see the function
598 `create_sals_from_location_default'.
600 This function is called inside `create_breakpoint'. */
601 void (*create_sals_from_location) (const struct event_location *location,
602 struct linespec_result *canonical,
603 enum bptype type_wanted);
605 /* This method will be responsible for creating a breakpoint given its SALs.
606 Usually, it just calls `create_breakpoints_sal' (for ordinary
607 breakpoints). However, there may be some special cases where we might
608 need to do some tweaks, e.g., see
609 `strace_marker_create_breakpoints_sal'.
611 This function is called inside `create_breakpoint'. */
612 void (*create_breakpoints_sal) (struct gdbarch *,
613 struct linespec_result *,
614 gdb::unique_xmalloc_ptr<char>,
615 gdb::unique_xmalloc_ptr<char>,
616 enum bptype, enum bpdisp, int, int,
617 int, const struct breakpoint_ops *,
618 int, int, int, unsigned);
620 /* Given the location (second parameter), this method decodes it and
621 returns the SAL locations related to it. For ordinary
622 breakpoints, it calls `decode_line_full'. If SEARCH_PSPACE is
623 not NULL, symbol search is restricted to just that program space.
625 This function is called inside `location_to_sals'. */
626 std::vector<symtab_and_line> (*decode_location)
627 (struct breakpoint *b,
628 const struct event_location *location,
629 struct program_space *search_pspace);
631 /* Return true if this breakpoint explains a signal. See
632 bpstat_explains_signal. */
633 int (*explains_signal) (struct breakpoint *, enum gdb_signal);
635 /* Called after evaluating the breakpoint's condition,
636 and only if it evaluated true. */
637 void (*after_condition_true) (struct bpstats *bs);
640 /* Helper for breakpoint_ops->print_recreate implementations. Prints
641 the "thread" or "task" condition of B, and then a newline.
643 Necessary because most breakpoint implementations accept
644 thread/task conditions at the end of the spec line, like "break foo
645 thread 1", which needs outputting before any breakpoint-type
646 specific extra command necessary for B's recreation. */
647 extern void print_recreate_thread (struct breakpoint *b, struct ui_file *fp);
649 enum watchpoint_triggered
651 /* This watchpoint definitely did not trigger. */
652 watch_triggered_no = 0,
654 /* Some hardware watchpoint triggered, and it might have been this
655 one, but we do not know which it was. */
656 watch_triggered_unknown,
658 /* This hardware watchpoint definitely did trigger. */
662 typedef struct bp_location *bp_location_p;
663 DEF_VEC_P(bp_location_p);
665 /* A reference-counted struct command_line. This is an implementation
666 detail to the breakpoints module. */
667 typedef std::shared_ptr<command_line> counted_command_line;
669 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
670 a watchpoint over a memory region. If this flag is true, GDB will use
671 only one register per watchpoint, thus assuming that all acesses that
672 modify a memory location happen at its starting address. */
674 extern int target_exact_watchpoints;
676 /* Note that the ->silent field is not currently used by any commands
677 (though the code is in there if it was to be, and set_raw_breakpoint
678 does set it to 0). I implemented it because I thought it would be
679 useful for a hack I had to put in; I'm going to leave it in because
680 I can see how there might be times when it would indeed be useful */
682 /* This is for all kinds of breakpoints. */
686 virtual ~breakpoint ();
688 /* Methods associated with this breakpoint. */
689 const breakpoint_ops *ops = NULL;
691 breakpoint *next = NULL;
692 /* Type of breakpoint. */
693 bptype type = bp_none;
694 /* Zero means disabled; remember the info but don't break here. */
695 enum enable_state enable_state = bp_enabled;
696 /* What to do with this breakpoint after we hit it. */
697 bpdisp disposition = disp_del;
698 /* Number assigned to distinguish breakpoints. */
701 /* Location(s) associated with this high-level breakpoint. */
702 bp_location *loc = NULL;
704 /* True means a silent breakpoint (don't print frame info if we stop
707 /* True means display ADDR_STRING to the user verbatim. */
708 bool display_canonical = false;
709 /* Number of stops at this breakpoint that should be continued
710 automatically before really stopping. */
711 int ignore_count = 0;
713 /* Number of stops at this breakpoint before it will be
715 int enable_count = 0;
717 /* Chain of command lines to execute when this breakpoint is
719 counted_command_line commands;
720 /* Stack depth (address of frame). If nonzero, break only if fp
722 struct frame_id frame_id = null_frame_id;
724 /* The program space used to set the breakpoint. This is only set
725 for breakpoints which are specific to a program space; for
726 non-thread-specific ordinary breakpoints this is NULL. */
727 program_space *pspace = NULL;
729 /* Location we used to set the breakpoint. */
730 event_location_up location;
732 /* The filter that should be passed to decode_line_full when
733 re-setting this breakpoint. This may be NULL, but otherwise is
734 allocated with xmalloc. */
737 /* For a ranged breakpoint, the location we used to find the end of
739 event_location_up location_range_end;
741 /* Architecture we used to set the breakpoint. */
742 struct gdbarch *gdbarch = NULL;
743 /* Language we used to set the breakpoint. */
744 enum language language = language_unknown;
745 /* Input radix we used to set the breakpoint. */
747 /* String form of the breakpoint condition (malloc'd), or NULL if
748 there is no condition. */
749 char *cond_string = NULL;
751 /* String form of extra parameters, or NULL if there are none.
753 char *extra_string = NULL;
755 /* Holds the address of the related watchpoint_scope breakpoint when
756 using watchpoints on local variables (might the concept of a
757 related breakpoint be useful elsewhere, if not just call it the
758 watchpoint_scope breakpoint or something like that. FIXME). */
759 breakpoint *related_breakpoint = NULL;
761 /* Thread number for thread-specific breakpoint, or -1 if don't
765 /* Ada task number for task-specific breakpoint, or 0 if don't
769 /* Count of the number of times this breakpoint was taken, dumped
770 with the info, but not used for anything else. Useful for seeing
771 how many times you hit a break prior to the program aborting, so
772 you can back up to just before the abort. */
775 /* Is breakpoint's condition not yet parsed because we found no
776 location initially so had no context to parse the condition
778 int condition_not_parsed = 0;
780 /* With a Python scripting enabled GDB, store a reference to the
781 Python object that has been associated with this breakpoint.
782 This is always NULL for a GDB that is not script enabled. It can
783 sometimes be NULL for enabled GDBs as not all breakpoint types
784 are tracked by the scripting language API. */
785 gdbpy_breakpoint_object *py_bp_object = NULL;
787 /* Same as py_bp_object, but for Scheme. */
788 gdbscm_breakpoint_object *scm_bp_object = NULL;
791 /* An instance of this type is used to represent a watchpoint. */
793 struct watchpoint : public breakpoint
795 ~watchpoint () override;
797 /* String form of exp to use for displaying to the user (malloc'd),
800 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
801 char *exp_string_reparse;
803 /* The expression we are watching, or NULL if not a watchpoint. */
805 /* The largest block within which it is valid, or NULL if it is
806 valid anywhere (e.g. consists just of global symbols). */
807 const struct block *exp_valid_block;
808 /* The conditional expression if any. */
809 expression_up cond_exp;
810 /* The largest block within which it is valid, or NULL if it is
811 valid anywhere (e.g. consists just of global symbols). */
812 const struct block *cond_exp_valid_block;
813 /* Value of the watchpoint the last time we checked it, or NULL when
814 we do not know the value yet or the value was not readable. VAL
817 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
818 then an error occurred reading the value. */
821 /* When watching the location of a bitfield, contains the offset and size of
822 the bitfield. Otherwise contains 0. */
826 /* Holds the frame address which identifies the frame this
827 watchpoint should be evaluated in, or `null' if the watchpoint
828 should be evaluated on the outermost frame. */
829 struct frame_id watchpoint_frame;
831 /* Holds the thread which identifies the frame this watchpoint
832 should be considered in scope for, or `null_ptid' if the
833 watchpoint should be evaluated in all threads. */
834 ptid_t watchpoint_thread;
836 /* For hardware watchpoints, the triggered status according to the
838 enum watchpoint_triggered watchpoint_triggered;
840 /* Whether this watchpoint is exact (see
841 target_exact_watchpoints). */
844 /* The mask address for a masked hardware watchpoint. */
845 CORE_ADDR hw_wp_mask;
848 /* Given a function FUNC (struct breakpoint *B, void *DATA) and
849 USER_DATA, call FUNC for every known breakpoint passing USER_DATA
852 If FUNC returns 1, the loop stops and the current
853 'struct breakpoint' being processed is returned. If FUNC returns
854 zero, the loop continues.
856 This function returns either a 'struct breakpoint' pointer or NULL.
857 It was based on BFD's bfd_sections_find_if function. */
859 extern struct breakpoint *breakpoint_find_if
860 (int (*func) (struct breakpoint *b, void *d), void *user_data);
862 /* Return true if BPT is either a software breakpoint or a hardware
865 extern int is_breakpoint (const struct breakpoint *bpt);
867 /* Returns true if BPT is really a watchpoint. */
869 extern int is_watchpoint (const struct breakpoint *bpt);
871 /* An instance of this type is used to represent all kinds of
874 struct tracepoint : public breakpoint
876 /* Number of times this tracepoint should single-step and collect
880 /* Number of times this tracepoint should be hit before
884 /* The number of the tracepoint on the target. */
885 int number_on_target;
887 /* The total space taken by all the trace frames for this
889 ULONGEST traceframe_usage;
891 /* The static tracepoint marker id, if known. */
892 char *static_trace_marker_id;
894 /* LTTng/UST allow more than one marker with the same ID string,
895 although it unadvised because it confuses tools. When setting
896 static tracepoints by marker ID, this will record the index in
897 the array of markers we found for the given marker ID for which
898 this static tracepoint corresponds. When resetting breakpoints,
899 we will use this index to try to find the same marker again. */
900 int static_trace_marker_id_idx;
903 typedef struct breakpoint *breakpoint_p;
904 DEF_VEC_P(breakpoint_p);
906 /* The following stuff is an abstract data type "bpstat" ("breakpoint
907 status"). This provides the ability to determine whether we have
908 stopped at a breakpoint, and what we should do about it. */
910 typedef struct bpstats *bpstat;
912 /* Clears a chain of bpstat, freeing storage
914 extern void bpstat_clear (bpstat *);
916 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
917 is part of the bpstat is copied as well. */
918 extern bpstat bpstat_copy (bpstat);
920 extern bpstat bpstat_stop_status (const address_space *aspace,
921 CORE_ADDR pc, ptid_t ptid,
922 const struct target_waitstatus *ws);
924 /* This bpstat_what stuff tells wait_for_inferior what to do with a
925 breakpoint (a challenging task).
927 The enum values order defines priority-like order of the actions.
928 Once you've decided that some action is appropriate, you'll never
929 go back and decide something of a lower priority is better. Each
930 of these actions is mutually exclusive with the others. That
931 means, that if you find yourself adding a new action class here and
932 wanting to tell GDB that you have two simultaneous actions to
933 handle, something is wrong, and you probably don't actually need a
936 Note that a step resume breakpoint overrides another breakpoint of
937 signal handling (see comment in wait_for_inferior at where we set
938 the step_resume breakpoint). */
940 enum bpstat_what_main_action
942 /* Perform various other tests; that is, this bpstat does not
943 say to perform any action (e.g. failed watchpoint and nothing
945 BPSTAT_WHAT_KEEP_CHECKING,
947 /* Remove breakpoints, single step once, then put them back in and
948 go back to what we were doing. It's possible that this should
949 be removed from the main_action and put into a separate field,
950 to more cleanly handle
951 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
954 /* Set longjmp_resume breakpoint, remove all other breakpoints,
955 and continue. The "remove all other breakpoints" part is
956 required if we are also stepping over another breakpoint as
957 well as doing the longjmp handling. */
958 BPSTAT_WHAT_SET_LONGJMP_RESUME,
960 /* Clear longjmp_resume breakpoint, then handle as
961 BPSTAT_WHAT_KEEP_CHECKING. */
962 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
964 /* Clear step resume breakpoint, and keep checking. */
965 BPSTAT_WHAT_STEP_RESUME,
967 /* Rather than distinguish between noisy and silent stops here, it
968 might be cleaner to have bpstat_print make that decision (also
969 taking into account stop_print_frame and source_only). But the
970 implications are a bit scary (interaction with auto-displays,
971 etc.), so I won't try it. */
974 BPSTAT_WHAT_STOP_SILENT,
976 /* Stop and print. */
977 BPSTAT_WHAT_STOP_NOISY,
979 /* Clear step resume breakpoint, and keep checking. High-priority
980 step-resume breakpoints are used when even if there's a user
981 breakpoint at the current PC when we set the step-resume
982 breakpoint, we don't want to re-handle any breakpoint other
983 than the step-resume when it's hit; instead we want to move
984 past the breakpoint. This is used in the case of skipping
986 BPSTAT_WHAT_HP_STEP_RESUME,
989 /* An enum indicating the kind of "stack dummy" stop. This is a bit
990 of a misnomer because only one kind of truly a stack dummy. */
993 /* We didn't stop at a stack dummy breakpoint. */
996 /* Stopped at a stack dummy. */
999 /* Stopped at std::terminate. */
1005 enum bpstat_what_main_action main_action;
1007 /* Did we hit a call dummy breakpoint? This only goes with a
1008 main_action of BPSTAT_WHAT_STOP_SILENT or
1009 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
1010 dummy without popping the frame is not a useful one). */
1011 enum stop_stack_kind call_dummy;
1013 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
1014 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
1015 longjmp, false if we are handling an exception. */
1019 /* Tell what to do about this bpstat. */
1020 struct bpstat_what bpstat_what (bpstat);
1022 /* Run breakpoint event callbacks associated with the breakpoints that
1024 extern void bpstat_run_callbacks (bpstat bs_head);
1026 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
1027 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
1029 /* Nonzero if a signal that we got in target_wait() was due to
1030 circumstances explained by the bpstat; the signal is therefore not
1032 extern int bpstat_explains_signal (bpstat, enum gdb_signal);
1034 /* Nonzero is this bpstat causes a stop. */
1035 extern int bpstat_causes_stop (bpstat);
1037 /* Nonzero if we should step constantly (e.g. watchpoints on machines
1038 without hardware support). This isn't related to a specific bpstat,
1039 just to things like whether watchpoints are set. */
1040 extern int bpstat_should_step (void);
1042 /* Print a message indicating what happened. Returns nonzero to
1043 say that only the source line should be printed after this (zero
1044 return means print the frame as well as the source line). */
1045 extern enum print_stop_action bpstat_print (bpstat, int);
1047 /* Put in *NUM the breakpoint number of the first breakpoint we are
1048 stopped at. *BSP upon return is a bpstat which points to the
1049 remaining breakpoints stopped at (but which is not guaranteed to be
1050 good for anything but further calls to bpstat_num).
1052 Return 0 if passed a bpstat which does not indicate any breakpoints.
1053 Return -1 if stopped at a breakpoint that has been deleted since
1055 Return 1 otherwise. */
1056 extern int bpstat_num (bpstat *, int *);
1058 /* Perform actions associated with the stopped inferior. Actually, we
1059 just use this for breakpoint commands. Perhaps other actions will
1060 go here later, but this is executed at a late time (from the
1062 extern void bpstat_do_actions (void);
1064 /* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will
1065 not be performed. */
1066 extern void bpstat_clear_actions (void);
1068 /* Implementation: */
1070 /* Values used to tell the printing routine how to behave for this
1074 /* This is used when we want to do a normal printing of the reason
1075 for stopping. The output will depend on the type of eventpoint
1076 we are dealing with. This is the default value, most commonly
1079 /* This is used when nothing should be printed for this bpstat
1082 /* This is used when everything which needs to be printed has
1083 already been printed. But we still want to print the frame. */
1090 bpstats (struct bp_location *bl, bpstat **bs_link_pointer);
1093 bpstats (const bpstats &);
1094 bpstats &operator= (const bpstats &) = delete;
1096 /* Linked list because there can be more than one breakpoint at
1097 the same place, and a bpstat reflects the fact that all have
1101 /* Location that caused the stop. Locations are refcounted, so
1102 this will never be NULL. Note that this location may end up
1103 detached from a breakpoint, but that does not necessary mean
1104 that the struct breakpoint is gone. E.g., consider a
1105 watchpoint with a condition that involves an inferior function
1106 call. Watchpoint locations are recreated often (on resumes,
1107 hence on infcalls too). Between creating the bpstat and after
1108 evaluating the watchpoint condition, this location may hence
1109 end up detached from its original owner watchpoint, even though
1110 the watchpoint is still listed. If it's condition evaluates as
1111 true, we still want this location to cause a stop, and we will
1112 still need to know which watchpoint it was originally attached.
1113 What this means is that we should not (in most cases) follow
1114 the `bpstat->bp_location->owner' link, but instead use the
1115 `breakpoint_at' field below. */
1116 struct bp_location *bp_location_at;
1118 /* Breakpoint that caused the stop. This is nullified if the
1119 breakpoint ends up being deleted. See comments on
1120 `bp_location_at' above for why do we need this field instead of
1121 following the location's owner. */
1122 struct breakpoint *breakpoint_at;
1124 /* The associated command list. */
1125 counted_command_line commands;
1127 /* Old value associated with a watchpoint. */
1128 struct value *old_val;
1130 /* Nonzero if this breakpoint tells us to print the frame. */
1133 /* Nonzero if this breakpoint tells us to stop. */
1136 /* Tell bpstat_print and print_bp_stop_message how to print stuff
1137 associated with this element of the bpstat chain. */
1138 enum bp_print_how print_it;
1149 /* The possible return values for breakpoint_here_p.
1150 We guarantee that zero always means "no breakpoint here". */
1151 enum breakpoint_here
1153 no_breakpoint_here = 0,
1154 ordinary_breakpoint_here,
1155 permanent_breakpoint_here
1159 /* Prototypes for breakpoint-related functions. */
1161 /* Return 1 if there's a program/permanent breakpoint planted in
1162 memory at ADDRESS, return 0 otherwise. */
1164 extern int program_breakpoint_here_p (struct gdbarch *gdbarch, CORE_ADDR address);
1166 extern enum breakpoint_here breakpoint_here_p (const address_space *,
1169 /* Return true if an enabled breakpoint exists in the range defined by
1170 ADDR and LEN, in ASPACE. */
1171 extern int breakpoint_in_range_p (const address_space *aspace,
1172 CORE_ADDR addr, ULONGEST len);
1174 extern int moribund_breakpoint_here_p (const address_space *, CORE_ADDR);
1176 extern int breakpoint_inserted_here_p (const address_space *,
1179 extern int software_breakpoint_inserted_here_p (const address_space *,
1182 /* Return non-zero iff there is a hardware breakpoint inserted at
1184 extern int hardware_breakpoint_inserted_here_p (const address_space *,
1187 /* Check whether any location of BP is inserted at PC. */
1189 extern int breakpoint_has_location_inserted_here (struct breakpoint *bp,
1190 const address_space *aspace,
1193 extern int single_step_breakpoint_inserted_here_p (const address_space *,
1196 /* Returns true if there's a hardware watchpoint or access watchpoint
1197 inserted in the range defined by ADDR and LEN. */
1198 extern int hardware_watchpoint_inserted_in_range (const address_space *,
1202 /* Returns true if {ASPACE1,ADDR1} and {ASPACE2,ADDR2} represent the
1203 same breakpoint location. In most targets, this can only be true
1204 if ASPACE1 matches ASPACE2. On targets that have global
1205 breakpoints, the address space doesn't really matter. */
1207 extern int breakpoint_address_match (const address_space *aspace1,
1209 const address_space *aspace2,
1212 extern void until_break_command (const char *, int, int);
1214 /* Initialize a struct bp_location. */
1216 extern void update_breakpoint_locations
1217 (struct breakpoint *b,
1218 struct program_space *filter_pspace,
1219 gdb::array_view<const symtab_and_line> sals,
1220 gdb::array_view<const symtab_and_line> sals_end);
1222 extern void breakpoint_re_set (void);
1224 extern void breakpoint_re_set_thread (struct breakpoint *);
1226 extern struct breakpoint *set_momentary_breakpoint
1227 (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype);
1229 extern struct breakpoint *set_momentary_breakpoint_at_pc
1230 (struct gdbarch *, CORE_ADDR pc, enum bptype type);
1232 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt);
1234 extern void set_ignore_count (int, int, int);
1236 extern void breakpoint_init_inferior (enum inf_context);
1238 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
1240 extern void delete_breakpoint (struct breakpoint *);
1242 extern void breakpoint_auto_delete (bpstat);
1244 typedef void (*walk_bp_location_callback) (struct bp_location *, void *);
1246 extern void iterate_over_bp_locations (walk_bp_location_callback);
1248 /* Return the chain of command lines to execute when this breakpoint
1250 extern struct command_line *breakpoint_commands (struct breakpoint *b);
1252 /* Return a string image of DISP. The string is static, and thus should
1253 NOT be deallocated after use. */
1254 const char *bpdisp_text (enum bpdisp disp);
1256 extern void break_command (char *, int);
1258 extern void hbreak_command_wrapper (char *, int);
1259 extern void thbreak_command_wrapper (char *, int);
1260 extern void rbreak_command_wrapper (char *, int);
1261 extern void watch_command_wrapper (const char *, int, int);
1262 extern void awatch_command_wrapper (const char *, int, int);
1263 extern void rwatch_command_wrapper (const char *, int, int);
1264 extern void tbreak_command (char *, int);
1266 extern struct breakpoint_ops base_breakpoint_ops;
1267 extern struct breakpoint_ops bkpt_breakpoint_ops;
1268 extern struct breakpoint_ops tracepoint_breakpoint_ops;
1269 extern struct breakpoint_ops dprintf_breakpoint_ops;
1271 extern void initialize_breakpoint_ops (void);
1273 /* Arguments to pass as context to some catch command handlers. */
1274 #define CATCH_PERMANENT ((void *) (uintptr_t) 0)
1275 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
1277 /* Like add_cmd, but add the command to both the "catch" and "tcatch"
1278 lists, and pass some additional user data to the command
1282 add_catch_command (const char *name, const char *docstring,
1283 cmd_sfunc_ftype *sfunc,
1284 completer_ftype *completer,
1285 void *user_data_catch,
1286 void *user_data_tcatch);
1288 /* Initialize a breakpoint struct for Ada exception catchpoints. */
1291 init_ada_exception_breakpoint (struct breakpoint *b,
1292 struct gdbarch *gdbarch,
1293 struct symtab_and_line sal,
1294 const char *addr_string,
1295 const struct breakpoint_ops *ops,
1300 extern void init_catchpoint (struct breakpoint *b,
1301 struct gdbarch *gdbarch, int tempflag,
1302 const char *cond_string,
1303 const struct breakpoint_ops *ops);
1305 /* Add breakpoint B on the breakpoint list, and notify the user, the
1306 target and breakpoint_created observers of its existence. If
1307 INTERNAL is non-zero, the breakpoint number will be allocated from
1308 the internal breakpoint count. If UPDATE_GLL is non-zero,
1309 update_global_location_list will be called. */
1311 extern void install_breakpoint (int internal, std::unique_ptr<breakpoint> &&b,
1314 /* Flags that can be passed down to create_breakpoint, etc., to affect
1315 breakpoint creation in several ways. */
1317 enum breakpoint_create_flags
1319 /* We're adding a breakpoint to our tables that is already
1320 inserted in the target. */
1321 CREATE_BREAKPOINT_FLAGS_INSERTED = 1 << 0
1324 /* Set a breakpoint. This function is shared between CLI and MI functions
1325 for setting a breakpoint at LOCATION.
1327 This function has two major modes of operations, selected by the
1328 PARSE_EXTRA parameter.
1330 If PARSE_EXTRA is zero, LOCATION is just the breakpoint's location,
1331 with condition, thread, and extra string specified by the COND_STRING,
1332 THREAD, and EXTRA_STRING parameters.
1334 If PARSE_EXTRA is non-zero, this function will attempt to extract
1335 the condition, thread, and extra string from EXTRA_STRING, ignoring
1336 the similarly named parameters.
1338 If INTERNAL is non-zero, the breakpoint number will be allocated
1339 from the internal breakpoint count.
1341 Returns true if any breakpoint was created; false otherwise. */
1343 extern int create_breakpoint (struct gdbarch *gdbarch,
1344 const struct event_location *location,
1345 const char *cond_string, int thread,
1346 const char *extra_string,
1348 int tempflag, enum bptype wanted_type,
1350 enum auto_boolean pending_break_support,
1351 const struct breakpoint_ops *ops,
1354 int internal, unsigned flags);
1356 extern void insert_breakpoints (void);
1358 extern int remove_breakpoints (void);
1360 extern int remove_breakpoints_pid (int pid);
1362 /* This function can be used to update the breakpoint package's state
1363 after an exec() system call has been executed.
1365 This function causes the following:
1367 - All eventpoints are marked "not inserted".
1368 - All eventpoints with a symbolic address are reset such that
1369 the symbolic address must be reevaluated before the eventpoints
1371 - The solib breakpoints are explicitly removed from the breakpoint
1373 - A step-resume breakpoint, if any, is explicitly removed from the
1375 - All eventpoints without a symbolic address are removed from the
1377 extern void update_breakpoints_after_exec (void);
1379 /* This function can be used to physically remove hardware breakpoints
1380 and watchpoints from the specified traced inferior process, without
1381 modifying the breakpoint package's state. This can be useful for
1382 those targets which support following the processes of a fork() or
1383 vfork() system call, when one of the resulting two processes is to
1384 be detached and allowed to run free.
1386 It is an error to use this function on the process whose id is
1388 extern int detach_breakpoints (ptid_t ptid);
1390 /* This function is called when program space PSPACE is about to be
1391 deleted. It takes care of updating breakpoints to not reference
1392 this PSPACE anymore. */
1393 extern void breakpoint_program_space_exit (struct program_space *pspace);
1395 extern void set_longjmp_breakpoint (struct thread_info *tp,
1396 struct frame_id frame);
1397 extern void delete_longjmp_breakpoint (int thread);
1399 /* Mark all longjmp breakpoints from THREAD for later deletion. */
1400 extern void delete_longjmp_breakpoint_at_next_stop (int thread);
1402 extern struct breakpoint *set_longjmp_breakpoint_for_call_dummy (void);
1403 extern void check_longjmp_breakpoint_for_call_dummy (struct thread_info *tp);
1405 extern void enable_overlay_breakpoints (void);
1406 extern void disable_overlay_breakpoints (void);
1408 extern void set_std_terminate_breakpoint (void);
1409 extern void delete_std_terminate_breakpoint (void);
1411 /* These functions respectively disable or reenable all currently
1412 enabled watchpoints. When disabled, the watchpoints are marked
1413 call_disabled. When re-enabled, they are marked enabled.
1415 The intended client of these functions is call_function_by_hand.
1417 The inferior must be stopped, and all breakpoints removed, when
1418 these functions are used.
1420 The need for these functions is that on some targets (e.g., HP-UX),
1421 gdb is unable to unwind through the dummy frame that is pushed as
1422 part of the implementation of a call command. Watchpoints can
1423 cause the inferior to stop in places where this frame is visible,
1424 and that can cause execution control to become very confused.
1426 Note that if a user sets breakpoints in an interactively called
1427 function, the call_disabled watchpoints will have been re-enabled
1428 when the first such breakpoint is reached. However, on targets
1429 that are unable to unwind through the call dummy frame, watches
1430 of stack-based storage may then be deleted, because gdb will
1431 believe that their watched storage is out of scope. (Sigh.) */
1432 extern void disable_watchpoints_before_interactive_call_start (void);
1434 extern void enable_watchpoints_after_interactive_call_stop (void);
1436 /* These functions disable and re-enable all breakpoints during
1437 inferior startup. They are intended to be called from solib
1438 code where necessary. This is needed on platforms where the
1439 main executable is relocated at some point during startup
1440 processing, making breakpoint addresses invalid.
1442 If additional breakpoints are created after the routine
1443 disable_breakpoints_before_startup but before the routine
1444 enable_breakpoints_after_startup was called, they will also
1445 be marked as disabled. */
1446 extern void disable_breakpoints_before_startup (void);
1447 extern void enable_breakpoints_after_startup (void);
1449 /* For script interpreters that need to define breakpoint commands
1450 after they've already read the commands into a struct
1452 extern enum command_control_type commands_from_control_command
1453 (const char *arg, struct command_line *cmd);
1455 extern void clear_breakpoint_hit_counts (void);
1457 extern struct breakpoint *get_breakpoint (int num);
1459 /* The following are for displays, which aren't really breakpoints,
1460 but here is as good a place as any for them. */
1462 extern void disable_current_display (void);
1464 extern void do_displays (void);
1466 extern void disable_display (int);
1468 extern void clear_displays (void);
1470 extern void disable_breakpoint (struct breakpoint *);
1472 extern void enable_breakpoint (struct breakpoint *);
1474 extern void breakpoint_set_commands (struct breakpoint *b,
1475 command_line_up &&commands);
1477 extern void breakpoint_set_silent (struct breakpoint *b, int silent);
1479 extern void breakpoint_set_thread (struct breakpoint *b, int thread);
1481 extern void breakpoint_set_task (struct breakpoint *b, int task);
1483 /* Clear the "inserted" flag in all breakpoints. */
1484 extern void mark_breakpoints_out (void);
1486 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *,
1489 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *,
1492 /* Create an solib event breakpoint at ADDRESS in the current program
1493 space, and immediately try to insert it. Returns a pointer to the
1494 breakpoint on success. Deletes the new breakpoint and returns NULL
1495 if inserting the breakpoint fails. */
1496 extern struct breakpoint *create_and_insert_solib_event_breakpoint
1497 (struct gdbarch *gdbarch, CORE_ADDR address);
1499 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *,
1502 extern void remove_jit_event_breakpoints (void);
1504 extern void remove_solib_event_breakpoints (void);
1506 /* Mark solib event breakpoints of the current program space with
1507 delete at next stop disposition. */
1508 extern void remove_solib_event_breakpoints_at_next_stop (void);
1510 extern void disable_breakpoints_in_shlibs (void);
1512 /* This function returns TRUE if ep is a catchpoint. */
1513 extern int is_catchpoint (struct breakpoint *);
1515 /* Shared helper function (MI and CLI) for creating and installing
1516 a shared object event catchpoint. */
1517 extern void add_solib_catchpoint (const char *arg, int is_load, int is_temp,
1520 /* Create and insert a new software single step breakpoint for the
1521 current thread. May be called multiple times; each time will add a
1522 new location to the set of potential addresses the next instruction
1524 extern void insert_single_step_breakpoint (struct gdbarch *,
1525 const address_space *,
1528 /* Insert all software single step breakpoints for the current frame.
1529 Return true if any software single step breakpoints are inserted,
1530 otherwise, return false. */
1531 extern int insert_single_step_breakpoints (struct gdbarch *);
1533 /* Check if any hardware watchpoints have triggered, according to the
1535 int watchpoints_triggered (struct target_waitstatus *);
1537 /* Helper for transparent breakpoint hiding for memory read and write
1540 Update one of READBUF or WRITEBUF with either the shadows
1541 (READBUF), or the breakpoint instructions (WRITEBUF) of inserted
1542 breakpoints at the memory range defined by MEMADDR and extending
1543 for LEN bytes. If writing, then WRITEBUF is a copy of WRITEBUF_ORG
1545 extern void breakpoint_xfer_memory (gdb_byte *readbuf, gdb_byte *writebuf,
1546 const gdb_byte *writebuf_org,
1547 ULONGEST memaddr, LONGEST len);
1549 /* Return true if breakpoints should be inserted now. That'll be the
1552 - the target has global breakpoints.
1554 - "breakpoint always-inserted" is on, and the target has
1557 - threads are executing.
1559 extern int breakpoints_should_be_inserted_now (void);
1561 /* Called each time new event from target is processed.
1562 Retires previously deleted breakpoint locations that
1563 in our opinion won't ever trigger. */
1564 extern void breakpoint_retire_moribund (void);
1566 /* Set break condition of breakpoint B to EXP. */
1567 extern void set_breakpoint_condition (struct breakpoint *b, const char *exp,
1570 /* Checks if we are catching syscalls or not.
1571 Returns 0 if not, greater than 0 if we are. */
1572 extern int catch_syscall_enabled (void);
1574 /* Checks if we are catching syscalls with the specific
1575 syscall_number. Used for "filtering" the catchpoints.
1576 Returns 0 if not, greater than 0 if we are. */
1577 extern int catching_syscall_number (int syscall_number);
1579 /* Return a tracepoint with the given number if found. */
1580 extern struct tracepoint *get_tracepoint (int num);
1582 extern struct tracepoint *get_tracepoint_by_number_on_target (int num);
1584 /* Find a tracepoint by parsing a number in the supplied string. */
1585 extern struct tracepoint *
1586 get_tracepoint_by_number (char **arg,
1587 number_or_range_parser *parser);
1589 /* Return a vector of all tracepoints currently defined. The vector
1590 is newly allocated; the caller should free when done with it. */
1591 extern VEC(breakpoint_p) *all_tracepoints (void);
1593 extern int is_tracepoint (const struct breakpoint *b);
1595 /* Return a vector of all static tracepoints defined at ADDR. The
1596 vector is newly allocated; the caller should free when done with
1598 extern VEC(breakpoint_p) *static_tracepoints_here (CORE_ADDR addr);
1600 /* Function that can be passed to read_command_line to validate
1601 that each command is suitable for tracepoint command list. */
1602 extern void check_tracepoint_command (char *line, void *closure);
1604 /* Call at the start and end of an "rbreak" command to register
1605 breakpoint numbers for a later "commands" command. */
1606 extern void start_rbreak_breakpoints (void);
1607 extern void end_rbreak_breakpoints (void);
1609 /* Breakpoint iterator function.
1611 Calls a callback function once for each breakpoint, so long as the
1612 callback function returns false. If the callback function returns
1613 true, the iteration will end and the current breakpoint will be
1614 returned. This can be useful for implementing a search for a
1615 breakpoint with arbitrary attributes, or for applying an operation
1616 to every breakpoint. */
1617 extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *,
1620 /* Nonzero if the specified PC cannot be a location where functions
1621 have been inlined. */
1623 extern int pc_at_non_inline_function (const address_space *aspace,
1625 const struct target_waitstatus *ws);
1627 extern int user_breakpoint_p (struct breakpoint *);
1629 /* Return true if this breakpoint is pending, false if not. */
1630 extern int pending_breakpoint_p (struct breakpoint *);
1632 /* Attempt to determine architecture of location identified by SAL. */
1633 extern struct gdbarch *get_sal_arch (struct symtab_and_line sal);
1635 extern void breakpoint_free_objfile (struct objfile *objfile);
1637 extern const char *ep_parse_optional_if_clause (const char **arg);
1639 /* Print the "Thread ID hit" part of "Thread ID hit Breakpoint N" to
1640 UIOUT iff debugging multiple threads. */
1641 extern void maybe_print_thread_hit_breakpoint (struct ui_out *uiout);
1643 /* Print the specified breakpoint. */
1644 extern void print_breakpoint (breakpoint *bp);
1646 #endif /* !defined (BREAKPOINT_H) */