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_startup_disabled
, /* The eventpoint has been disabled during
190 inferior startup. This is necessary on
191 some targets where the main executable
192 will get relocated during startup, making
193 breakpoint addresses invalid. The
194 eventpoint will be automatically enabled
195 and reset once inferior startup is
197 bp_permanent
/* There is a breakpoint instruction
198 hard-wired into the target's code. Don't
199 try to write another breakpoint
200 instruction on top of it, or restore its
201 value. Step over it using the
202 architecture's SKIP_INSN macro. */
206 /* Disposition of breakpoint. Ie: what to do after hitting it. */
210 disp_del
, /* Delete it */
211 disp_del_at_next_stop
, /* Delete at next stop,
212 whether hit or not */
213 disp_disable
, /* Disable it */
214 disp_donttouch
/* Leave it alone */
217 enum target_hw_bp_type
219 hw_write
= 0, /* Common HW watchpoint */
220 hw_read
= 1, /* Read HW watchpoint */
221 hw_access
= 2, /* Access HW watchpoint */
222 hw_execute
= 3 /* Execute HW breakpoint */
226 /* Information used by targets to insert and remove breakpoints. */
228 struct bp_target_info
230 /* Address space at which the breakpoint was placed. */
231 struct address_space
*placed_address_space
;
233 /* Address at which the breakpoint was placed. This is normally the
234 same as ADDRESS from the bp_location, except when adjustment
235 happens in gdbarch_breakpoint_from_pc. The most common form of
236 adjustment is stripping an alternate ISA marker from the PC which
237 is used to determine the type of breakpoint to insert. */
238 CORE_ADDR placed_address
;
240 /* If this is a ranged breakpoint, then this field contains the
241 length of the range that will be watched for execution. */
244 /* If the breakpoint lives in memory and reading that memory would
245 give back the breakpoint, instead of the original contents, then
246 the original contents are cached here. Only SHADOW_LEN bytes of
247 this buffer are valid, and only when the breakpoint is inserted. */
248 gdb_byte shadow_contents
[BREAKPOINT_MAX
];
250 /* The length of the data cached in SHADOW_CONTENTS. */
253 /* The size of the placed breakpoint, according to
254 gdbarch_breakpoint_from_pc, when the breakpoint was inserted.
255 This is generally the same as SHADOW_LEN, unless we did not need
256 to read from the target to implement the memory breakpoint
257 (e.g. if a remote stub handled the details). We may still need
258 the size to remove the breakpoint safely. */
262 /* GDB maintains two types of information about each breakpoint (or
263 watchpoint, or other related event). The first type corresponds
264 to struct breakpoint; this is a relatively high-level structure
265 which contains the source location(s), stopping conditions, user
266 commands to execute when the breakpoint is hit, and so forth.
268 The second type of information corresponds to struct bp_location.
269 Each breakpoint has one or (eventually) more locations associated
270 with it, which represent target-specific and machine-specific
271 mechanisms for stopping the program. For instance, a watchpoint
272 expression may require multiple hardware watchpoints in order to
273 catch all changes in the value of the expression being watched. */
277 bp_loc_software_breakpoint
,
278 bp_loc_hardware_breakpoint
,
279 bp_loc_hardware_watchpoint
,
280 bp_loc_other
/* Miscellaneous... */
283 /* This structure is a collection of function pointers that, if
284 available, will be called instead of performing the default action
285 for this bp_loc_type. */
287 struct bp_location_ops
289 /* Destructor. Releases everything from SELF (but not SELF
291 void (*dtor
) (struct bp_location
*self
);
296 /* Chain pointer to the next breakpoint location for
297 the same parent breakpoint. */
298 struct bp_location
*next
;
300 /* Methods associated with this location. */
301 const struct bp_location_ops
*ops
;
303 /* The reference count. */
306 /* Type of this breakpoint location. */
307 enum bp_loc_type loc_type
;
309 /* Each breakpoint location must belong to exactly one higher-level
310 breakpoint. This pointer is NULL iff this bp_location is no
311 longer attached to a breakpoint. For example, when a breakpoint
312 is deleted, its locations may still be found in the
313 moribund_locations list, or if we had stopped for it, in
315 struct breakpoint
*owner
;
317 /* Conditional. Break only if this expression's value is nonzero.
318 Unlike string form of condition, which is associated with
319 breakpoint, this is associated with location, since if breakpoint
320 has several locations, the evaluation of expression can be
321 different for different locations. Only valid for real
322 breakpoints; a watchpoint's conditional expression is stored in
323 the owner breakpoint object. */
324 struct expression
*cond
;
326 /* This location's address is in an unloaded solib, and so this
327 location should not be inserted. It will be automatically
328 enabled when that solib is loaded. */
331 /* Is this particular location enabled. */
334 /* Nonzero if this breakpoint is now inserted. */
337 /* Nonzero if this is not the first breakpoint in the list
338 for the given address. */
341 /* If we someday support real thread-specific breakpoints, then
342 the breakpoint location will need a thread identifier. */
344 /* Data for specific breakpoint types. These could be a union, but
345 simplicity is more important than memory usage for breakpoints. */
347 /* Architecture associated with this location's address. May be
348 different from the breakpoint architecture. */
349 struct gdbarch
*gdbarch
;
351 /* The program space associated with this breakpoint location
352 address. Note that an address space may be represented in more
353 than one program space (e.g. each uClinux program will be given
354 its own program space, but there will only be one address space
355 for all of them), but we must not insert more than one location
356 at the same address in the same address space. */
357 struct program_space
*pspace
;
359 /* Note that zero is a perfectly valid code address on some platforms
360 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
361 is not a special value for this field. Valid for all types except
365 /* For hardware watchpoints, the size of the memory region being
366 watched. For hardware ranged breakpoints, the size of the
370 /* Type of hardware watchpoint. */
371 enum target_hw_bp_type watchpoint_type
;
373 /* For any breakpoint type with an address, this is the section
374 associated with the address. Used primarily for overlay
376 struct obj_section
*section
;
378 /* Address at which breakpoint was requested, either by the user or
379 by GDB for internal breakpoints. This will usually be the same
380 as ``address'' (above) except for cases in which
381 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
382 which to place the breakpoint in order to comply with a
383 processor's architectual constraints. */
384 CORE_ADDR requested_address
;
388 /* Details of the placed breakpoint, when inserted. */
389 struct bp_target_info target_info
;
391 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
392 struct bp_target_info overlay_target_info
;
394 /* In a non-stop mode, it's possible that we delete a breakpoint,
395 but as we do that, some still running thread hits that breakpoint.
396 For that reason, we need to keep locations belonging to deleted
397 breakpoints for a bit, so that don't report unexpected SIGTRAP.
398 We can't keep such locations forever, so we use a heuristic --
399 after we process certain number of inferior events since
400 breakpoint was deleted, we retire all locations of that breakpoint.
401 This variable keeps a number of events still to go, when
402 it becomes 0 this location is retired. */
403 int events_till_retirement
;
406 /* This structure is a collection of function pointers that, if available,
407 will be called instead of the performing the default action for this
410 struct breakpoint_ops
412 /* Destructor. Releases everything from SELF (but not SELF
414 void (*dtor
) (struct breakpoint
*self
);
416 /* Allocate a location for this breakpoint. */
417 struct bp_location
* (*allocate_location
) (struct breakpoint
*);
419 /* Reevaluate a breakpoint. This is necessary after symbols change
420 (e.g., an executable or DSO was loaded, or the inferior just
422 void (*re_set
) (struct breakpoint
*self
);
424 /* Insert the breakpoint or watchpoint or activate the catchpoint.
425 Return 0 for success, 1 if the breakpoint, watchpoint or catchpoint
426 type is not supported, -1 for failure. */
427 int (*insert_location
) (struct bp_location
*);
429 /* Remove the breakpoint/catchpoint that was previously inserted
430 with the "insert" method above. Return 0 for success, 1 if the
431 breakpoint, watchpoint or catchpoint type is not supported,
433 int (*remove_location
) (struct bp_location
*);
435 /* Return true if it the target has stopped due to hitting
436 breakpoint location BL. This function does not check if we
437 should stop, only if BL explains the stop. */
438 int (*breakpoint_hit
) (const struct bp_location
*bl
, struct address_space
*,
441 /* Check internal conditions of the breakpoint referred to by BS.
442 If we should not stop for this breakpoint, set BS->stop to 0. */
443 void (*check_status
) (struct bpstats
*bs
);
445 /* Tell how many hardware resources (debug registers) are needed
446 for this breakpoint. If this function is not provided, then
447 the breakpoint or watchpoint needs one debug register. */
448 int (*resources_needed
) (const struct bp_location
*);
450 /* Tell whether we can downgrade from a hardware watchpoint to a software
451 one. If not, the user will not be able to enable the watchpoint when
452 there are not enough hardware resources available. */
453 int (*works_in_software_mode
) (const struct breakpoint
*);
455 /* The normal print routine for this breakpoint, called when we
457 enum print_stop_action (*print_it
) (struct breakpoint
*);
459 /* Display information about this breakpoint, for "info
461 void (*print_one
) (struct breakpoint
*, struct bp_location
**);
463 /* Display extra information about this breakpoint, below the normal
464 breakpoint description in "info breakpoints".
466 In the example below, the "address range" line was printed
467 by print_one_detail_ranged_breakpoint.
469 (gdb) info breakpoints
470 Num Type Disp Enb Address What
471 2 hw breakpoint keep y in main at test-watch.c:70
472 address range: [0x10000458, 0x100004c7]
475 void (*print_one_detail
) (const struct breakpoint
*, struct ui_out
*);
477 /* Display information about this breakpoint after setting it
478 (roughly speaking; this is called from "mention"). */
479 void (*print_mention
) (struct breakpoint
*);
481 /* Print to FP the CLI command that recreates this breakpoint. */
482 void (*print_recreate
) (struct breakpoint
*, struct ui_file
*fp
);
485 enum watchpoint_triggered
487 /* This watchpoint definitely did not trigger. */
488 watch_triggered_no
= 0,
490 /* Some hardware watchpoint triggered, and it might have been this
491 one, but we do not know which it was. */
492 watch_triggered_unknown
,
494 /* This hardware watchpoint definitely did trigger. */
498 /* This is used to declare the VEC syscalls_to_be_caught. */
501 typedef struct bp_location
*bp_location_p
;
502 DEF_VEC_P(bp_location_p
);
504 /* A reference-counted struct command_line. This lets multiple
505 breakpoints share a single command list. This is an implementation
506 detail to the breakpoints module. */
507 struct counted_command_line
;
509 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
510 a watchpoint over a memory region. If this flag is true, GDB will use
511 only one register per watchpoint, thus assuming that all acesses that
512 modify a memory location happen at its starting address. */
514 extern int target_exact_watchpoints
;
516 /* Note that the ->silent field is not currently used by any commands
517 (though the code is in there if it was to be, and set_raw_breakpoint
518 does set it to 0). I implemented it because I thought it would be
519 useful for a hack I had to put in; I'm going to leave it in because
520 I can see how there might be times when it would indeed be useful */
522 /* This is for a breakpoint or a watchpoint. */
526 struct breakpoint
*next
;
527 /* Type of breakpoint. */
529 /* Zero means disabled; remember the info but don't break here. */
530 enum enable_state enable_state
;
531 /* What to do with this breakpoint after we hit it. */
532 enum bpdisp disposition
;
533 /* Number assigned to distinguish breakpoints. */
536 /* Location(s) associated with this high-level breakpoint. */
537 struct bp_location
*loc
;
539 /* Line number of this address. */
543 /* Source file name of this address. */
547 /* Non-zero means a silent breakpoint (don't print frame info
549 unsigned char silent
;
550 /* Non-zero means display ADDR_STRING to the user verbatim. */
551 unsigned char display_canonical
;
552 /* Number of stops at this breakpoint that should
553 be continued automatically before really stopping. */
555 /* Chain of command lines to execute when this breakpoint is
557 struct counted_command_line
*commands
;
558 /* Stack depth (address of frame). If nonzero, break only if fp
560 struct frame_id frame_id
;
562 /* The program space used to set the breakpoint. */
563 struct program_space
*pspace
;
565 /* String we used to set the breakpoint (malloc'd). */
568 /* For a ranged breakpoint, the string we used to find
569 the end of the range (malloc'd). */
570 char *addr_string_range_end
;
572 /* Architecture we used to set the breakpoint. */
573 struct gdbarch
*gdbarch
;
574 /* Language we used to set the breakpoint. */
575 enum language language
;
576 /* Input radix we used to set the breakpoint. */
578 /* String form of the breakpoint condition (malloc'd), or NULL if
579 there is no condition. */
581 /* String form of exp to use for displaying to the user
582 (malloc'd), or NULL if none. */
584 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
585 char *exp_string_reparse
;
587 /* The expression we are watching, or NULL if not a watchpoint. */
588 struct expression
*exp
;
589 /* The largest block within which it is valid, or NULL if it is
590 valid anywhere (e.g. consists just of global symbols). */
591 struct block
*exp_valid_block
;
592 /* The conditional expression if any. NULL if not a watchpoint. */
593 struct expression
*cond_exp
;
594 /* The largest block within which it is valid, or NULL if it is
595 valid anywhere (e.g. consists just of global symbols). */
596 struct block
*cond_exp_valid_block
;
597 /* Value of the watchpoint the last time we checked it, or NULL
598 when we do not know the value yet or the value was not
599 readable. VAL is never lazy. */
601 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
602 then an error occurred reading the value. */
605 /* Holds the address of the related watchpoint_scope breakpoint
606 when using watchpoints on local variables (might the concept of
607 a related breakpoint be useful elsewhere, if not just call it
608 the watchpoint_scope breakpoint or something like that.
610 struct breakpoint
*related_breakpoint
;
612 /* Holds the frame address which identifies the frame this
613 watchpoint should be evaluated in, or `null' if the watchpoint
614 should be evaluated on the outermost frame. */
615 struct frame_id watchpoint_frame
;
617 /* Holds the thread which identifies the frame this watchpoint
618 should be considered in scope for, or `null_ptid' if the
619 watchpoint should be evaluated in all threads. */
620 ptid_t watchpoint_thread
;
622 /* For hardware watchpoints, the triggered status according to the
624 enum watchpoint_triggered watchpoint_triggered
;
626 /* Thread number for thread-specific breakpoint,
627 or -1 if don't care. */
630 /* Ada task number for task-specific breakpoint,
631 or 0 if don't care. */
634 /* Count of the number of times this breakpoint was taken, dumped
635 with the info, but not used for anything else. Useful for
636 seeing how many times you hit a break prior to the program
637 aborting, so you can back up to just before the abort. */
640 /* Methods associated with this breakpoint. */
641 struct breakpoint_ops
*ops
;
643 /* Is breakpoint's condition not yet parsed because we found
644 no location initially so had no context to parse
646 int condition_not_parsed
;
648 /* Number of times this tracepoint should single-step
649 and collect additional data. */
652 /* Number of times this tracepoint should be hit before
656 /* The number of the tracepoint on the target. */
657 int number_on_target
;
659 /* The static tracepoint marker id, if known. */
660 char *static_trace_marker_id
;
662 /* LTTng/UST allow more than one marker with the same ID string,
663 although it unadvised because it confuses tools. When setting
664 static tracepoints by marker ID, this will record the index in
665 the array of markers we found for the given marker ID for which
666 this static tracepoint corresponds. When resetting
667 breakpoints, we will use this index to try to find the same
669 int static_trace_marker_id_idx
;
671 /* With a Python scripting enabled GDB, store a reference to the
672 Python object that has been associated with this breakpoint.
673 This is always NULL for a GDB that is not script enabled. It
674 can sometimes be NULL for enabled GDBs as not all breakpoint
675 types are tracked by the Python scripting API. */
676 struct breakpoint_object
*py_bp_object
;
678 /* Whether this watchpoint is exact (see target_exact_watchpoints). */
681 /* The mask address for a masked hardware watchpoint. */
682 CORE_ADDR hw_wp_mask
;
685 typedef struct breakpoint
*breakpoint_p
;
686 DEF_VEC_P(breakpoint_p
);
688 /* The following stuff is an abstract data type "bpstat" ("breakpoint
689 status"). This provides the ability to determine whether we have
690 stopped at a breakpoint, and what we should do about it. */
692 typedef struct bpstats
*bpstat
;
694 /* Clears a chain of bpstat, freeing storage
696 extern void bpstat_clear (bpstat
*);
698 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
699 is part of the bpstat is copied as well. */
700 extern bpstat
bpstat_copy (bpstat
);
702 extern bpstat
bpstat_stop_status (struct address_space
*aspace
,
703 CORE_ADDR pc
, ptid_t ptid
);
705 /* This bpstat_what stuff tells wait_for_inferior what to do with a
706 breakpoint (a challenging task).
708 The enum values order defines priority-like order of the actions.
709 Once you've decided that some action is appropriate, you'll never
710 go back and decide something of a lower priority is better. Each
711 of these actions is mutually exclusive with the others. That
712 means, that if you find yourself adding a new action class here and
713 wanting to tell GDB that you have two simultaneous actions to
714 handle, something is wrong, and you probably don't actually need a
717 Note that a step resume breakpoint overrides another breakpoint of
718 signal handling (see comment in wait_for_inferior at where we set
719 the step_resume breakpoint). */
721 enum bpstat_what_main_action
723 /* Perform various other tests; that is, this bpstat does not
724 say to perform any action (e.g. failed watchpoint and nothing
726 BPSTAT_WHAT_KEEP_CHECKING
,
728 /* Remove breakpoints, single step once, then put them back in and
729 go back to what we were doing. It's possible that this should
730 be removed from the main_action and put into a separate field,
731 to more cleanly handle
732 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
735 /* Set longjmp_resume breakpoint, remove all other breakpoints,
736 and continue. The "remove all other breakpoints" part is
737 required if we are also stepping over another breakpoint as
738 well as doing the longjmp handling. */
739 BPSTAT_WHAT_SET_LONGJMP_RESUME
,
741 /* Clear longjmp_resume breakpoint, then handle as
742 BPSTAT_WHAT_KEEP_CHECKING. */
743 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME
,
745 /* Clear step resume breakpoint, and keep checking. */
746 BPSTAT_WHAT_STEP_RESUME
,
748 /* Rather than distinguish between noisy and silent stops here, it
749 might be cleaner to have bpstat_print make that decision (also
750 taking into account stop_print_frame and source_only). But the
751 implications are a bit scary (interaction with auto-displays,
752 etc.), so I won't try it. */
755 BPSTAT_WHAT_STOP_SILENT
,
757 /* Stop and print. */
758 BPSTAT_WHAT_STOP_NOISY
,
760 /* Clear step resume breakpoint, and keep checking. High-priority
761 step-resume breakpoints are used when even if there's a user
762 breakpoint at the current PC when we set the step-resume
763 breakpoint, we don't want to re-handle any breakpoint other
764 than the step-resume when it's hit; instead we want to move
765 past the breakpoint. This is used in the case of skipping
767 BPSTAT_WHAT_HP_STEP_RESUME
,
770 /* An enum indicating the kind of "stack dummy" stop. This is a bit
771 of a misnomer because only one kind of truly a stack dummy. */
774 /* We didn't stop at a stack dummy breakpoint. */
777 /* Stopped at a stack dummy. */
780 /* Stopped at std::terminate. */
786 enum bpstat_what_main_action main_action
;
788 /* Did we hit a call dummy breakpoint? This only goes with a
789 main_action of BPSTAT_WHAT_STOP_SILENT or
790 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
791 dummy without popping the frame is not a useful one). */
792 enum stop_stack_kind call_dummy
;
794 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
795 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
796 longjmp, false if we are handling an exception. */
800 /* The possible return values for print_bpstat, print_it_normal,
801 print_it_done, print_it_noop. */
802 enum print_stop_action
810 /* Tell what to do about this bpstat. */
811 struct bpstat_what
bpstat_what (bpstat
);
813 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
814 bpstat
bpstat_find_breakpoint (bpstat
, struct breakpoint
*);
816 /* Nonzero if a signal that we got in wait() was due to circumstances
817 explained by the BS. */
818 /* Currently that is true if we have hit a breakpoint, or if there is
819 a watchpoint enabled. */
820 #define bpstat_explains_signal(bs) ((bs) != NULL)
822 /* Nonzero is this bpstat causes a stop. */
823 extern int bpstat_causes_stop (bpstat
);
825 /* Nonzero if we should step constantly (e.g. watchpoints on machines
826 without hardware support). This isn't related to a specific bpstat,
827 just to things like whether watchpoints are set. */
828 extern int bpstat_should_step (void);
830 /* Print a message indicating what happened. Returns nonzero to
831 say that only the source line should be printed after this (zero
832 return means print the frame as well as the source line). */
833 extern enum print_stop_action
bpstat_print (bpstat
);
835 /* Put in *NUM the breakpoint number of the first breakpoint we are
836 stopped at. *BSP upon return is a bpstat which points to the
837 remaining breakpoints stopped at (but which is not guaranteed to be
838 good for anything but further calls to bpstat_num).
840 Return 0 if passed a bpstat which does not indicate any breakpoints.
841 Return -1 if stopped at a breakpoint that has been deleted since
843 Return 1 otherwise. */
844 extern int bpstat_num (bpstat
*, int *);
846 /* Perform actions associated with the stopped inferior. Actually, we
847 just use this for breakpoint commands. Perhaps other actions will
848 go here later, but this is executed at a late time (from the
850 extern void bpstat_do_actions (void);
852 /* Modify BS so that the actions will not be performed. */
853 extern void bpstat_clear_actions (bpstat
);
855 /* Implementation: */
857 /* Values used to tell the printing routine how to behave for this
861 /* This is used when we want to do a normal printing of the reason
862 for stopping. The output will depend on the type of eventpoint
863 we are dealing with. This is the default value, most commonly
866 /* This is used when nothing should be printed for this bpstat
869 /* This is used when everything which needs to be printed has
870 already been printed. But we still want to print the frame. */
876 /* Linked list because there can be more than one breakpoint at
877 the same place, and a bpstat reflects the fact that all have
881 /* Location that caused the stop. Locations are refcounted, so
882 this will never be NULL. Note that this location may end up
883 detached from a breakpoint, but that does not necessary mean
884 that the struct breakpoint is gone. E.g., consider a
885 watchpoint with a condition that involves an inferior function
886 call. Watchpoint locations are recreated often (on resumes,
887 hence on infcalls too). Between creating the bpstat and after
888 evaluating the watchpoint condition, this location may hence
889 end up detached from its original owner watchpoint, even though
890 the watchpoint is still listed. If it's condition evaluates as
891 true, we still want this location to cause a stop, and we will
892 still need to know which watchpoint it was originally attached.
893 What this means is that we should not (in most cases) follow
894 the `bpstat->bp_location->owner' link, but instead use the
895 `breakpoint_at' field below. */
896 struct bp_location
*bp_location_at
;
898 /* Breakpoint that caused the stop. This is nullified if the
899 breakpoint ends up being deleted. See comments on
900 `bp_location_at' above for why do we need this field instead of
901 following the location's owner. */
902 struct breakpoint
*breakpoint_at
;
904 /* The associated command list. */
905 struct counted_command_line
*commands
;
907 /* Commands left to be done. This points somewhere in
909 struct command_line
*commands_left
;
911 /* Old value associated with a watchpoint. */
912 struct value
*old_val
;
914 /* Nonzero if this breakpoint tells us to print the frame. */
917 /* Nonzero if this breakpoint tells us to stop. */
920 /* Tell bpstat_print and print_bp_stop_message how to print stuff
921 associated with this element of the bpstat chain. */
922 enum bp_print_how print_it
;
933 /* The possible return values for breakpoint_here_p.
934 We guarantee that zero always means "no breakpoint here". */
937 no_breakpoint_here
= 0,
938 ordinary_breakpoint_here
,
939 permanent_breakpoint_here
943 /* Prototypes for breakpoint-related functions. */
945 extern enum breakpoint_here
breakpoint_here_p (struct address_space
*,
948 extern int moribund_breakpoint_here_p (struct address_space
*, CORE_ADDR
);
950 extern int breakpoint_inserted_here_p (struct address_space
*, CORE_ADDR
);
952 extern int regular_breakpoint_inserted_here_p (struct address_space
*,
955 extern int software_breakpoint_inserted_here_p (struct address_space
*,
958 /* Returns true if there's a hardware watchpoint or access watchpoint
959 inserted in the range defined by ADDR and LEN. */
960 extern int hardware_watchpoint_inserted_in_range (struct address_space
*,
964 extern int breakpoint_thread_match (struct address_space
*,
967 extern void until_break_command (char *, int, int);
969 /* Initialize a struct bp_location. */
971 extern void init_bp_location (struct bp_location
*loc
,
972 const struct bp_location_ops
*ops
,
973 struct breakpoint
*owner
);
975 extern void update_breakpoint_locations (struct breakpoint
*b
,
976 struct symtabs_and_lines sals
,
977 struct symtabs_and_lines sals_end
);
979 extern void breakpoint_re_set (void);
981 extern void breakpoint_re_set_thread (struct breakpoint
*);
983 /* The default re_set method, for typical hardware or software
984 breakpoints. Reevaluate the breakpoint and recreate its
987 extern void breakpoint_re_set_default (struct breakpoint
*);
989 extern struct breakpoint
*set_momentary_breakpoint
990 (struct gdbarch
*, struct symtab_and_line
, struct frame_id
, enum bptype
);
992 extern struct breakpoint
*set_momentary_breakpoint_at_pc
993 (struct gdbarch
*, CORE_ADDR pc
, enum bptype type
);
995 extern struct breakpoint
*clone_momentary_breakpoint (struct breakpoint
*bpkt
);
997 extern void set_ignore_count (int, int, int);
999 extern void set_default_breakpoint (int, struct program_space
*,
1000 CORE_ADDR
, struct symtab
*, int);
1002 extern void breakpoint_init_inferior (enum inf_context
);
1004 extern struct cleanup
*make_cleanup_delete_breakpoint (struct breakpoint
*);
1006 extern void delete_breakpoint (struct breakpoint
*);
1008 extern void breakpoint_auto_delete (bpstat
);
1010 /* Return the chain of command lines to execute when this breakpoint
1012 extern struct command_line
*breakpoint_commands (struct breakpoint
*b
);
1014 /* Return a string image of DISP. The string is static, and thus should
1015 NOT be deallocated after use. */
1016 const char *bpdisp_text (enum bpdisp disp
);
1018 extern void break_command (char *, int);
1020 extern void hbreak_command_wrapper (char *, int);
1021 extern void thbreak_command_wrapper (char *, int);
1022 extern void rbreak_command_wrapper (char *, int);
1023 extern void watch_command_wrapper (char *, int, int);
1024 extern void awatch_command_wrapper (char *, int, int);
1025 extern void rwatch_command_wrapper (char *, int, int);
1026 extern void tbreak_command (char *, int);
1028 /* Arguments to pass as context to some catch command handlers. */
1029 #define CATCH_PERMANENT ((void *) (uintptr_t) 0)
1030 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
1032 /* Like add_cmd, but add the command to both the "catch" and "tcatch"
1033 lists, and pass some additional user data to the command
1037 add_catch_command (char *name
, char *docstring
,
1038 void (*sfunc
) (char *args
, int from_tty
,
1039 struct cmd_list_element
*command
),
1040 char **(*completer
) (struct cmd_list_element
*cmd
,
1041 char *text
, char *word
),
1042 void *user_data_catch
,
1043 void *user_data_tcatch
);
1045 /* Initialize a breakpoint struct for Ada exception catchpoints. */
1048 init_ada_exception_breakpoint (struct breakpoint
*b
,
1049 struct gdbarch
*gdbarch
,
1050 struct symtab_and_line sal
,
1052 struct breakpoint_ops
*ops
,
1056 /* Add breakpoint B on the breakpoint list, and notify the user, the
1057 target and breakpoint_created observers of its existence. */
1059 extern void install_breakpoint (struct breakpoint
*b
);
1061 extern int create_breakpoint (struct gdbarch
*gdbarch
, char *arg
,
1062 char *cond_string
, int thread
,
1063 int parse_condition_and_thread
,
1064 int tempflag
, enum bptype wanted_type
,
1066 enum auto_boolean pending_break_support
,
1067 struct breakpoint_ops
*ops
,
1072 extern void insert_breakpoints (void);
1074 extern int remove_breakpoints (void);
1076 extern int remove_breakpoints_pid (int pid
);
1078 /* This function can be used to physically insert eventpoints from the
1079 specified traced inferior process, without modifying the breakpoint
1080 package's state. This can be useful for those targets which
1081 support following the processes of a fork() or vfork() system call,
1082 when both of the resulting two processes are to be followed. */
1083 extern int reattach_breakpoints (int);
1085 /* This function can be used to update the breakpoint package's state
1086 after an exec() system call has been executed.
1088 This function causes the following:
1090 - All eventpoints are marked "not inserted".
1091 - All eventpoints with a symbolic address are reset such that
1092 the symbolic address must be reevaluated before the eventpoints
1094 - The solib breakpoints are explicitly removed from the breakpoint
1096 - A step-resume breakpoint, if any, is explicitly removed from the
1098 - All eventpoints without a symbolic address are removed from the
1100 extern void update_breakpoints_after_exec (void);
1102 /* This function can be used to physically remove hardware breakpoints
1103 and watchpoints from the specified traced inferior process, without
1104 modifying the breakpoint package's state. This can be useful for
1105 those targets which support following the processes of a fork() or
1106 vfork() system call, when one of the resulting two processes is to
1107 be detached and allowed to run free.
1109 It is an error to use this function on the process whose id is
1111 extern int detach_breakpoints (int);
1113 /* This function is called when program space PSPACE is about to be
1114 deleted. It takes care of updating breakpoints to not reference
1115 this PSPACE anymore. */
1116 extern void breakpoint_program_space_exit (struct program_space
*pspace
);
1118 extern void set_longjmp_breakpoint (struct thread_info
*tp
,
1119 struct frame_id frame
);
1120 extern void delete_longjmp_breakpoint (int thread
);
1122 extern void enable_overlay_breakpoints (void);
1123 extern void disable_overlay_breakpoints (void);
1125 extern void set_std_terminate_breakpoint (void);
1126 extern void delete_std_terminate_breakpoint (void);
1128 /* These functions respectively disable or reenable all currently
1129 enabled watchpoints. When disabled, the watchpoints are marked
1130 call_disabled. When re-enabled, they are marked enabled.
1132 The intended client of these functions is call_function_by_hand.
1134 The inferior must be stopped, and all breakpoints removed, when
1135 these functions are used.
1137 The need for these functions is that on some targets (e.g., HP-UX),
1138 gdb is unable to unwind through the dummy frame that is pushed as
1139 part of the implementation of a call command. Watchpoints can
1140 cause the inferior to stop in places where this frame is visible,
1141 and that can cause execution control to become very confused.
1143 Note that if a user sets breakpoints in an interactively called
1144 function, the call_disabled watchpoints will have been re-enabled
1145 when the first such breakpoint is reached. However, on targets
1146 that are unable to unwind through the call dummy frame, watches
1147 of stack-based storage may then be deleted, because gdb will
1148 believe that their watched storage is out of scope. (Sigh.) */
1149 extern void disable_watchpoints_before_interactive_call_start (void);
1151 extern void enable_watchpoints_after_interactive_call_stop (void);
1153 /* These functions disable and re-enable all breakpoints during
1154 inferior startup. They are intended to be called from solib
1155 code where necessary. This is needed on platforms where the
1156 main executable is relocated at some point during startup
1157 processing, making breakpoint addresses invalid.
1159 If additional breakpoints are created after the routine
1160 disable_breakpoints_before_startup but before the routine
1161 enable_breakpoints_after_startup was called, they will also
1162 be marked as disabled. */
1163 extern void disable_breakpoints_before_startup (void);
1164 extern void enable_breakpoints_after_startup (void);
1166 /* For script interpreters that need to define breakpoint commands
1167 after they've already read the commands into a struct
1169 extern enum command_control_type commands_from_control_command
1170 (char *arg
, struct command_line
*cmd
);
1172 extern void clear_breakpoint_hit_counts (void);
1174 extern struct breakpoint
*get_breakpoint (int num
);
1176 /* The following are for displays, which aren't really breakpoints,
1177 but here is as good a place as any for them. */
1179 extern void disable_current_display (void);
1181 extern void do_displays (void);
1183 extern void disable_display (int);
1185 extern void clear_displays (void);
1187 extern void disable_breakpoint (struct breakpoint
*);
1189 extern void enable_breakpoint (struct breakpoint
*);
1191 extern void breakpoint_set_commands (struct breakpoint
*b
,
1192 struct command_line
*commands
);
1194 extern void breakpoint_set_silent (struct breakpoint
*b
, int silent
);
1196 extern void breakpoint_set_thread (struct breakpoint
*b
, int thread
);
1198 extern void breakpoint_set_task (struct breakpoint
*b
, int task
);
1200 /* Clear the "inserted" flag in all breakpoints. */
1201 extern void mark_breakpoints_out (void);
1203 extern void make_breakpoint_permanent (struct breakpoint
*);
1205 extern struct breakpoint
*create_jit_event_breakpoint (struct gdbarch
*,
1208 extern struct breakpoint
*create_solib_event_breakpoint (struct gdbarch
*,
1211 extern struct breakpoint
*create_thread_event_breakpoint (struct gdbarch
*,
1214 extern void remove_jit_event_breakpoints (void);
1216 extern void remove_solib_event_breakpoints (void);
1218 extern void remove_thread_event_breakpoints (void);
1220 extern void disable_breakpoints_in_shlibs (void);
1222 /* This function returns TRUE if ep is a catchpoint. */
1223 extern int ep_is_catchpoint (struct breakpoint
*);
1225 /* Enable breakpoints and delete when hit. Called with ARG == NULL
1226 deletes all breakpoints. */
1227 extern void delete_command (char *arg
, int from_tty
);
1229 /* Manage a software single step breakpoint (or two). Insert may be
1230 called twice before remove is called. */
1231 extern void insert_single_step_breakpoint (struct gdbarch
*,
1232 struct address_space
*,
1234 extern int single_step_breakpoints_inserted (void);
1235 extern void remove_single_step_breakpoints (void);
1236 extern void cancel_single_step_breakpoints (void);
1238 /* Manage manual breakpoints, separate from the normal chain of
1239 breakpoints. These functions are used in murky target-specific
1240 ways. Please do not add more uses! */
1241 extern void *deprecated_insert_raw_breakpoint (struct gdbarch
*,
1242 struct address_space
*,
1244 extern int deprecated_remove_raw_breakpoint (struct gdbarch
*, void *);
1246 /* Check if any hardware watchpoints have triggered, according to the
1248 int watchpoints_triggered (struct target_waitstatus
*);
1250 /* Update BUF, which is LEN bytes read from the target address MEMADDR,
1251 by replacing any memory breakpoints with their shadowed contents. */
1252 void breakpoint_restore_shadows (gdb_byte
*buf
, ULONGEST memaddr
,
1255 extern int breakpoints_always_inserted_mode (void);
1257 /* Called each time new event from target is processed.
1258 Retires previously deleted breakpoint locations that
1259 in our opinion won't ever trigger. */
1260 extern void breakpoint_retire_moribund (void);
1262 /* Set break condition of breakpoint B to EXP. */
1263 extern void set_breakpoint_condition (struct breakpoint
*b
, char *exp
,
1266 /* Checks if we are catching syscalls or not.
1267 Returns 0 if not, greater than 0 if we are. */
1268 extern int catch_syscall_enabled (void);
1270 /* Checks if we are catching syscalls with the specific
1271 syscall_number. Used for "filtering" the catchpoints.
1272 Returns 0 if not, greater than 0 if we are. */
1273 extern int catching_syscall_number (int syscall_number
);
1275 /* Return a tracepoint with the given number if found. */
1276 extern struct breakpoint
*get_tracepoint (int num
);
1278 extern struct breakpoint
*get_tracepoint_by_number_on_target (int num
);
1280 /* Find a tracepoint by parsing a number in the supplied string. */
1281 extern struct breakpoint
*
1282 get_tracepoint_by_number (char **arg
,
1283 struct get_number_or_range_state
*state
,
1286 /* Return a vector of all tracepoints currently defined. The vector
1287 is newly allocated; the caller should free when done with it. */
1288 extern VEC(breakpoint_p
) *all_tracepoints (void);
1290 extern int is_tracepoint (const struct breakpoint
*b
);
1292 /* Return a vector of all static tracepoints defined at ADDR. The
1293 vector is newly allocated; the caller should free when done with
1295 extern VEC(breakpoint_p
) *static_tracepoints_here (CORE_ADDR addr
);
1297 /* Function that can be passed to read_command_line to validate
1298 that each command is suitable for tracepoint command list. */
1299 extern void check_tracepoint_command (char *line
, void *closure
);
1301 /* Call at the start and end of an "rbreak" command to register
1302 breakpoint numbers for a later "commands" command. */
1303 extern void start_rbreak_breakpoints (void);
1304 extern void end_rbreak_breakpoints (void);
1306 /* Breakpoint iterator function.
1308 Calls a callback function once for each breakpoint, so long as the
1309 callback function returns false. If the callback function returns
1310 true, the iteration will end and the current breakpoint will be
1311 returned. This can be useful for implementing a search for a
1312 breakpoint with arbitrary attributes, or for applying an operation
1313 to every breakpoint. */
1314 extern struct breakpoint
*iterate_over_breakpoints (int (*) (struct breakpoint
*,
1317 extern int user_breakpoint_p (struct breakpoint
*);
1319 #endif /* !defined (BREAKPOINT_H) */