1 /* Data structures associated with breakpoints in GDB.
2 Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
3 2002, 2003, 2004, 2007, 2008, 2009, 2010, 2011
4 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #if !defined (BREAKPOINT_H)
22 #define BREAKPOINT_H 1
30 struct breakpoint_object;
31 struct get_number_or_range_state;
36 /* This is the maximum number of bytes a breakpoint instruction can
37 take. Feel free to increase it. It's just used in a few places to
38 size arrays that should be independent of the target
41 #define BREAKPOINT_MAX 16
44 /* Type of breakpoint. */
45 /* FIXME In the future, we should fold all other breakpoint-like
46 things into here. This includes:
48 * single-step (for machines where we have to simulate single
49 stepping) (probably, though perhaps it is better for it to look as
50 much as possible like a single-step to wait_for_inferior). */
54 bp_none = 0, /* Eventpoint has been deleted */
55 bp_breakpoint, /* Normal breakpoint */
56 bp_hardware_breakpoint, /* Hardware assisted breakpoint */
57 bp_until, /* used by until command */
58 bp_finish, /* used by finish command */
59 bp_watchpoint, /* Watchpoint */
60 bp_hardware_watchpoint, /* Hardware assisted watchpoint */
61 bp_read_watchpoint, /* read watchpoint, (hardware assisted) */
62 bp_access_watchpoint, /* access watchpoint, (hardware assisted) */
63 bp_longjmp, /* secret breakpoint to find longjmp() */
64 bp_longjmp_resume, /* secret breakpoint to escape longjmp() */
66 /* An internal breakpoint that is installed on the unwinder's
69 /* An internal breakpoint that is set at the point where an
70 exception will land. */
73 /* Used by wait_for_inferior for stepping over subroutine calls,
74 and for skipping prologues. */
77 /* Used by wait_for_inferior for stepping over signal
81 /* Used to detect when a watchpoint expression has gone out of
82 scope. These breakpoints are usually not visible to the user.
84 This breakpoint has some interesting properties:
86 1) There's always a 1:1 mapping between watchpoints
87 on local variables and watchpoint_scope breakpoints.
89 2) It automatically deletes itself and the watchpoint it's
90 associated with when hit.
92 3) It can never be disabled. */
95 /* The breakpoint at the end of a call dummy. */
96 /* FIXME: What if the function we are calling longjmp()s out of
97 the call, or the user gets out with the "return" command? We
98 currently have no way of cleaning up the breakpoint in these
99 (obscure) situations. (Probably can solve this by noticing
100 longjmp, "return", etc., it's similar to noticing when a
101 watchpoint on a local variable goes out of scope (with hardware
102 support for watchpoints)). */
105 /* A breakpoint set on std::terminate, that is used to catch
106 otherwise uncaught exceptions thrown during an inferior call. */
109 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
110 code in the inferior to run when significant events occur in the
111 dynamic linker (for example a library is loaded or unloaded).
113 By placing a breakpoint in this magic code GDB will get control
114 when these significant events occur. GDB can then re-examine
115 the dynamic linker's data structures to discover any newly loaded
116 dynamic libraries. */
119 /* Some multi-threaded systems can arrange for a location in the
120 inferior to be executed when certain thread-related events occur
121 (such as thread creation or thread death).
123 By placing a breakpoint at one of these locations, GDB will get
124 control when these events occur. GDB can then update its thread
129 /* On the same principal, an overlay manager can arrange to call a
130 magic location in the inferior whenever there is an interesting
131 change in overlay status. GDB can update its overlay tables
132 and fiddle with breakpoints in overlays when this breakpoint
137 /* Master copies of longjmp breakpoints. These are always installed
138 as soon as an objfile containing longjmp is loaded, but they are
139 always disabled. While necessary, temporary clones of bp_longjmp
140 type will be created and enabled. */
144 /* Master copies of std::terminate breakpoints. */
145 bp_std_terminate_master,
147 /* Like bp_longjmp_master, but for exceptions. */
154 bp_static_tracepoint,
156 /* Event for JIT compiled code generation or deletion. */
159 /* Breakpoint is placed at the STT_GNU_IFUNC resolver. When hit GDB
160 inserts new bp_gnu_ifunc_resolver_return at the caller.
161 bp_gnu_ifunc_resolver is still being kept here as a different thread
162 may still hit it before bp_gnu_ifunc_resolver_return is hit by the
164 bp_gnu_ifunc_resolver,
166 /* On its hit GDB now know the resolved address of the target
167 STT_GNU_IFUNC function. Associated bp_gnu_ifunc_resolver can be
168 deleted now and the breakpoint moved to the target function entry
170 bp_gnu_ifunc_resolver_return,
173 /* States of enablement of breakpoint. */
177 bp_disabled, /* The eventpoint is inactive, and cannot
179 bp_enabled, /* The eventpoint is active, and can
181 bp_call_disabled, /* The eventpoint has been disabled while a
182 call into the inferior is "in flight",
183 because some eventpoints interfere with
184 the implementation of a call on some
185 targets. The eventpoint will be
186 automatically enabled and reset when the
187 call "lands" (either completes, or stops
188 at another eventpoint). */
189 bp_permanent /* There is a breakpoint instruction
190 hard-wired into the target's code. Don't
191 try to write another breakpoint
192 instruction on top of it, or restore its
193 value. Step over it using the
194 architecture's SKIP_INSN macro. */
198 /* Disposition of breakpoint. Ie: what to do after hitting it. */
202 disp_del, /* Delete it */
203 disp_del_at_next_stop, /* Delete at next stop,
204 whether hit or not */
205 disp_disable, /* Disable it */
206 disp_donttouch /* Leave it alone */
209 enum target_hw_bp_type
211 hw_write = 0, /* Common HW watchpoint */
212 hw_read = 1, /* Read HW watchpoint */
213 hw_access = 2, /* Access HW watchpoint */
214 hw_execute = 3 /* Execute HW breakpoint */
218 /* Information used by targets to insert and remove breakpoints. */
220 struct bp_target_info
222 /* Address space at which the breakpoint was placed. */
223 struct address_space *placed_address_space;
225 /* Address at which the breakpoint was placed. This is normally the
226 same as ADDRESS from the bp_location, except when adjustment
227 happens in gdbarch_breakpoint_from_pc. The most common form of
228 adjustment is stripping an alternate ISA marker from the PC which
229 is used to determine the type of breakpoint to insert. */
230 CORE_ADDR placed_address;
232 /* If this is a ranged breakpoint, then this field contains the
233 length of the range that will be watched for execution. */
236 /* If the breakpoint lives in memory and reading that memory would
237 give back the breakpoint, instead of the original contents, then
238 the original contents are cached here. Only SHADOW_LEN bytes of
239 this buffer are valid, and only when the breakpoint is inserted. */
240 gdb_byte shadow_contents[BREAKPOINT_MAX];
242 /* The length of the data cached in SHADOW_CONTENTS. */
245 /* The size of the placed breakpoint, according to
246 gdbarch_breakpoint_from_pc, when the breakpoint was inserted.
247 This is generally the same as SHADOW_LEN, unless we did not need
248 to read from the target to implement the memory breakpoint
249 (e.g. if a remote stub handled the details). We may still need
250 the size to remove the breakpoint safely. */
254 /* GDB maintains two types of information about each breakpoint (or
255 watchpoint, or other related event). The first type corresponds
256 to struct breakpoint; this is a relatively high-level structure
257 which contains the source location(s), stopping conditions, user
258 commands to execute when the breakpoint is hit, and so forth.
260 The second type of information corresponds to struct bp_location.
261 Each breakpoint has one or (eventually) more locations associated
262 with it, which represent target-specific and machine-specific
263 mechanisms for stopping the program. For instance, a watchpoint
264 expression may require multiple hardware watchpoints in order to
265 catch all changes in the value of the expression being watched. */
269 bp_loc_software_breakpoint,
270 bp_loc_hardware_breakpoint,
271 bp_loc_hardware_watchpoint,
272 bp_loc_other /* Miscellaneous... */
275 /* This structure is a collection of function pointers that, if
276 available, will be called instead of performing the default action
277 for this bp_loc_type. */
279 struct bp_location_ops
281 /* Destructor. Releases everything from SELF (but not SELF
283 void (*dtor) (struct bp_location *self);
288 /* Chain pointer to the next breakpoint location for
289 the same parent breakpoint. */
290 struct bp_location *next;
292 /* Methods associated with this location. */
293 const struct bp_location_ops *ops;
295 /* The reference count. */
298 /* Type of this breakpoint location. */
299 enum bp_loc_type loc_type;
301 /* Each breakpoint location must belong to exactly one higher-level
302 breakpoint. This pointer is NULL iff this bp_location is no
303 longer attached to a breakpoint. For example, when a breakpoint
304 is deleted, its locations may still be found in the
305 moribund_locations list, or if we had stopped for it, in
307 struct breakpoint *owner;
309 /* Conditional. Break only if this expression's value is nonzero.
310 Unlike string form of condition, which is associated with
311 breakpoint, this is associated with location, since if breakpoint
312 has several locations, the evaluation of expression can be
313 different for different locations. Only valid for real
314 breakpoints; a watchpoint's conditional expression is stored in
315 the owner breakpoint object. */
316 struct expression *cond;
318 /* This location's address is in an unloaded solib, and so this
319 location should not be inserted. It will be automatically
320 enabled when that solib is loaded. */
323 /* Is this particular location enabled. */
326 /* Nonzero if this breakpoint is now inserted. */
329 /* Nonzero if this is not the first breakpoint in the list
330 for the given address. location of tracepoint can _never_
331 be duplicated with other locations of tracepoints and other
332 kinds of breakpoints, because two locations at the same
333 address may have different actions, so both of these locations
334 should be downloaded and so that `tfind N' always works. */
337 /* If we someday support real thread-specific breakpoints, then
338 the breakpoint location will need a thread identifier. */
340 /* Data for specific breakpoint types. These could be a union, but
341 simplicity is more important than memory usage for breakpoints. */
343 /* Architecture associated with this location's address. May be
344 different from the breakpoint architecture. */
345 struct gdbarch *gdbarch;
347 /* The program space associated with this breakpoint location
348 address. Note that an address space may be represented in more
349 than one program space (e.g. each uClinux program will be given
350 its own program space, but there will only be one address space
351 for all of them), but we must not insert more than one location
352 at the same address in the same address space. */
353 struct program_space *pspace;
355 /* Note that zero is a perfectly valid code address on some platforms
356 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
357 is not a special value for this field. Valid for all types except
361 /* For hardware watchpoints, the size of the memory region being
362 watched. For hardware ranged breakpoints, the size of the
366 /* Type of hardware watchpoint. */
367 enum target_hw_bp_type watchpoint_type;
369 /* For any breakpoint type with an address, this is the section
370 associated with the address. Used primarily for overlay
372 struct obj_section *section;
374 /* Address at which breakpoint was requested, either by the user or
375 by GDB for internal breakpoints. This will usually be the same
376 as ``address'' (above) except for cases in which
377 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
378 which to place the breakpoint in order to comply with a
379 processor's architectual constraints. */
380 CORE_ADDR requested_address;
384 /* Details of the placed breakpoint, when inserted. */
385 struct bp_target_info target_info;
387 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
388 struct bp_target_info overlay_target_info;
390 /* In a non-stop mode, it's possible that we delete a breakpoint,
391 but as we do that, some still running thread hits that breakpoint.
392 For that reason, we need to keep locations belonging to deleted
393 breakpoints for a bit, so that don't report unexpected SIGTRAP.
394 We can't keep such locations forever, so we use a heuristic --
395 after we process certain number of inferior events since
396 breakpoint was deleted, we retire all locations of that breakpoint.
397 This variable keeps a number of events still to go, when
398 it becomes 0 this location is retired. */
399 int events_till_retirement;
401 /* Line number of this address. */
405 /* Source file name of this address. */
410 /* This structure is a collection of function pointers that, if available,
411 will be called instead of the performing the default action for this
414 struct breakpoint_ops
416 /* Destructor. Releases everything from SELF (but not SELF
418 void (*dtor) (struct breakpoint *self);
420 /* Allocate a location for this breakpoint. */
421 struct bp_location * (*allocate_location) (struct breakpoint *);
423 /* Reevaluate a breakpoint. This is necessary after symbols change
424 (e.g., an executable or DSO was loaded, or the inferior just
426 void (*re_set) (struct breakpoint *self);
428 /* Insert the breakpoint or watchpoint or activate the catchpoint.
429 Return 0 for success, 1 if the breakpoint, watchpoint or
430 catchpoint type is not supported, -1 for failure. */
431 int (*insert_location) (struct bp_location *);
433 /* Remove the breakpoint/catchpoint that was previously inserted
434 with the "insert" method above. Return 0 for success, 1 if the
435 breakpoint, watchpoint or catchpoint type is not supported,
437 int (*remove_location) (struct bp_location *);
439 /* Return true if it the target has stopped due to hitting
440 breakpoint location BL. This function does not check if we
441 should stop, only if BL explains the stop. */
442 int (*breakpoint_hit) (const struct bp_location *bl, struct address_space *,
445 /* Check internal conditions of the breakpoint referred to by BS.
446 If we should not stop for this breakpoint, set BS->stop to 0. */
447 void (*check_status) (struct bpstats *bs);
449 /* Tell how many hardware resources (debug registers) are needed
450 for this breakpoint. If this function is not provided, then
451 the breakpoint or watchpoint needs one debug register. */
452 int (*resources_needed) (const struct bp_location *);
454 /* Tell whether we can downgrade from a hardware watchpoint to a software
455 one. If not, the user will not be able to enable the watchpoint when
456 there are not enough hardware resources available. */
457 int (*works_in_software_mode) (const struct breakpoint *);
459 /* The normal print routine for this breakpoint, called when we
461 enum print_stop_action (*print_it) (struct bpstats *bs);
463 /* Display information about this breakpoint, for "info
465 void (*print_one) (struct breakpoint *, struct bp_location **);
467 /* Display extra information about this breakpoint, below the normal
468 breakpoint description in "info breakpoints".
470 In the example below, the "address range" line was printed
471 by print_one_detail_ranged_breakpoint.
473 (gdb) info breakpoints
474 Num Type Disp Enb Address What
475 2 hw breakpoint keep y in main at test-watch.c:70
476 address range: [0x10000458, 0x100004c7]
479 void (*print_one_detail) (const struct breakpoint *, struct ui_out *);
481 /* Display information about this breakpoint after setting it
482 (roughly speaking; this is called from "mention"). */
483 void (*print_mention) (struct breakpoint *);
485 /* Print to FP the CLI command that recreates this breakpoint. */
486 void (*print_recreate) (struct breakpoint *, struct ui_file *fp);
489 /* Helper for breakpoint_ops->print_recreate implementations. Prints
490 the "thread" or "task" condition of B, and then a newline.
492 Necessary because most breakpoint implementations accept
493 thread/task conditions at the end of the spec line, like "break foo
494 thread 1", which needs outputting before any breakpoint-type
495 specific extra command necessary for B's recreation. */
496 extern void print_recreate_thread (struct breakpoint *b, struct ui_file *fp);
498 enum watchpoint_triggered
500 /* This watchpoint definitely did not trigger. */
501 watch_triggered_no = 0,
503 /* Some hardware watchpoint triggered, and it might have been this
504 one, but we do not know which it was. */
505 watch_triggered_unknown,
507 /* This hardware watchpoint definitely did trigger. */
511 /* This is used to declare the VEC syscalls_to_be_caught. */
514 typedef struct bp_location *bp_location_p;
515 DEF_VEC_P(bp_location_p);
517 /* A reference-counted struct command_line. This lets multiple
518 breakpoints share a single command list. This is an implementation
519 detail to the breakpoints module. */
520 struct counted_command_line;
522 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
523 a watchpoint over a memory region. If this flag is true, GDB will use
524 only one register per watchpoint, thus assuming that all acesses that
525 modify a memory location happen at its starting address. */
527 extern int target_exact_watchpoints;
529 /* Note that the ->silent field is not currently used by any commands
530 (though the code is in there if it was to be, and set_raw_breakpoint
531 does set it to 0). I implemented it because I thought it would be
532 useful for a hack I had to put in; I'm going to leave it in because
533 I can see how there might be times when it would indeed be useful */
535 /* This is for all kinds of breakpoints. */
539 /* Methods associated with this breakpoint. */
540 const struct breakpoint_ops *ops;
542 struct breakpoint *next;
543 /* Type of breakpoint. */
545 /* Zero means disabled; remember the info but don't break here. */
546 enum enable_state enable_state;
547 /* What to do with this breakpoint after we hit it. */
548 enum bpdisp disposition;
549 /* Number assigned to distinguish breakpoints. */
552 /* Location(s) associated with this high-level breakpoint. */
553 struct bp_location *loc;
555 /* Non-zero means a silent breakpoint (don't print frame info
557 unsigned char silent;
558 /* Non-zero means display ADDR_STRING to the user verbatim. */
559 unsigned char display_canonical;
560 /* Number of stops at this breakpoint that should
561 be continued automatically before really stopping. */
563 /* Chain of command lines to execute when this breakpoint is
565 struct counted_command_line *commands;
566 /* Stack depth (address of frame). If nonzero, break only if fp
568 struct frame_id frame_id;
570 /* The program space used to set the breakpoint. This is only set
571 for breakpoints which are specific to a program space; for
572 non-thread-specific ordinary breakpoints this is NULL. */
573 struct program_space *pspace;
575 /* String we used to set the breakpoint (malloc'd). */
578 /* The filter that should be passed to decode_line_full when
579 re-setting this breakpoint. This may be NULL, but otherwise is
580 allocated with xmalloc. */
583 /* For a ranged breakpoint, the string we used to find
584 the end of the range (malloc'd). */
585 char *addr_string_range_end;
587 /* Architecture we used to set the breakpoint. */
588 struct gdbarch *gdbarch;
589 /* Language we used to set the breakpoint. */
590 enum language language;
591 /* Input radix we used to set the breakpoint. */
593 /* String form of the breakpoint condition (malloc'd), or NULL if
594 there is no condition. */
596 /* String form of exp to use for displaying to the user
597 (malloc'd), or NULL if none. */
599 /* Holds the address of the related watchpoint_scope breakpoint
600 when using watchpoints on local variables (might the concept of
601 a related breakpoint be useful elsewhere, if not just call it
602 the watchpoint_scope breakpoint or something like that.
604 struct breakpoint *related_breakpoint;
606 /* Thread number for thread-specific breakpoint,
607 or -1 if don't care. */
610 /* Ada task number for task-specific breakpoint,
611 or 0 if don't care. */
614 /* Count of the number of times this breakpoint was taken, dumped
615 with the info, but not used for anything else. Useful for
616 seeing how many times you hit a break prior to the program
617 aborting, so you can back up to just before the abort. */
620 /* Is breakpoint's condition not yet parsed because we found
621 no location initially so had no context to parse
623 int condition_not_parsed;
625 /* With a Python scripting enabled GDB, store a reference to the
626 Python object that has been associated with this breakpoint.
627 This is always NULL for a GDB that is not script enabled. It
628 can sometimes be NULL for enabled GDBs as not all breakpoint
629 types are tracked by the Python scripting API. */
630 struct breakpoint_object *py_bp_object;
633 /* An instance of this type is used to represent a watchpoint. It
634 includes a "struct breakpoint" as a kind of base class; users
635 downcast to "struct breakpoint *" when needed. */
639 /* The base class. */
640 struct breakpoint base;
642 /* String form of exp to use for displaying to the user (malloc'd),
645 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
646 char *exp_string_reparse;
648 /* The expression we are watching, or NULL if not a watchpoint. */
649 struct expression *exp;
650 /* The largest block within which it is valid, or NULL if it is
651 valid anywhere (e.g. consists just of global symbols). */
652 struct block *exp_valid_block;
653 /* The conditional expression if any. */
654 struct expression *cond_exp;
655 /* The largest block within which it is valid, or NULL if it is
656 valid anywhere (e.g. consists just of global symbols). */
657 struct block *cond_exp_valid_block;
658 /* Value of the watchpoint the last time we checked it, or NULL when
659 we do not know the value yet or the value was not readable. VAL
662 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
663 then an error occurred reading the value. */
666 /* Holds the frame address which identifies the frame this
667 watchpoint should be evaluated in, or `null' if the watchpoint
668 should be evaluated on the outermost frame. */
669 struct frame_id watchpoint_frame;
671 /* Holds the thread which identifies the frame this watchpoint
672 should be considered in scope for, or `null_ptid' if the
673 watchpoint should be evaluated in all threads. */
674 ptid_t watchpoint_thread;
676 /* For hardware watchpoints, the triggered status according to the
678 enum watchpoint_triggered watchpoint_triggered;
680 /* Whether this watchpoint is exact (see
681 target_exact_watchpoints). */
684 /* The mask address for a masked hardware watchpoint. */
685 CORE_ADDR hw_wp_mask;
688 /* Returns true if BPT is really a watchpoint. */
690 extern int is_watchpoint (const struct breakpoint *bpt);
692 /* An instance of this type is used to represent all kinds of
693 tracepoints. It includes a "struct breakpoint" as a kind of base
694 class; users downcast to "struct breakpoint *" when needed. */
698 /* The base class. */
699 struct breakpoint base;
701 /* Number of times this tracepoint should single-step and collect
705 /* Number of times this tracepoint should be hit before
709 /* The number of the tracepoint on the target. */
710 int number_on_target;
712 /* The total space taken by all the trace frames for this
714 ULONGEST traceframe_usage;
716 /* The static tracepoint marker id, if known. */
717 char *static_trace_marker_id;
719 /* LTTng/UST allow more than one marker with the same ID string,
720 although it unadvised because it confuses tools. When setting
721 static tracepoints by marker ID, this will record the index in
722 the array of markers we found for the given marker ID for which
723 this static tracepoint corresponds. When resetting breakpoints,
724 we will use this index to try to find the same marker again. */
725 int static_trace_marker_id_idx;
728 typedef struct breakpoint *breakpoint_p;
729 DEF_VEC_P(breakpoint_p);
731 /* The following stuff is an abstract data type "bpstat" ("breakpoint
732 status"). This provides the ability to determine whether we have
733 stopped at a breakpoint, and what we should do about it. */
735 typedef struct bpstats *bpstat;
737 /* Clears a chain of bpstat, freeing storage
739 extern void bpstat_clear (bpstat *);
741 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
742 is part of the bpstat is copied as well. */
743 extern bpstat bpstat_copy (bpstat);
745 extern bpstat bpstat_stop_status (struct address_space *aspace,
746 CORE_ADDR pc, ptid_t ptid);
748 /* This bpstat_what stuff tells wait_for_inferior what to do with a
749 breakpoint (a challenging task).
751 The enum values order defines priority-like order of the actions.
752 Once you've decided that some action is appropriate, you'll never
753 go back and decide something of a lower priority is better. Each
754 of these actions is mutually exclusive with the others. That
755 means, that if you find yourself adding a new action class here and
756 wanting to tell GDB that you have two simultaneous actions to
757 handle, something is wrong, and you probably don't actually need a
760 Note that a step resume breakpoint overrides another breakpoint of
761 signal handling (see comment in wait_for_inferior at where we set
762 the step_resume breakpoint). */
764 enum bpstat_what_main_action
766 /* Perform various other tests; that is, this bpstat does not
767 say to perform any action (e.g. failed watchpoint and nothing
769 BPSTAT_WHAT_KEEP_CHECKING,
771 /* Remove breakpoints, single step once, then put them back in and
772 go back to what we were doing. It's possible that this should
773 be removed from the main_action and put into a separate field,
774 to more cleanly handle
775 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
778 /* Set longjmp_resume breakpoint, remove all other breakpoints,
779 and continue. The "remove all other breakpoints" part is
780 required if we are also stepping over another breakpoint as
781 well as doing the longjmp handling. */
782 BPSTAT_WHAT_SET_LONGJMP_RESUME,
784 /* Clear longjmp_resume breakpoint, then handle as
785 BPSTAT_WHAT_KEEP_CHECKING. */
786 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
788 /* Clear step resume breakpoint, and keep checking. */
789 BPSTAT_WHAT_STEP_RESUME,
791 /* Rather than distinguish between noisy and silent stops here, it
792 might be cleaner to have bpstat_print make that decision (also
793 taking into account stop_print_frame and source_only). But the
794 implications are a bit scary (interaction with auto-displays,
795 etc.), so I won't try it. */
798 BPSTAT_WHAT_STOP_SILENT,
800 /* Stop and print. */
801 BPSTAT_WHAT_STOP_NOISY,
803 /* Clear step resume breakpoint, and keep checking. High-priority
804 step-resume breakpoints are used when even if there's a user
805 breakpoint at the current PC when we set the step-resume
806 breakpoint, we don't want to re-handle any breakpoint other
807 than the step-resume when it's hit; instead we want to move
808 past the breakpoint. This is used in the case of skipping
810 BPSTAT_WHAT_HP_STEP_RESUME,
813 /* An enum indicating the kind of "stack dummy" stop. This is a bit
814 of a misnomer because only one kind of truly a stack dummy. */
817 /* We didn't stop at a stack dummy breakpoint. */
820 /* Stopped at a stack dummy. */
823 /* Stopped at std::terminate. */
829 enum bpstat_what_main_action main_action;
831 /* Did we hit a call dummy breakpoint? This only goes with a
832 main_action of BPSTAT_WHAT_STOP_SILENT or
833 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
834 dummy without popping the frame is not a useful one). */
835 enum stop_stack_kind call_dummy;
837 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
838 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
839 longjmp, false if we are handling an exception. */
843 /* The possible return values for print_bpstat, print_it_normal,
844 print_it_done, print_it_noop. */
845 enum print_stop_action
847 /* We printed nothing or we need to do some more analysis. */
850 /* We printed something, and we *do* desire that something to be
851 followed by a location. */
854 /* We printed something, and we do *not* desire that something to
855 be followed by a location. */
858 /* We already printed all we needed to print, don't print anything
863 /* Tell what to do about this bpstat. */
864 struct bpstat_what bpstat_what (bpstat);
866 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
867 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
869 /* Nonzero if a signal that we got in wait() was due to circumstances
870 explained by the BS. */
871 /* Currently that is true if we have hit a breakpoint, or if there is
872 a watchpoint enabled. */
873 #define bpstat_explains_signal(bs) ((bs) != NULL)
875 /* Nonzero is this bpstat causes a stop. */
876 extern int bpstat_causes_stop (bpstat);
878 /* Nonzero if we should step constantly (e.g. watchpoints on machines
879 without hardware support). This isn't related to a specific bpstat,
880 just to things like whether watchpoints are set. */
881 extern int bpstat_should_step (void);
883 /* Print a message indicating what happened. Returns nonzero to
884 say that only the source line should be printed after this (zero
885 return means print the frame as well as the source line). */
886 extern enum print_stop_action bpstat_print (bpstat, int);
888 /* Put in *NUM the breakpoint number of the first breakpoint we are
889 stopped at. *BSP upon return is a bpstat which points to the
890 remaining breakpoints stopped at (but which is not guaranteed to be
891 good for anything but further calls to bpstat_num).
893 Return 0 if passed a bpstat which does not indicate any breakpoints.
894 Return -1 if stopped at a breakpoint that has been deleted since
896 Return 1 otherwise. */
897 extern int bpstat_num (bpstat *, int *);
899 /* Perform actions associated with the stopped inferior. Actually, we
900 just use this for breakpoint commands. Perhaps other actions will
901 go here later, but this is executed at a late time (from the
903 extern void bpstat_do_actions (void);
905 /* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will
907 extern void bpstat_clear_actions (void);
909 /* Implementation: */
911 /* Values used to tell the printing routine how to behave for this
915 /* This is used when we want to do a normal printing of the reason
916 for stopping. The output will depend on the type of eventpoint
917 we are dealing with. This is the default value, most commonly
920 /* This is used when nothing should be printed for this bpstat
923 /* This is used when everything which needs to be printed has
924 already been printed. But we still want to print the frame. */
930 /* Linked list because there can be more than one breakpoint at
931 the same place, and a bpstat reflects the fact that all have
935 /* Location that caused the stop. Locations are refcounted, so
936 this will never be NULL. Note that this location may end up
937 detached from a breakpoint, but that does not necessary mean
938 that the struct breakpoint is gone. E.g., consider a
939 watchpoint with a condition that involves an inferior function
940 call. Watchpoint locations are recreated often (on resumes,
941 hence on infcalls too). Between creating the bpstat and after
942 evaluating the watchpoint condition, this location may hence
943 end up detached from its original owner watchpoint, even though
944 the watchpoint is still listed. If it's condition evaluates as
945 true, we still want this location to cause a stop, and we will
946 still need to know which watchpoint it was originally attached.
947 What this means is that we should not (in most cases) follow
948 the `bpstat->bp_location->owner' link, but instead use the
949 `breakpoint_at' field below. */
950 struct bp_location *bp_location_at;
952 /* Breakpoint that caused the stop. This is nullified if the
953 breakpoint ends up being deleted. See comments on
954 `bp_location_at' above for why do we need this field instead of
955 following the location's owner. */
956 struct breakpoint *breakpoint_at;
958 /* The associated command list. */
959 struct counted_command_line *commands;
961 /* Old value associated with a watchpoint. */
962 struct value *old_val;
964 /* Nonzero if this breakpoint tells us to print the frame. */
967 /* Nonzero if this breakpoint tells us to stop. */
970 /* Tell bpstat_print and print_bp_stop_message how to print stuff
971 associated with this element of the bpstat chain. */
972 enum bp_print_how print_it;
983 /* The possible return values for breakpoint_here_p.
984 We guarantee that zero always means "no breakpoint here". */
987 no_breakpoint_here = 0,
988 ordinary_breakpoint_here,
989 permanent_breakpoint_here
993 /* Prototypes for breakpoint-related functions. */
995 extern enum breakpoint_here breakpoint_here_p (struct address_space *,
998 extern int moribund_breakpoint_here_p (struct address_space *, CORE_ADDR);
1000 extern int breakpoint_inserted_here_p (struct address_space *, CORE_ADDR);
1002 extern int regular_breakpoint_inserted_here_p (struct address_space *,
1005 extern int software_breakpoint_inserted_here_p (struct address_space *,
1008 /* Returns true if there's a hardware watchpoint or access watchpoint
1009 inserted in the range defined by ADDR and LEN. */
1010 extern int hardware_watchpoint_inserted_in_range (struct address_space *,
1014 extern int breakpoint_thread_match (struct address_space *,
1017 extern void until_break_command (char *, int, int);
1019 /* Initialize a struct bp_location. */
1021 extern void init_bp_location (struct bp_location *loc,
1022 const struct bp_location_ops *ops,
1023 struct breakpoint *owner);
1025 extern void update_breakpoint_locations (struct breakpoint *b,
1026 struct symtabs_and_lines sals,
1027 struct symtabs_and_lines sals_end);
1029 extern void breakpoint_re_set (void);
1031 extern void breakpoint_re_set_thread (struct breakpoint *);
1033 extern struct breakpoint *set_momentary_breakpoint
1034 (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype);
1036 extern struct breakpoint *set_momentary_breakpoint_at_pc
1037 (struct gdbarch *, CORE_ADDR pc, enum bptype type);
1039 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt);
1041 extern void set_ignore_count (int, int, int);
1043 extern void breakpoint_init_inferior (enum inf_context);
1045 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
1047 extern void delete_breakpoint (struct breakpoint *);
1049 extern void breakpoint_auto_delete (bpstat);
1051 /* Return the chain of command lines to execute when this breakpoint
1053 extern struct command_line *breakpoint_commands (struct breakpoint *b);
1055 /* Return a string image of DISP. The string is static, and thus should
1056 NOT be deallocated after use. */
1057 const char *bpdisp_text (enum bpdisp disp);
1059 extern void break_command (char *, int);
1061 extern void hbreak_command_wrapper (char *, int);
1062 extern void thbreak_command_wrapper (char *, int);
1063 extern void rbreak_command_wrapper (char *, int);
1064 extern void watch_command_wrapper (char *, int, int);
1065 extern void awatch_command_wrapper (char *, int, int);
1066 extern void rwatch_command_wrapper (char *, int, int);
1067 extern void tbreak_command (char *, int);
1069 extern struct breakpoint_ops bkpt_breakpoint_ops;
1071 extern void initialize_breakpoint_ops (void);
1073 /* Arguments to pass as context to some catch command handlers. */
1074 #define CATCH_PERMANENT ((void *) (uintptr_t) 0)
1075 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
1077 /* Like add_cmd, but add the command to both the "catch" and "tcatch"
1078 lists, and pass some additional user data to the command
1082 add_catch_command (char *name, char *docstring,
1083 void (*sfunc) (char *args, int from_tty,
1084 struct cmd_list_element *command),
1085 char **(*completer) (struct cmd_list_element *cmd,
1086 char *text, char *word),
1087 void *user_data_catch,
1088 void *user_data_tcatch);
1090 /* Initialize a breakpoint struct for Ada exception catchpoints. */
1093 init_ada_exception_breakpoint (struct breakpoint *b,
1094 struct gdbarch *gdbarch,
1095 struct symtab_and_line sal,
1097 const struct breakpoint_ops *ops,
1101 /* Add breakpoint B on the breakpoint list, and notify the user, the
1102 target and breakpoint_created observers of its existence. If
1103 INTERNAL is non-zero, the breakpoint number will be allocated from
1104 the internal breakpoint count. If UPDATE_GLL is non-zero,
1105 update_global_location_list will be called. */
1107 extern void install_breakpoint (int internal, struct breakpoint *b,
1110 extern int create_breakpoint (struct gdbarch *gdbarch, char *arg,
1111 char *cond_string, int thread,
1112 int parse_condition_and_thread,
1113 int tempflag, enum bptype wanted_type,
1115 enum auto_boolean pending_break_support,
1116 const struct breakpoint_ops *ops,
1121 extern void insert_breakpoints (void);
1123 extern int remove_breakpoints (void);
1125 extern int remove_breakpoints_pid (int pid);
1127 /* This function can be used to physically insert eventpoints from the
1128 specified traced inferior process, without modifying the breakpoint
1129 package's state. This can be useful for those targets which
1130 support following the processes of a fork() or vfork() system call,
1131 when both of the resulting two processes are to be followed. */
1132 extern int reattach_breakpoints (int);
1134 /* This function can be used to update the breakpoint package's state
1135 after an exec() system call has been executed.
1137 This function causes the following:
1139 - All eventpoints are marked "not inserted".
1140 - All eventpoints with a symbolic address are reset such that
1141 the symbolic address must be reevaluated before the eventpoints
1143 - The solib breakpoints are explicitly removed from the breakpoint
1145 - A step-resume breakpoint, if any, is explicitly removed from the
1147 - All eventpoints without a symbolic address are removed from the
1149 extern void update_breakpoints_after_exec (void);
1151 /* This function can be used to physically remove hardware breakpoints
1152 and watchpoints from the specified traced inferior process, without
1153 modifying the breakpoint package's state. This can be useful for
1154 those targets which support following the processes of a fork() or
1155 vfork() system call, when one of the resulting two processes is to
1156 be detached and allowed to run free.
1158 It is an error to use this function on the process whose id is
1160 extern int detach_breakpoints (int);
1162 /* This function is called when program space PSPACE is about to be
1163 deleted. It takes care of updating breakpoints to not reference
1164 this PSPACE anymore. */
1165 extern void breakpoint_program_space_exit (struct program_space *pspace);
1167 extern void set_longjmp_breakpoint (struct thread_info *tp,
1168 struct frame_id frame);
1169 extern void delete_longjmp_breakpoint (int thread);
1171 extern void enable_overlay_breakpoints (void);
1172 extern void disable_overlay_breakpoints (void);
1174 extern void set_std_terminate_breakpoint (void);
1175 extern void delete_std_terminate_breakpoint (void);
1177 /* These functions respectively disable or reenable all currently
1178 enabled watchpoints. When disabled, the watchpoints are marked
1179 call_disabled. When re-enabled, they are marked enabled.
1181 The intended client of these functions is call_function_by_hand.
1183 The inferior must be stopped, and all breakpoints removed, when
1184 these functions are used.
1186 The need for these functions is that on some targets (e.g., HP-UX),
1187 gdb is unable to unwind through the dummy frame that is pushed as
1188 part of the implementation of a call command. Watchpoints can
1189 cause the inferior to stop in places where this frame is visible,
1190 and that can cause execution control to become very confused.
1192 Note that if a user sets breakpoints in an interactively called
1193 function, the call_disabled watchpoints will have been re-enabled
1194 when the first such breakpoint is reached. However, on targets
1195 that are unable to unwind through the call dummy frame, watches
1196 of stack-based storage may then be deleted, because gdb will
1197 believe that their watched storage is out of scope. (Sigh.) */
1198 extern void disable_watchpoints_before_interactive_call_start (void);
1200 extern void enable_watchpoints_after_interactive_call_stop (void);
1202 /* These functions disable and re-enable all breakpoints during
1203 inferior startup. They are intended to be called from solib
1204 code where necessary. This is needed on platforms where the
1205 main executable is relocated at some point during startup
1206 processing, making breakpoint addresses invalid.
1208 If additional breakpoints are created after the routine
1209 disable_breakpoints_before_startup but before the routine
1210 enable_breakpoints_after_startup was called, they will also
1211 be marked as disabled. */
1212 extern void disable_breakpoints_before_startup (void);
1213 extern void enable_breakpoints_after_startup (void);
1215 /* For script interpreters that need to define breakpoint commands
1216 after they've already read the commands into a struct
1218 extern enum command_control_type commands_from_control_command
1219 (char *arg, struct command_line *cmd);
1221 extern void clear_breakpoint_hit_counts (void);
1223 extern struct breakpoint *get_breakpoint (int num);
1225 /* The following are for displays, which aren't really breakpoints,
1226 but here is as good a place as any for them. */
1228 extern void disable_current_display (void);
1230 extern void do_displays (void);
1232 extern void disable_display (int);
1234 extern void clear_displays (void);
1236 extern void disable_breakpoint (struct breakpoint *);
1238 extern void enable_breakpoint (struct breakpoint *);
1240 extern void breakpoint_set_commands (struct breakpoint *b,
1241 struct command_line *commands);
1243 extern void breakpoint_set_silent (struct breakpoint *b, int silent);
1245 extern void breakpoint_set_thread (struct breakpoint *b, int thread);
1247 extern void breakpoint_set_task (struct breakpoint *b, int task);
1249 /* Clear the "inserted" flag in all breakpoints. */
1250 extern void mark_breakpoints_out (void);
1252 extern void make_breakpoint_permanent (struct breakpoint *);
1254 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *,
1257 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *,
1260 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *,
1263 extern void remove_jit_event_breakpoints (void);
1265 extern void remove_solib_event_breakpoints (void);
1267 extern void remove_thread_event_breakpoints (void);
1269 extern void disable_breakpoints_in_shlibs (void);
1271 /* This function returns TRUE if ep is a catchpoint. */
1272 extern int ep_is_catchpoint (struct breakpoint *);
1274 /* Enable breakpoints and delete when hit. Called with ARG == NULL
1275 deletes all breakpoints. */
1276 extern void delete_command (char *arg, int from_tty);
1278 /* Manage a software single step breakpoint (or two). Insert may be
1279 called twice before remove is called. */
1280 extern void insert_single_step_breakpoint (struct gdbarch *,
1281 struct address_space *,
1283 extern int single_step_breakpoints_inserted (void);
1284 extern void remove_single_step_breakpoints (void);
1285 extern void cancel_single_step_breakpoints (void);
1287 /* Manage manual breakpoints, separate from the normal chain of
1288 breakpoints. These functions are used in murky target-specific
1289 ways. Please do not add more uses! */
1290 extern void *deprecated_insert_raw_breakpoint (struct gdbarch *,
1291 struct address_space *,
1293 extern int deprecated_remove_raw_breakpoint (struct gdbarch *, void *);
1295 /* Check if any hardware watchpoints have triggered, according to the
1297 int watchpoints_triggered (struct target_waitstatus *);
1299 /* Helper for transparent breakpoint hiding for memory read and write
1302 Update one of READBUF or WRITEBUF with either the shadows
1303 (READBUF), or the breakpoint instructions (WRITEBUF) of inserted
1304 breakpoints at the memory range defined by MEMADDR and extending
1305 for LEN bytes. If writing, then WRITEBUF is a copy of WRITEBUF_ORG
1307 extern void breakpoint_xfer_memory (gdb_byte *readbuf, gdb_byte *writebuf,
1308 const gdb_byte *writebuf_org,
1309 ULONGEST memaddr, LONGEST len);
1311 extern int breakpoints_always_inserted_mode (void);
1313 /* Called each time new event from target is processed.
1314 Retires previously deleted breakpoint locations that
1315 in our opinion won't ever trigger. */
1316 extern void breakpoint_retire_moribund (void);
1318 /* Set break condition of breakpoint B to EXP. */
1319 extern void set_breakpoint_condition (struct breakpoint *b, char *exp,
1322 /* Checks if we are catching syscalls or not.
1323 Returns 0 if not, greater than 0 if we are. */
1324 extern int catch_syscall_enabled (void);
1326 /* Checks if we are catching syscalls with the specific
1327 syscall_number. Used for "filtering" the catchpoints.
1328 Returns 0 if not, greater than 0 if we are. */
1329 extern int catching_syscall_number (int syscall_number);
1331 /* Return a tracepoint with the given number if found. */
1332 extern struct tracepoint *get_tracepoint (int num);
1334 extern struct tracepoint *get_tracepoint_by_number_on_target (int num);
1336 /* Find a tracepoint by parsing a number in the supplied string. */
1337 extern struct tracepoint *
1338 get_tracepoint_by_number (char **arg,
1339 struct get_number_or_range_state *state,
1342 /* Return a vector of all tracepoints currently defined. The vector
1343 is newly allocated; the caller should free when done with it. */
1344 extern VEC(breakpoint_p) *all_tracepoints (void);
1346 extern int is_tracepoint (const struct breakpoint *b);
1348 /* Return a vector of all static tracepoints defined at ADDR. The
1349 vector is newly allocated; the caller should free when done with
1351 extern VEC(breakpoint_p) *static_tracepoints_here (CORE_ADDR addr);
1353 /* Function that can be passed to read_command_line to validate
1354 that each command is suitable for tracepoint command list. */
1355 extern void check_tracepoint_command (char *line, void *closure);
1357 /* Call at the start and end of an "rbreak" command to register
1358 breakpoint numbers for a later "commands" command. */
1359 extern void start_rbreak_breakpoints (void);
1360 extern void end_rbreak_breakpoints (void);
1362 /* Breakpoint iterator function.
1364 Calls a callback function once for each breakpoint, so long as the
1365 callback function returns false. If the callback function returns
1366 true, the iteration will end and the current breakpoint will be
1367 returned. This can be useful for implementing a search for a
1368 breakpoint with arbitrary attributes, or for applying an operation
1369 to every breakpoint. */
1370 extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *,
1373 /* Nonzero if the specified PC cannot be a location where functions
1374 have been inlined. */
1376 extern int pc_at_non_inline_function (struct address_space *aspace,
1379 extern int user_breakpoint_p (struct breakpoint *);
1381 /* Attempt to determine architecture of location identified by SAL. */
1382 extern struct gdbarch *get_sal_arch (struct symtab_and_line sal);
1384 #endif /* !defined (BREAKPOINT_H) */