1 /* Data structures associated with breakpoints in GDB.
2 Copyright (C) 1992-2016 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"
32 struct gdbpy_breakpoint_object;
33 struct gdbscm_breakpoint_object;
34 struct number_or_range_parser;
38 struct linespec_result;
40 struct event_location;
42 /* Why are we removing the breakpoint from the target? */
46 /* A regular remove. Remove the breakpoint and forget everything
50 /* Detach the breakpoints from a fork child. */
54 /* This is the maximum number of bytes a breakpoint instruction can
55 take. Feel free to increase it. It's just used in a few places to
56 size arrays that should be independent of the target
59 #define BREAKPOINT_MAX 16
62 /* Type of breakpoint. */
66 bp_none = 0, /* Eventpoint has been deleted */
67 bp_breakpoint, /* Normal breakpoint */
68 bp_hardware_breakpoint, /* Hardware assisted breakpoint */
69 bp_single_step, /* Software single-step */
70 bp_until, /* used by until command */
71 bp_finish, /* used by finish command */
72 bp_watchpoint, /* Watchpoint */
73 bp_hardware_watchpoint, /* Hardware assisted watchpoint */
74 bp_read_watchpoint, /* read watchpoint, (hardware assisted) */
75 bp_access_watchpoint, /* access watchpoint, (hardware assisted) */
76 bp_longjmp, /* secret breakpoint to find longjmp() */
77 bp_longjmp_resume, /* secret breakpoint to escape longjmp() */
79 /* Breakpoint placed to the same location(s) like bp_longjmp but used to
80 protect against stale DUMMY_FRAME. Multiple bp_longjmp_call_dummy and
81 one bp_call_dummy are chained together by related_breakpoint for each
83 bp_longjmp_call_dummy,
85 /* An internal breakpoint that is installed on the unwinder's
88 /* An internal breakpoint that is set at the point where an
89 exception will land. */
92 /* Used by wait_for_inferior for stepping over subroutine calls,
93 and for skipping prologues. */
96 /* Used by wait_for_inferior for stepping over signal
100 /* Used to detect when a watchpoint expression has gone out of
101 scope. These breakpoints are usually not visible to the user.
103 This breakpoint has some interesting properties:
105 1) There's always a 1:1 mapping between watchpoints
106 on local variables and watchpoint_scope breakpoints.
108 2) It automatically deletes itself and the watchpoint it's
109 associated with when hit.
111 3) It can never be disabled. */
114 /* The breakpoint at the end of a call dummy. See bp_longjmp_call_dummy it
115 is chained with by related_breakpoint. */
118 /* A breakpoint set on std::terminate, that is used to catch
119 otherwise uncaught exceptions thrown during an inferior call. */
122 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
123 code in the inferior to run when significant events occur in the
124 dynamic linker (for example a library is loaded or unloaded).
126 By placing a breakpoint in this magic code GDB will get control
127 when these significant events occur. GDB can then re-examine
128 the dynamic linker's data structures to discover any newly loaded
129 dynamic libraries. */
132 /* Some multi-threaded systems can arrange for a location in the
133 inferior to be executed when certain thread-related events occur
134 (such as thread creation or thread death).
136 By placing a breakpoint at one of these locations, GDB will get
137 control when these events occur. GDB can then update its thread
142 /* On the same principal, an overlay manager can arrange to call a
143 magic location in the inferior whenever there is an interesting
144 change in overlay status. GDB can update its overlay tables
145 and fiddle with breakpoints in overlays when this breakpoint
150 /* Master copies of longjmp breakpoints. These are always installed
151 as soon as an objfile containing longjmp is loaded, but they are
152 always disabled. While necessary, temporary clones of bp_longjmp
153 type will be created and enabled. */
157 /* Master copies of std::terminate breakpoints. */
158 bp_std_terminate_master,
160 /* Like bp_longjmp_master, but for exceptions. */
167 bp_static_tracepoint,
169 /* A dynamic printf stops at the given location, does a formatted
170 print, then automatically continues. (Although this is sort of
171 like a macro packaging up standard breakpoint functionality,
172 GDB doesn't have a way to construct types of breakpoint from
173 elements of behavior.) */
176 /* Event for JIT compiled code generation or deletion. */
179 /* Breakpoint is placed at the STT_GNU_IFUNC resolver. When hit GDB
180 inserts new bp_gnu_ifunc_resolver_return at the caller.
181 bp_gnu_ifunc_resolver is still being kept here as a different thread
182 may still hit it before bp_gnu_ifunc_resolver_return is hit by the
184 bp_gnu_ifunc_resolver,
186 /* On its hit GDB now know the resolved address of the target
187 STT_GNU_IFUNC function. Associated bp_gnu_ifunc_resolver can be
188 deleted now and the breakpoint moved to the target function entry
190 bp_gnu_ifunc_resolver_return,
193 /* States of enablement of breakpoint. */
197 bp_disabled, /* The eventpoint is inactive, and cannot
199 bp_enabled, /* The eventpoint is active, and can
201 bp_call_disabled, /* The eventpoint has been disabled while a
202 call into the inferior is "in flight",
203 because some eventpoints interfere with
204 the implementation of a call on some
205 targets. The eventpoint will be
206 automatically enabled and reset when the
207 call "lands" (either completes, or stops
208 at another eventpoint). */
212 /* Disposition of breakpoint. Ie: what to do after hitting it. */
216 disp_del, /* Delete it */
217 disp_del_at_next_stop, /* Delete at next stop,
218 whether hit or not */
219 disp_disable, /* Disable it */
220 disp_donttouch /* Leave it alone */
223 /* Status of breakpoint conditions used when synchronizing
224 conditions with the target. */
226 enum condition_status
228 condition_unchanged = 0,
233 /* Information used by targets to insert and remove breakpoints. */
235 struct bp_target_info
237 /* Address space at which the breakpoint was placed. */
238 struct address_space *placed_address_space;
240 /* Address at which the breakpoint was placed. This is normally
241 the same as REQUESTED_ADDRESS, except when adjustment happens in
242 gdbarch_breakpoint_from_pc. The most common form of adjustment
243 is stripping an alternate ISA marker from the PC which is used
244 to determine the type of breakpoint to insert. */
245 CORE_ADDR placed_address;
247 /* Address at which the breakpoint was requested. */
248 CORE_ADDR reqstd_address;
250 /* If this is a ranged breakpoint, then this field contains the
251 length of the range that will be watched for execution. */
254 /* If the breakpoint lives in memory and reading that memory would
255 give back the breakpoint, instead of the original contents, then
256 the original contents are cached here. Only SHADOW_LEN bytes of
257 this buffer are valid, and only when the breakpoint is inserted. */
258 gdb_byte shadow_contents[BREAKPOINT_MAX];
260 /* The length of the data cached in SHADOW_CONTENTS. */
263 /* The breakpoint's kind. It is used in 'kind' parameter in Z
267 /* Vector of conditions the target should evaluate if it supports target-side
268 breakpoint conditions. */
269 VEC(agent_expr_p) *conditions;
271 /* Vector of commands the target should evaluate if it supports
272 target-side breakpoint commands. */
273 VEC(agent_expr_p) *tcommands;
275 /* Flag that is true if the breakpoint should be left in place even
276 when GDB is not connected. */
280 /* GDB maintains two types of information about each breakpoint (or
281 watchpoint, or other related event). The first type corresponds
282 to struct breakpoint; this is a relatively high-level structure
283 which contains the source location(s), stopping conditions, user
284 commands to execute when the breakpoint is hit, and so forth.
286 The second type of information corresponds to struct bp_location.
287 Each breakpoint has one or (eventually) more locations associated
288 with it, which represent target-specific and machine-specific
289 mechanisms for stopping the program. For instance, a watchpoint
290 expression may require multiple hardware watchpoints in order to
291 catch all changes in the value of the expression being watched. */
295 bp_loc_software_breakpoint,
296 bp_loc_hardware_breakpoint,
297 bp_loc_hardware_watchpoint,
298 bp_loc_other /* Miscellaneous... */
301 /* This structure is a collection of function pointers that, if
302 available, will be called instead of performing the default action
303 for this bp_loc_type. */
305 struct bp_location_ops
307 /* Destructor. Releases everything from SELF (but not SELF
309 void (*dtor) (struct bp_location *self);
314 /* Chain pointer to the next breakpoint location for
315 the same parent breakpoint. */
316 struct bp_location *next;
318 /* Methods associated with this location. */
319 const struct bp_location_ops *ops;
321 /* The reference count. */
324 /* Type of this breakpoint location. */
325 enum bp_loc_type loc_type;
327 /* Each breakpoint location must belong to exactly one higher-level
328 breakpoint. This pointer is NULL iff this bp_location is no
329 longer attached to a breakpoint. For example, when a breakpoint
330 is deleted, its locations may still be found in the
331 moribund_locations list, or if we had stopped for it, in
333 struct breakpoint *owner;
335 /* Conditional. Break only if this expression's value is nonzero.
336 Unlike string form of condition, which is associated with
337 breakpoint, this is associated with location, since if breakpoint
338 has several locations, the evaluation of expression can be
339 different for different locations. Only valid for real
340 breakpoints; a watchpoint's conditional expression is stored in
341 the owner breakpoint object. */
344 /* Conditional expression in agent expression
345 bytecode form. This is used for stub-side breakpoint
346 condition evaluation. */
347 struct agent_expr *cond_bytecode;
349 /* Signals that the condition has changed since the last time
350 we updated the global location list. This means the condition
351 needs to be sent to the target again. This is used together
352 with target-side breakpoint conditions.
354 condition_unchanged: It means there has been no condition changes.
356 condition_modified: It means this location had its condition modified.
358 condition_updated: It means we already marked all the locations that are
359 duplicates of this location and thus we don't need to call
360 force_breakpoint_reinsertion (...) for this location. */
362 enum condition_status condition_changed;
364 struct agent_expr *cmd_bytecode;
366 /* Signals that breakpoint conditions and/or commands need to be
367 re-synched with the target. This has no use other than
368 target-side breakpoints. */
371 /* This location's address is in an unloaded solib, and so this
372 location should not be inserted. It will be automatically
373 enabled when that solib is loaded. */
376 /* Is this particular location enabled. */
379 /* Nonzero if this breakpoint is now inserted. */
382 /* Nonzero if this is a permanent breakpoint. There is a breakpoint
383 instruction hard-wired into the target's code. Don't try to
384 write another breakpoint instruction on top of it, or restore its
385 value. Step over it using the architecture's
386 gdbarch_skip_permanent_breakpoint method. */
389 /* Nonzero if this is not the first breakpoint in the list
390 for the given address. location of tracepoint can _never_
391 be duplicated with other locations of tracepoints and other
392 kinds of breakpoints, because two locations at the same
393 address may have different actions, so both of these locations
394 should be downloaded and so that `tfind N' always works. */
397 /* If we someday support real thread-specific breakpoints, then
398 the breakpoint location will need a thread identifier. */
400 /* Data for specific breakpoint types. These could be a union, but
401 simplicity is more important than memory usage for breakpoints. */
403 /* Architecture associated with this location's address. May be
404 different from the breakpoint architecture. */
405 struct gdbarch *gdbarch;
407 /* The program space associated with this breakpoint location
408 address. Note that an address space may be represented in more
409 than one program space (e.g. each uClinux program will be given
410 its own program space, but there will only be one address space
411 for all of them), but we must not insert more than one location
412 at the same address in the same address space. */
413 struct program_space *pspace;
415 /* Note that zero is a perfectly valid code address on some platforms
416 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
417 is not a special value for this field. Valid for all types except
421 /* For hardware watchpoints, the size of the memory region being
422 watched. For hardware ranged breakpoints, the size of the
426 /* Type of hardware watchpoint. */
427 enum target_hw_bp_type watchpoint_type;
429 /* For any breakpoint type with an address, this is the section
430 associated with the address. Used primarily for overlay
432 struct obj_section *section;
434 /* Address at which breakpoint was requested, either by the user or
435 by GDB for internal breakpoints. This will usually be the same
436 as ``address'' (above) except for cases in which
437 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
438 which to place the breakpoint in order to comply with a
439 processor's architectual constraints. */
440 CORE_ADDR requested_address;
442 /* An additional address assigned with this location. This is currently
443 only used by STT_GNU_IFUNC resolver breakpoints to hold the address
444 of the resolver function. */
445 CORE_ADDR related_address;
447 /* If the location comes from a probe point, this is the probe associated
449 struct bound_probe probe;
453 /* Details of the placed breakpoint, when inserted. */
454 struct bp_target_info target_info;
456 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
457 struct bp_target_info overlay_target_info;
459 /* In a non-stop mode, it's possible that we delete a breakpoint,
460 but as we do that, some still running thread hits that breakpoint.
461 For that reason, we need to keep locations belonging to deleted
462 breakpoints for a bit, so that don't report unexpected SIGTRAP.
463 We can't keep such locations forever, so we use a heuristic --
464 after we process certain number of inferior events since
465 breakpoint was deleted, we retire all locations of that breakpoint.
466 This variable keeps a number of events still to go, when
467 it becomes 0 this location is retired. */
468 int events_till_retirement;
470 /* Line number which was used to place this location.
472 Breakpoint placed into a comment keeps it's user specified line number
473 despite ADDRESS resolves into a different line number. */
477 /* Symtab which was used to place this location. This is used
478 to find the corresponding source file name. */
480 struct symtab *symtab;
483 /* The possible return values for print_bpstat, print_it_normal,
484 print_it_done, print_it_noop. */
485 enum print_stop_action
487 /* We printed nothing or we need to do some more analysis. */
490 /* We printed something, and we *do* desire that something to be
491 followed by a location. */
494 /* We printed something, and we do *not* desire that something to be
495 followed by a location. */
498 /* We already printed all we needed to print, don't print anything
503 /* This structure is a collection of function pointers that, if available,
504 will be called instead of the performing the default action for this
507 struct breakpoint_ops
509 /* Destructor. Releases everything from SELF (but not SELF
511 void (*dtor) (struct breakpoint *self);
513 /* Allocate a location for this breakpoint. */
514 struct bp_location * (*allocate_location) (struct breakpoint *);
516 /* Reevaluate a breakpoint. This is necessary after symbols change
517 (e.g., an executable or DSO was loaded, or the inferior just
519 void (*re_set) (struct breakpoint *self);
521 /* Insert the breakpoint or watchpoint or activate the catchpoint.
522 Return 0 for success, 1 if the breakpoint, watchpoint or
523 catchpoint type is not supported, -1 for failure. */
524 int (*insert_location) (struct bp_location *);
526 /* Remove the breakpoint/catchpoint that was previously inserted
527 with the "insert" method above. Return 0 for success, 1 if the
528 breakpoint, watchpoint or catchpoint type is not supported,
530 int (*remove_location) (struct bp_location *, enum remove_bp_reason reason);
532 /* Return true if it the target has stopped due to hitting
533 breakpoint location BL. This function does not check if we
534 should stop, only if BL explains the stop. ASPACE is the address
535 space in which the event occurred, BP_ADDR is the address at
536 which the inferior stopped, and WS is the target_waitstatus
537 describing the event. */
538 int (*breakpoint_hit) (const struct bp_location *bl,
539 struct address_space *aspace,
541 const struct target_waitstatus *ws);
543 /* Check internal conditions of the breakpoint referred to by BS.
544 If we should not stop for this breakpoint, set BS->stop to 0. */
545 void (*check_status) (struct bpstats *bs);
547 /* Tell how many hardware resources (debug registers) are needed
548 for this breakpoint. If this function is not provided, then
549 the breakpoint or watchpoint needs one debug register. */
550 int (*resources_needed) (const struct bp_location *);
552 /* Tell whether we can downgrade from a hardware watchpoint to a software
553 one. If not, the user will not be able to enable the watchpoint when
554 there are not enough hardware resources available. */
555 int (*works_in_software_mode) (const struct breakpoint *);
557 /* The normal print routine for this breakpoint, called when we
559 enum print_stop_action (*print_it) (struct bpstats *bs);
561 /* Display information about this breakpoint, for "info
563 void (*print_one) (struct breakpoint *, struct bp_location **);
565 /* Display extra information about this breakpoint, below the normal
566 breakpoint description in "info breakpoints".
568 In the example below, the "address range" line was printed
569 by print_one_detail_ranged_breakpoint.
571 (gdb) info breakpoints
572 Num Type Disp Enb Address What
573 2 hw breakpoint keep y in main at test-watch.c:70
574 address range: [0x10000458, 0x100004c7]
577 void (*print_one_detail) (const struct breakpoint *, struct ui_out *);
579 /* Display information about this breakpoint after setting it
580 (roughly speaking; this is called from "mention"). */
581 void (*print_mention) (struct breakpoint *);
583 /* Print to FP the CLI command that recreates this breakpoint. */
584 void (*print_recreate) (struct breakpoint *, struct ui_file *fp);
586 /* Create SALs from location, storing the result in linespec_result.
588 For an explanation about the arguments, see the function
589 `create_sals_from_location_default'.
591 This function is called inside `create_breakpoint'. */
592 void (*create_sals_from_location) (const struct event_location *location,
593 struct linespec_result *canonical,
594 enum bptype type_wanted);
596 /* This method will be responsible for creating a breakpoint given its SALs.
597 Usually, it just calls `create_breakpoints_sal' (for ordinary
598 breakpoints). However, there may be some special cases where we might
599 need to do some tweaks, e.g., see
600 `strace_marker_create_breakpoints_sal'.
602 This function is called inside `create_breakpoint'. */
603 void (*create_breakpoints_sal) (struct gdbarch *,
604 struct linespec_result *,
606 enum bptype, enum bpdisp, int, int,
607 int, const struct breakpoint_ops *,
608 int, int, int, unsigned);
610 /* Given the location (second parameter), this method decodes it and
611 provides the SAL locations related to it. For ordinary
612 breakpoints, it calls `decode_line_full'. If SEARCH_PSPACE is
613 not NULL, symbol search is restricted to just that program space.
615 This function is called inside `location_to_sals'. */
616 void (*decode_location) (struct breakpoint *b,
617 const struct event_location *location,
618 struct program_space *search_pspace,
619 struct symtabs_and_lines *sals);
621 /* Return true if this breakpoint explains a signal. See
622 bpstat_explains_signal. */
623 int (*explains_signal) (struct breakpoint *, enum gdb_signal);
625 /* Called after evaluating the breakpoint's condition,
626 and only if it evaluated true. */
627 void (*after_condition_true) (struct bpstats *bs);
630 /* Helper for breakpoint_ops->print_recreate implementations. Prints
631 the "thread" or "task" condition of B, and then a newline.
633 Necessary because most breakpoint implementations accept
634 thread/task conditions at the end of the spec line, like "break foo
635 thread 1", which needs outputting before any breakpoint-type
636 specific extra command necessary for B's recreation. */
637 extern void print_recreate_thread (struct breakpoint *b, struct ui_file *fp);
639 enum watchpoint_triggered
641 /* This watchpoint definitely did not trigger. */
642 watch_triggered_no = 0,
644 /* Some hardware watchpoint triggered, and it might have been this
645 one, but we do not know which it was. */
646 watch_triggered_unknown,
648 /* This hardware watchpoint definitely did trigger. */
652 typedef struct bp_location *bp_location_p;
653 DEF_VEC_P(bp_location_p);
655 /* A reference-counted struct command_line. This lets multiple
656 breakpoints share a single command list. This is an implementation
657 detail to the breakpoints module. */
658 struct counted_command_line;
660 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
661 a watchpoint over a memory region. If this flag is true, GDB will use
662 only one register per watchpoint, thus assuming that all acesses that
663 modify a memory location happen at its starting address. */
665 extern int target_exact_watchpoints;
667 /* Note that the ->silent field is not currently used by any commands
668 (though the code is in there if it was to be, and set_raw_breakpoint
669 does set it to 0). I implemented it because I thought it would be
670 useful for a hack I had to put in; I'm going to leave it in because
671 I can see how there might be times when it would indeed be useful */
673 /* This is for all kinds of breakpoints. */
677 /* Methods associated with this breakpoint. */
678 const struct breakpoint_ops *ops;
680 struct breakpoint *next;
681 /* Type of breakpoint. */
683 /* Zero means disabled; remember the info but don't break here. */
684 enum enable_state enable_state;
685 /* What to do with this breakpoint after we hit it. */
686 enum bpdisp disposition;
687 /* Number assigned to distinguish breakpoints. */
690 /* Location(s) associated with this high-level breakpoint. */
691 struct bp_location *loc;
693 /* Non-zero means a silent breakpoint (don't print frame info
695 unsigned char silent;
696 /* Non-zero means display ADDR_STRING to the user verbatim. */
697 unsigned char display_canonical;
698 /* Number of stops at this breakpoint that should
699 be continued automatically before really stopping. */
702 /* Number of stops at this breakpoint before it will be
706 /* Chain of command lines to execute when this breakpoint is
708 struct counted_command_line *commands;
709 /* Stack depth (address of frame). If nonzero, break only if fp
711 struct frame_id frame_id;
713 /* The program space used to set the breakpoint. This is only set
714 for breakpoints which are specific to a program space; for
715 non-thread-specific ordinary breakpoints this is NULL. */
716 struct program_space *pspace;
718 /* Location we used to set the breakpoint (malloc'd). */
719 struct event_location *location;
721 /* The filter that should be passed to decode_line_full when
722 re-setting this breakpoint. This may be NULL, but otherwise is
723 allocated with xmalloc. */
726 /* For a ranged breakpoint, the location we used to find
727 the end of the range (malloc'd). */
728 struct event_location *location_range_end;
730 /* Architecture we used to set the breakpoint. */
731 struct gdbarch *gdbarch;
732 /* Language we used to set the breakpoint. */
733 enum language language;
734 /* Input radix we used to set the breakpoint. */
736 /* String form of the breakpoint condition (malloc'd), or NULL if
737 there is no condition. */
740 /* String form of extra parameters, or NULL if there are none.
744 /* Holds the address of the related watchpoint_scope breakpoint
745 when using watchpoints on local variables (might the concept of
746 a related breakpoint be useful elsewhere, if not just call it
747 the watchpoint_scope breakpoint or something like that.
749 struct breakpoint *related_breakpoint;
751 /* Thread number for thread-specific breakpoint,
752 or -1 if don't care. */
755 /* Ada task number for task-specific breakpoint,
756 or 0 if don't care. */
759 /* Count of the number of times this breakpoint was taken, dumped
760 with the info, but not used for anything else. Useful for
761 seeing how many times you hit a break prior to the program
762 aborting, so you can back up to just before the abort. */
765 /* Is breakpoint's condition not yet parsed because we found
766 no location initially so had no context to parse
768 int condition_not_parsed;
770 /* With a Python scripting enabled GDB, store a reference to the
771 Python object that has been associated with this breakpoint.
772 This is always NULL for a GDB that is not script enabled. It
773 can sometimes be NULL for enabled GDBs as not all breakpoint
774 types are tracked by the scripting language API. */
775 struct gdbpy_breakpoint_object *py_bp_object;
777 /* Same as py_bp_object, but for Scheme. */
778 struct gdbscm_breakpoint_object *scm_bp_object;
781 /* An instance of this type is used to represent a watchpoint. It
782 includes a "struct breakpoint" as a kind of base class; users
783 downcast to "struct breakpoint *" when needed. */
787 /* The base class. */
788 struct breakpoint base;
790 /* String form of exp to use for displaying to the user (malloc'd),
793 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
794 char *exp_string_reparse;
796 /* The expression we are watching, or NULL if not a watchpoint. */
798 /* The largest block within which it is valid, or NULL if it is
799 valid anywhere (e.g. consists just of global symbols). */
800 const struct block *exp_valid_block;
801 /* The conditional expression if any. */
802 expression_up cond_exp;
803 /* The largest block within which it is valid, or NULL if it is
804 valid anywhere (e.g. consists just of global symbols). */
805 const struct block *cond_exp_valid_block;
806 /* Value of the watchpoint the last time we checked it, or NULL when
807 we do not know the value yet or the value was not readable. VAL
810 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
811 then an error occurred reading the value. */
814 /* When watching the location of a bitfield, contains the offset and size of
815 the bitfield. Otherwise contains 0. */
819 /* Holds the frame address which identifies the frame this
820 watchpoint should be evaluated in, or `null' if the watchpoint
821 should be evaluated on the outermost frame. */
822 struct frame_id watchpoint_frame;
824 /* Holds the thread which identifies the frame this watchpoint
825 should be considered in scope for, or `null_ptid' if the
826 watchpoint should be evaluated in all threads. */
827 ptid_t watchpoint_thread;
829 /* For hardware watchpoints, the triggered status according to the
831 enum watchpoint_triggered watchpoint_triggered;
833 /* Whether this watchpoint is exact (see
834 target_exact_watchpoints). */
837 /* The mask address for a masked hardware watchpoint. */
838 CORE_ADDR hw_wp_mask;
841 /* Given a function FUNC (struct breakpoint *B, void *DATA) and
842 USER_DATA, call FUNC for every known breakpoint passing USER_DATA
845 If FUNC returns 1, the loop stops and the current
846 'struct breakpoint' being processed is returned. If FUNC returns
847 zero, the loop continues.
849 This function returns either a 'struct breakpoint' pointer or NULL.
850 It was based on BFD's bfd_sections_find_if function. */
852 extern struct breakpoint *breakpoint_find_if
853 (int (*func) (struct breakpoint *b, void *d), void *user_data);
855 /* Return true if BPT is either a software breakpoint or a hardware
858 extern int is_breakpoint (const struct breakpoint *bpt);
860 /* Returns true if BPT is really a watchpoint. */
862 extern int is_watchpoint (const struct breakpoint *bpt);
864 /* An instance of this type is used to represent all kinds of
865 tracepoints. It includes a "struct breakpoint" as a kind of base
866 class; users downcast to "struct breakpoint *" when needed. */
870 /* The base class. */
871 struct breakpoint base;
873 /* Number of times this tracepoint should single-step and collect
877 /* Number of times this tracepoint should be hit before
881 /* The number of the tracepoint on the target. */
882 int number_on_target;
884 /* The total space taken by all the trace frames for this
886 ULONGEST traceframe_usage;
888 /* The static tracepoint marker id, if known. */
889 char *static_trace_marker_id;
891 /* LTTng/UST allow more than one marker with the same ID string,
892 although it unadvised because it confuses tools. When setting
893 static tracepoints by marker ID, this will record the index in
894 the array of markers we found for the given marker ID for which
895 this static tracepoint corresponds. When resetting breakpoints,
896 we will use this index to try to find the same marker again. */
897 int static_trace_marker_id_idx;
900 typedef struct breakpoint *breakpoint_p;
901 DEF_VEC_P(breakpoint_p);
903 /* The following stuff is an abstract data type "bpstat" ("breakpoint
904 status"). This provides the ability to determine whether we have
905 stopped at a breakpoint, and what we should do about it. */
907 typedef struct bpstats *bpstat;
909 /* Clears a chain of bpstat, freeing storage
911 extern void bpstat_clear (bpstat *);
913 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
914 is part of the bpstat is copied as well. */
915 extern bpstat bpstat_copy (bpstat);
917 extern bpstat bpstat_stop_status (struct address_space *aspace,
918 CORE_ADDR pc, ptid_t ptid,
919 const struct target_waitstatus *ws);
921 /* This bpstat_what stuff tells wait_for_inferior what to do with a
922 breakpoint (a challenging task).
924 The enum values order defines priority-like order of the actions.
925 Once you've decided that some action is appropriate, you'll never
926 go back and decide something of a lower priority is better. Each
927 of these actions is mutually exclusive with the others. That
928 means, that if you find yourself adding a new action class here and
929 wanting to tell GDB that you have two simultaneous actions to
930 handle, something is wrong, and you probably don't actually need a
933 Note that a step resume breakpoint overrides another breakpoint of
934 signal handling (see comment in wait_for_inferior at where we set
935 the step_resume breakpoint). */
937 enum bpstat_what_main_action
939 /* Perform various other tests; that is, this bpstat does not
940 say to perform any action (e.g. failed watchpoint and nothing
942 BPSTAT_WHAT_KEEP_CHECKING,
944 /* Remove breakpoints, single step once, then put them back in and
945 go back to what we were doing. It's possible that this should
946 be removed from the main_action and put into a separate field,
947 to more cleanly handle
948 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
951 /* Set longjmp_resume breakpoint, remove all other breakpoints,
952 and continue. The "remove all other breakpoints" part is
953 required if we are also stepping over another breakpoint as
954 well as doing the longjmp handling. */
955 BPSTAT_WHAT_SET_LONGJMP_RESUME,
957 /* Clear longjmp_resume breakpoint, then handle as
958 BPSTAT_WHAT_KEEP_CHECKING. */
959 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
961 /* Clear step resume breakpoint, and keep checking. */
962 BPSTAT_WHAT_STEP_RESUME,
964 /* Rather than distinguish between noisy and silent stops here, it
965 might be cleaner to have bpstat_print make that decision (also
966 taking into account stop_print_frame and source_only). But the
967 implications are a bit scary (interaction with auto-displays,
968 etc.), so I won't try it. */
971 BPSTAT_WHAT_STOP_SILENT,
973 /* Stop and print. */
974 BPSTAT_WHAT_STOP_NOISY,
976 /* Clear step resume breakpoint, and keep checking. High-priority
977 step-resume breakpoints are used when even if there's a user
978 breakpoint at the current PC when we set the step-resume
979 breakpoint, we don't want to re-handle any breakpoint other
980 than the step-resume when it's hit; instead we want to move
981 past the breakpoint. This is used in the case of skipping
983 BPSTAT_WHAT_HP_STEP_RESUME,
986 /* An enum indicating the kind of "stack dummy" stop. This is a bit
987 of a misnomer because only one kind of truly a stack dummy. */
990 /* We didn't stop at a stack dummy breakpoint. */
993 /* Stopped at a stack dummy. */
996 /* Stopped at std::terminate. */
1002 enum bpstat_what_main_action main_action;
1004 /* Did we hit a call dummy breakpoint? This only goes with a
1005 main_action of BPSTAT_WHAT_STOP_SILENT or
1006 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
1007 dummy without popping the frame is not a useful one). */
1008 enum stop_stack_kind call_dummy;
1010 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
1011 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
1012 longjmp, false if we are handling an exception. */
1016 /* Tell what to do about this bpstat. */
1017 struct bpstat_what bpstat_what (bpstat);
1019 /* Run breakpoint event callbacks associated with the breakpoints that
1021 extern void bpstat_run_callbacks (bpstat bs_head);
1023 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
1024 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
1026 /* Nonzero if a signal that we got in target_wait() was due to
1027 circumstances explained by the bpstat; the signal is therefore not
1029 extern int bpstat_explains_signal (bpstat, enum gdb_signal);
1031 /* Nonzero is this bpstat causes a stop. */
1032 extern int bpstat_causes_stop (bpstat);
1034 /* Nonzero if we should step constantly (e.g. watchpoints on machines
1035 without hardware support). This isn't related to a specific bpstat,
1036 just to things like whether watchpoints are set. */
1037 extern int bpstat_should_step (void);
1039 /* Print a message indicating what happened. Returns nonzero to
1040 say that only the source line should be printed after this (zero
1041 return means print the frame as well as the source line). */
1042 extern enum print_stop_action bpstat_print (bpstat, int);
1044 /* Put in *NUM the breakpoint number of the first breakpoint we are
1045 stopped at. *BSP upon return is a bpstat which points to the
1046 remaining breakpoints stopped at (but which is not guaranteed to be
1047 good for anything but further calls to bpstat_num).
1049 Return 0 if passed a bpstat which does not indicate any breakpoints.
1050 Return -1 if stopped at a breakpoint that has been deleted since
1052 Return 1 otherwise. */
1053 extern int bpstat_num (bpstat *, int *);
1055 /* Perform actions associated with the stopped inferior. Actually, we
1056 just use this for breakpoint commands. Perhaps other actions will
1057 go here later, but this is executed at a late time (from the
1059 extern void bpstat_do_actions (void);
1061 /* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will
1062 not be performed. */
1063 extern void bpstat_clear_actions (void);
1065 /* Implementation: */
1067 /* Values used to tell the printing routine how to behave for this
1071 /* This is used when we want to do a normal printing of the reason
1072 for stopping. The output will depend on the type of eventpoint
1073 we are dealing with. This is the default value, most commonly
1076 /* This is used when nothing should be printed for this bpstat
1079 /* This is used when everything which needs to be printed has
1080 already been printed. But we still want to print the frame. */
1086 /* Linked list because there can be more than one breakpoint at
1087 the same place, and a bpstat reflects the fact that all have
1091 /* Location that caused the stop. Locations are refcounted, so
1092 this will never be NULL. Note that this location may end up
1093 detached from a breakpoint, but that does not necessary mean
1094 that the struct breakpoint is gone. E.g., consider a
1095 watchpoint with a condition that involves an inferior function
1096 call. Watchpoint locations are recreated often (on resumes,
1097 hence on infcalls too). Between creating the bpstat and after
1098 evaluating the watchpoint condition, this location may hence
1099 end up detached from its original owner watchpoint, even though
1100 the watchpoint is still listed. If it's condition evaluates as
1101 true, we still want this location to cause a stop, and we will
1102 still need to know which watchpoint it was originally attached.
1103 What this means is that we should not (in most cases) follow
1104 the `bpstat->bp_location->owner' link, but instead use the
1105 `breakpoint_at' field below. */
1106 struct bp_location *bp_location_at;
1108 /* Breakpoint that caused the stop. This is nullified if the
1109 breakpoint ends up being deleted. See comments on
1110 `bp_location_at' above for why do we need this field instead of
1111 following the location's owner. */
1112 struct breakpoint *breakpoint_at;
1114 /* The associated command list. */
1115 struct counted_command_line *commands;
1117 /* Old value associated with a watchpoint. */
1118 struct value *old_val;
1120 /* Nonzero if this breakpoint tells us to print the frame. */
1123 /* Nonzero if this breakpoint tells us to stop. */
1126 /* Tell bpstat_print and print_bp_stop_message how to print stuff
1127 associated with this element of the bpstat chain. */
1128 enum bp_print_how print_it;
1139 /* The possible return values for breakpoint_here_p.
1140 We guarantee that zero always means "no breakpoint here". */
1141 enum breakpoint_here
1143 no_breakpoint_here = 0,
1144 ordinary_breakpoint_here,
1145 permanent_breakpoint_here
1149 /* Prototypes for breakpoint-related functions. */
1151 /* Return 1 if there's a program/permanent breakpoint planted in
1152 memory at ADDRESS, return 0 otherwise. */
1154 extern int program_breakpoint_here_p (struct gdbarch *gdbarch, CORE_ADDR address);
1156 extern enum breakpoint_here breakpoint_here_p (struct address_space *,
1159 /* Return true if an enabled breakpoint exists in the range defined by
1160 ADDR and LEN, in ASPACE. */
1161 extern int breakpoint_in_range_p (struct address_space *aspace,
1162 CORE_ADDR addr, ULONGEST len);
1164 extern int moribund_breakpoint_here_p (struct address_space *, CORE_ADDR);
1166 extern int breakpoint_inserted_here_p (struct address_space *, CORE_ADDR);
1168 extern int regular_breakpoint_inserted_here_p (struct address_space *,
1171 extern int software_breakpoint_inserted_here_p (struct address_space *,
1174 /* Return non-zero iff there is a hardware breakpoint inserted at
1176 extern int hardware_breakpoint_inserted_here_p (struct address_space *,
1179 /* Check whether any location of BP is inserted at PC. */
1181 extern int breakpoint_has_location_inserted_here (struct breakpoint *bp,
1182 struct address_space *aspace,
1185 extern int single_step_breakpoint_inserted_here_p (struct address_space *,
1188 /* Returns true if there's a hardware watchpoint or access watchpoint
1189 inserted in the range defined by ADDR and LEN. */
1190 extern int hardware_watchpoint_inserted_in_range (struct address_space *,
1194 /* Returns true if {ASPACE1,ADDR1} and {ASPACE2,ADDR2} represent the
1195 same breakpoint location. In most targets, this can only be true
1196 if ASPACE1 matches ASPACE2. On targets that have global
1197 breakpoints, the address space doesn't really matter. */
1199 extern int breakpoint_address_match (struct address_space *aspace1,
1201 struct address_space *aspace2,
1204 extern void until_break_command (char *, int, int);
1206 /* Initialize a struct bp_location. */
1208 extern void init_bp_location (struct bp_location *loc,
1209 const struct bp_location_ops *ops,
1210 struct breakpoint *owner);
1212 extern void update_breakpoint_locations (struct breakpoint *b,
1213 struct program_space *filter_pspace,
1214 struct symtabs_and_lines sals,
1215 struct symtabs_and_lines sals_end);
1217 extern void breakpoint_re_set (void);
1219 extern void breakpoint_re_set_thread (struct breakpoint *);
1221 extern struct breakpoint *set_momentary_breakpoint
1222 (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype);
1224 extern struct breakpoint *set_momentary_breakpoint_at_pc
1225 (struct gdbarch *, CORE_ADDR pc, enum bptype type);
1227 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt);
1229 extern void set_ignore_count (int, int, int);
1231 extern void breakpoint_init_inferior (enum inf_context);
1233 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
1235 extern void delete_breakpoint (struct breakpoint *);
1237 extern void breakpoint_auto_delete (bpstat);
1239 typedef void (*walk_bp_location_callback) (struct bp_location *, void *);
1241 extern void iterate_over_bp_locations (walk_bp_location_callback);
1243 /* Return the chain of command lines to execute when this breakpoint
1245 extern struct command_line *breakpoint_commands (struct breakpoint *b);
1247 /* Return a string image of DISP. The string is static, and thus should
1248 NOT be deallocated after use. */
1249 const char *bpdisp_text (enum bpdisp disp);
1251 extern void break_command (char *, int);
1253 extern void hbreak_command_wrapper (char *, int);
1254 extern void thbreak_command_wrapper (char *, int);
1255 extern void rbreak_command_wrapper (char *, int);
1256 extern void watch_command_wrapper (char *, int, int);
1257 extern void awatch_command_wrapper (char *, int, int);
1258 extern void rwatch_command_wrapper (char *, int, int);
1259 extern void tbreak_command (char *, int);
1261 extern struct breakpoint_ops base_breakpoint_ops;
1262 extern struct breakpoint_ops bkpt_breakpoint_ops;
1263 extern struct breakpoint_ops tracepoint_breakpoint_ops;
1264 extern struct breakpoint_ops dprintf_breakpoint_ops;
1266 extern void initialize_breakpoint_ops (void);
1268 /* Arguments to pass as context to some catch command handlers. */
1269 #define CATCH_PERMANENT ((void *) (uintptr_t) 0)
1270 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
1272 /* Like add_cmd, but add the command to both the "catch" and "tcatch"
1273 lists, and pass some additional user data to the command
1277 add_catch_command (char *name, char *docstring,
1278 cmd_sfunc_ftype *sfunc,
1279 completer_ftype *completer,
1280 void *user_data_catch,
1281 void *user_data_tcatch);
1283 /* Initialize a breakpoint struct for Ada exception catchpoints. */
1286 init_ada_exception_breakpoint (struct breakpoint *b,
1287 struct gdbarch *gdbarch,
1288 struct symtab_and_line sal,
1290 const struct breakpoint_ops *ops,
1295 extern void init_catchpoint (struct breakpoint *b,
1296 struct gdbarch *gdbarch, int tempflag,
1298 const struct breakpoint_ops *ops);
1300 /* Add breakpoint B on the breakpoint list, and notify the user, the
1301 target and breakpoint_created observers of its existence. If
1302 INTERNAL is non-zero, the breakpoint number will be allocated from
1303 the internal breakpoint count. If UPDATE_GLL is non-zero,
1304 update_global_location_list will be called. */
1306 extern void install_breakpoint (int internal, struct breakpoint *b,
1309 /* Flags that can be passed down to create_breakpoint, etc., to affect
1310 breakpoint creation in several ways. */
1312 enum breakpoint_create_flags
1314 /* We're adding a breakpoint to our tables that is already
1315 inserted in the target. */
1316 CREATE_BREAKPOINT_FLAGS_INSERTED = 1 << 0
1319 /* Set a breakpoint. This function is shared between CLI and MI functions
1320 for setting a breakpoint at LOCATION.
1322 This function has two major modes of operations, selected by the
1323 PARSE_EXTRA parameter.
1325 If PARSE_EXTRA is zero, LOCATION is just the breakpoint's location,
1326 with condition, thread, and extra string specified by the COND_STRING,
1327 THREAD, and EXTRA_STRING parameters.
1329 If PARSE_EXTRA is non-zero, this function will attempt to extract
1330 the condition, thread, and extra string from EXTRA_STRING, ignoring
1331 the similarly named parameters.
1333 If INTERNAL is non-zero, the breakpoint number will be allocated
1334 from the internal breakpoint count.
1336 Returns true if any breakpoint was created; false otherwise. */
1338 extern int create_breakpoint (struct gdbarch *gdbarch,
1339 const struct event_location *location,
1340 char *cond_string, int thread,
1343 int tempflag, enum bptype wanted_type,
1345 enum auto_boolean pending_break_support,
1346 const struct breakpoint_ops *ops,
1349 int internal, unsigned flags);
1351 extern void insert_breakpoints (void);
1353 extern int remove_breakpoints (void);
1355 extern int remove_breakpoints_pid (int pid);
1357 /* This function can be used to physically insert eventpoints from the
1358 specified traced inferior process, without modifying the breakpoint
1359 package's state. This can be useful for those targets which
1360 support following the processes of a fork() or vfork() system call,
1361 when both of the resulting two processes are to be followed. */
1362 extern int reattach_breakpoints (int);
1364 /* This function can be used to update the breakpoint package's state
1365 after an exec() system call has been executed.
1367 This function causes the following:
1369 - All eventpoints are marked "not inserted".
1370 - All eventpoints with a symbolic address are reset such that
1371 the symbolic address must be reevaluated before the eventpoints
1373 - The solib breakpoints are explicitly removed from the breakpoint
1375 - A step-resume breakpoint, if any, is explicitly removed from the
1377 - All eventpoints without a symbolic address are removed from the
1379 extern void update_breakpoints_after_exec (void);
1381 /* This function can be used to physically remove hardware breakpoints
1382 and watchpoints from the specified traced inferior process, without
1383 modifying the breakpoint package's state. This can be useful for
1384 those targets which support following the processes of a fork() or
1385 vfork() system call, when one of the resulting two processes is to
1386 be detached and allowed to run free.
1388 It is an error to use this function on the process whose id is
1390 extern int detach_breakpoints (ptid_t ptid);
1392 /* This function is called when program space PSPACE is about to be
1393 deleted. It takes care of updating breakpoints to not reference
1394 this PSPACE anymore. */
1395 extern void breakpoint_program_space_exit (struct program_space *pspace);
1397 extern void set_longjmp_breakpoint (struct thread_info *tp,
1398 struct frame_id frame);
1399 extern void delete_longjmp_breakpoint (int thread);
1401 /* Mark all longjmp breakpoints from THREAD for later deletion. */
1402 extern void delete_longjmp_breakpoint_at_next_stop (int thread);
1404 extern struct breakpoint *set_longjmp_breakpoint_for_call_dummy (void);
1405 extern void check_longjmp_breakpoint_for_call_dummy (struct thread_info *tp);
1407 extern void enable_overlay_breakpoints (void);
1408 extern void disable_overlay_breakpoints (void);
1410 extern void set_std_terminate_breakpoint (void);
1411 extern void delete_std_terminate_breakpoint (void);
1413 /* These functions respectively disable or reenable all currently
1414 enabled watchpoints. When disabled, the watchpoints are marked
1415 call_disabled. When re-enabled, they are marked enabled.
1417 The intended client of these functions is call_function_by_hand.
1419 The inferior must be stopped, and all breakpoints removed, when
1420 these functions are used.
1422 The need for these functions is that on some targets (e.g., HP-UX),
1423 gdb is unable to unwind through the dummy frame that is pushed as
1424 part of the implementation of a call command. Watchpoints can
1425 cause the inferior to stop in places where this frame is visible,
1426 and that can cause execution control to become very confused.
1428 Note that if a user sets breakpoints in an interactively called
1429 function, the call_disabled watchpoints will have been re-enabled
1430 when the first such breakpoint is reached. However, on targets
1431 that are unable to unwind through the call dummy frame, watches
1432 of stack-based storage may then be deleted, because gdb will
1433 believe that their watched storage is out of scope. (Sigh.) */
1434 extern void disable_watchpoints_before_interactive_call_start (void);
1436 extern void enable_watchpoints_after_interactive_call_stop (void);
1438 /* These functions disable and re-enable all breakpoints during
1439 inferior startup. They are intended to be called from solib
1440 code where necessary. This is needed on platforms where the
1441 main executable is relocated at some point during startup
1442 processing, making breakpoint addresses invalid.
1444 If additional breakpoints are created after the routine
1445 disable_breakpoints_before_startup but before the routine
1446 enable_breakpoints_after_startup was called, they will also
1447 be marked as disabled. */
1448 extern void disable_breakpoints_before_startup (void);
1449 extern void enable_breakpoints_after_startup (void);
1451 /* For script interpreters that need to define breakpoint commands
1452 after they've already read the commands into a struct
1454 extern enum command_control_type commands_from_control_command
1455 (const char *arg, struct command_line *cmd);
1457 extern void clear_breakpoint_hit_counts (void);
1459 extern struct breakpoint *get_breakpoint (int num);
1461 /* The following are for displays, which aren't really breakpoints,
1462 but here is as good a place as any for them. */
1464 extern void disable_current_display (void);
1466 extern void do_displays (void);
1468 extern void disable_display (int);
1470 extern void clear_displays (void);
1472 extern void disable_breakpoint (struct breakpoint *);
1474 extern void enable_breakpoint (struct breakpoint *);
1476 extern void breakpoint_set_commands (struct breakpoint *b,
1477 struct command_line *commands);
1479 extern void breakpoint_set_silent (struct breakpoint *b, int silent);
1481 extern void breakpoint_set_thread (struct breakpoint *b, int thread);
1483 extern void breakpoint_set_task (struct breakpoint *b, int task);
1485 /* Clear the "inserted" flag in all breakpoints. */
1486 extern void mark_breakpoints_out (void);
1488 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *,
1491 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *,
1494 /* Create an solib event breakpoint at ADDRESS in the current program
1495 space, and immediately try to insert it. Returns a pointer to the
1496 breakpoint on success. Deletes the new breakpoint and returns NULL
1497 if inserting the breakpoint fails. */
1498 extern struct breakpoint *create_and_insert_solib_event_breakpoint
1499 (struct gdbarch *gdbarch, CORE_ADDR address);
1501 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *,
1504 extern void remove_jit_event_breakpoints (void);
1506 extern void remove_solib_event_breakpoints (void);
1508 /* Mark solib event breakpoints of the current program space with
1509 delete at next stop disposition. */
1510 extern void remove_solib_event_breakpoints_at_next_stop (void);
1512 extern void disable_breakpoints_in_shlibs (void);
1514 /* This function returns TRUE if ep is a catchpoint. */
1515 extern int is_catchpoint (struct breakpoint *);
1517 /* Shared helper function (MI and CLI) for creating and installing
1518 a shared object event catchpoint. */
1519 extern void add_solib_catchpoint (char *arg, int is_load, int is_temp,
1522 /* Enable breakpoints and delete when hit. Called with ARG == NULL
1523 deletes all breakpoints. */
1524 extern void delete_command (char *arg, int from_tty);
1526 /* Create and insert a new software single step breakpoint for the
1527 current thread. May be called multiple times; each time will add a
1528 new location to the set of potential addresses the next instruction
1530 extern void insert_single_step_breakpoint (struct gdbarch *,
1531 struct address_space *,
1534 /* Insert all software single step breakpoints for the current frame.
1535 Return true if any software single step breakpoints are inserted,
1536 otherwise, return false. */
1537 extern int insert_single_step_breakpoints (struct gdbarch *);
1539 /* Check if any hardware watchpoints have triggered, according to the
1541 int watchpoints_triggered (struct target_waitstatus *);
1543 /* Helper for transparent breakpoint hiding for memory read and write
1546 Update one of READBUF or WRITEBUF with either the shadows
1547 (READBUF), or the breakpoint instructions (WRITEBUF) of inserted
1548 breakpoints at the memory range defined by MEMADDR and extending
1549 for LEN bytes. If writing, then WRITEBUF is a copy of WRITEBUF_ORG
1551 extern void breakpoint_xfer_memory (gdb_byte *readbuf, gdb_byte *writebuf,
1552 const gdb_byte *writebuf_org,
1553 ULONGEST memaddr, LONGEST len);
1555 /* Return true if breakpoints should be inserted now. That'll be the
1558 - the target has global breakpoints.
1560 - "breakpoint always-inserted" is on, and the target has
1563 - threads are executing.
1565 extern int breakpoints_should_be_inserted_now (void);
1567 /* Called each time new event from target is processed.
1568 Retires previously deleted breakpoint locations that
1569 in our opinion won't ever trigger. */
1570 extern void breakpoint_retire_moribund (void);
1572 /* Set break condition of breakpoint B to EXP. */
1573 extern void set_breakpoint_condition (struct breakpoint *b, const char *exp,
1576 /* Checks if we are catching syscalls or not.
1577 Returns 0 if not, greater than 0 if we are. */
1578 extern int catch_syscall_enabled (void);
1580 /* Checks if we are catching syscalls with the specific
1581 syscall_number. Used for "filtering" the catchpoints.
1582 Returns 0 if not, greater than 0 if we are. */
1583 extern int catching_syscall_number (int syscall_number);
1585 /* Return a tracepoint with the given number if found. */
1586 extern struct tracepoint *get_tracepoint (int num);
1588 extern struct tracepoint *get_tracepoint_by_number_on_target (int num);
1590 /* Find a tracepoint by parsing a number in the supplied string. */
1591 extern struct tracepoint *
1592 get_tracepoint_by_number (char **arg,
1593 number_or_range_parser *parser);
1595 /* Return a vector of all tracepoints currently defined. The vector
1596 is newly allocated; the caller should free when done with it. */
1597 extern VEC(breakpoint_p) *all_tracepoints (void);
1599 extern int is_tracepoint (const struct breakpoint *b);
1601 /* Return a vector of all static tracepoints defined at ADDR. The
1602 vector is newly allocated; the caller should free when done with
1604 extern VEC(breakpoint_p) *static_tracepoints_here (CORE_ADDR addr);
1606 /* Function that can be passed to read_command_line to validate
1607 that each command is suitable for tracepoint command list. */
1608 extern void check_tracepoint_command (char *line, void *closure);
1610 /* Call at the start and end of an "rbreak" command to register
1611 breakpoint numbers for a later "commands" command. */
1612 extern void start_rbreak_breakpoints (void);
1613 extern void end_rbreak_breakpoints (void);
1615 /* Breakpoint iterator function.
1617 Calls a callback function once for each breakpoint, so long as the
1618 callback function returns false. If the callback function returns
1619 true, the iteration will end and the current breakpoint will be
1620 returned. This can be useful for implementing a search for a
1621 breakpoint with arbitrary attributes, or for applying an operation
1622 to every breakpoint. */
1623 extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *,
1626 /* Nonzero if the specified PC cannot be a location where functions
1627 have been inlined. */
1629 extern int pc_at_non_inline_function (struct address_space *aspace,
1631 const struct target_waitstatus *ws);
1633 extern int user_breakpoint_p (struct breakpoint *);
1635 /* Return true if this breakpoint is pending, false if not. */
1636 extern int pending_breakpoint_p (struct breakpoint *);
1638 /* Attempt to determine architecture of location identified by SAL. */
1639 extern struct gdbarch *get_sal_arch (struct symtab_and_line sal);
1641 extern void breakpoint_free_objfile (struct objfile *objfile);
1643 extern char *ep_parse_optional_if_clause (char **arg);
1645 /* Print the "Thread ID hit" part of "Thread ID hit Breakpoint N" to
1646 UIOUT iff debugging multiple threads. */
1647 extern void maybe_print_thread_hit_breakpoint (struct ui_out *uiout);
1649 #endif /* !defined (BREAKPOINT_H) */