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
;
32 /* This is the maximum number of bytes a breakpoint instruction can
33 take. Feel free to increase it. It's just used in a few places to
34 size arrays that should be independent of the target
37 #define BREAKPOINT_MAX 16
40 /* Type of breakpoint. */
41 /* FIXME In the future, we should fold all other breakpoint-like
42 things into here. This includes:
44 * single-step (for machines where we have to simulate single
45 stepping) (probably, though perhaps it is better for it to look as
46 much as possible like a single-step to wait_for_inferior). */
50 bp_none
= 0, /* Eventpoint has been deleted */
51 bp_breakpoint
, /* Normal breakpoint */
52 bp_hardware_breakpoint
, /* Hardware assisted breakpoint */
53 bp_until
, /* used by until command */
54 bp_finish
, /* used by finish command */
55 bp_watchpoint
, /* Watchpoint */
56 bp_hardware_watchpoint
, /* Hardware assisted watchpoint */
57 bp_read_watchpoint
, /* read watchpoint, (hardware assisted) */
58 bp_access_watchpoint
, /* access watchpoint, (hardware assisted) */
59 bp_longjmp
, /* secret breakpoint to find longjmp() */
60 bp_longjmp_resume
, /* secret breakpoint to escape longjmp() */
62 /* An internal breakpoint that is installed on the unwinder's
65 /* An internal breakpoint that is set at the point where an
66 exception will land. */
69 /* Used by wait_for_inferior for stepping over subroutine calls,
70 for stepping over signal handlers, and for skipping
74 /* Used to detect when a watchpoint expression has gone out of
75 scope. These breakpoints are usually not visible to the user.
77 This breakpoint has some interesting properties:
79 1) There's always a 1:1 mapping between watchpoints
80 on local variables and watchpoint_scope breakpoints.
82 2) It automatically deletes itself and the watchpoint it's
83 associated with when hit.
85 3) It can never be disabled. */
88 /* The breakpoint at the end of a call dummy. */
89 /* FIXME: What if the function we are calling longjmp()s out of
90 the call, or the user gets out with the "return" command? We
91 currently have no way of cleaning up the breakpoint in these
92 (obscure) situations. (Probably can solve this by noticing
93 longjmp, "return", etc., it's similar to noticing when a
94 watchpoint on a local variable goes out of scope (with hardware
95 support for watchpoints)). */
98 /* A breakpoint set on std::terminate, that is used to catch
99 otherwise uncaught exceptions thrown during an inferior call. */
102 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
103 code in the inferior to run when significant events occur in the
104 dynamic linker (for example a library is loaded or unloaded).
106 By placing a breakpoint in this magic code GDB will get control
107 when these significant events occur. GDB can then re-examine
108 the dynamic linker's data structures to discover any newly loaded
109 dynamic libraries. */
112 /* Some multi-threaded systems can arrange for a location in the
113 inferior to be executed when certain thread-related events occur
114 (such as thread creation or thread death).
116 By placing a breakpoint at one of these locations, GDB will get
117 control when these events occur. GDB can then update its thread
122 /* On the same principal, an overlay manager can arrange to call a
123 magic location in the inferior whenever there is an interesting
124 change in overlay status. GDB can update its overlay tables
125 and fiddle with breakpoints in overlays when this breakpoint
130 /* Master copies of longjmp breakpoints. These are always installed
131 as soon as an objfile containing longjmp is loaded, but they are
132 always disabled. While necessary, temporary clones of bp_longjmp
133 type will be created and enabled. */
137 /* Master copies of std::terminate breakpoints. */
138 bp_std_terminate_master
,
140 /* Like bp_longjmp_master, but for exceptions. */
147 bp_static_tracepoint
,
149 /* Event for JIT compiled code generation or deletion. */
153 /* States of enablement of breakpoint. */
157 bp_disabled
, /* The eventpoint is inactive, and cannot
159 bp_enabled
, /* The eventpoint is active, and can
161 bp_call_disabled
, /* The eventpoint has been disabled while a
162 call into the inferior is "in flight",
163 because some eventpoints interfere with
164 the implementation of a call on some
165 targets. The eventpoint will be
166 automatically enabled and reset when the
167 call "lands" (either completes, or stops
168 at another eventpoint). */
169 bp_startup_disabled
, /* The eventpoint has been disabled during
170 inferior startup. This is necessary on
171 some targets where the main executable
172 will get relocated during startup, making
173 breakpoint addresses invalid. The
174 eventpoint will be automatically enabled
175 and reset once inferior startup is
177 bp_permanent
/* There is a breakpoint instruction
178 hard-wired into the target's code. Don't
179 try to write another breakpoint
180 instruction on top of it, or restore its
181 value. Step over it using the
182 architecture's SKIP_INSN macro. */
186 /* Disposition of breakpoint. Ie: what to do after hitting it. */
190 disp_del
, /* Delete it */
191 disp_del_at_next_stop
, /* Delete at next stop,
192 whether hit or not */
193 disp_disable
, /* Disable it */
194 disp_donttouch
/* Leave it alone */
197 enum target_hw_bp_type
199 hw_write
= 0, /* Common HW watchpoint */
200 hw_read
= 1, /* Read HW watchpoint */
201 hw_access
= 2, /* Access HW watchpoint */
202 hw_execute
= 3 /* Execute HW breakpoint */
206 /* Information used by targets to insert and remove breakpoints. */
208 struct bp_target_info
210 /* Address space at which the breakpoint was placed. */
211 struct address_space
*placed_address_space
;
213 /* Address at which the breakpoint was placed. This is normally the
214 same as ADDRESS from the bp_location, except when adjustment
215 happens in gdbarch_breakpoint_from_pc. The most common form of
216 adjustment is stripping an alternate ISA marker from the PC which
217 is used to determine the type of breakpoint to insert. */
218 CORE_ADDR placed_address
;
220 /* If the breakpoint lives in memory and reading that memory would
221 give back the breakpoint, instead of the original contents, then
222 the original contents are cached here. Only SHADOW_LEN bytes of
223 this buffer are valid, and only when the breakpoint is inserted. */
224 gdb_byte shadow_contents
[BREAKPOINT_MAX
];
226 /* The length of the data cached in SHADOW_CONTENTS. */
229 /* The size of the placed breakpoint, according to
230 gdbarch_breakpoint_from_pc, when the breakpoint was inserted.
231 This is generally the same as SHADOW_LEN, unless we did not need
232 to read from the target to implement the memory breakpoint
233 (e.g. if a remote stub handled the details). We may still need
234 the size to remove the breakpoint safely. */
238 /* GDB maintains two types of information about each breakpoint (or
239 watchpoint, or other related event). The first type corresponds
240 to struct breakpoint; this is a relatively high-level structure
241 which contains the source location(s), stopping conditions, user
242 commands to execute when the breakpoint is hit, and so forth.
244 The second type of information corresponds to struct bp_location.
245 Each breakpoint has one or (eventually) more locations associated
246 with it, which represent target-specific and machine-specific
247 mechanisms for stopping the program. For instance, a watchpoint
248 expression may require multiple hardware watchpoints in order to
249 catch all changes in the value of the expression being watched. */
253 bp_loc_software_breakpoint
,
254 bp_loc_hardware_breakpoint
,
255 bp_loc_hardware_watchpoint
,
256 bp_loc_other
/* Miscellaneous... */
261 /* Chain pointer to the next breakpoint location for
262 the same parent breakpoint. */
263 struct bp_location
*next
;
265 /* The reference count. */
268 /* Type of this breakpoint location. */
269 enum bp_loc_type loc_type
;
271 /* Each breakpoint location must belong to exactly one higher-level
272 breakpoint. This pointer is NULL iff this bp_location is no
273 longer attached to a breakpoint. For example, when a breakpoint
274 is deleted, its locations may still be found in the
275 moribund_locations list, or if we had stopped for it, in
277 struct breakpoint
*owner
;
279 /* Conditional. Break only if this expression's value is nonzero.
280 Unlike string form of condition, which is associated with
281 breakpoint, this is associated with location, since if breakpoint
282 has several locations, the evaluation of expression can be
283 different for different locations. Only valid for real
284 breakpoints; a watchpoint's conditional expression is stored in
285 the owner breakpoint object. */
286 struct expression
*cond
;
288 /* This location's address is in an unloaded solib, and so this
289 location should not be inserted. It will be automatically
290 enabled when that solib is loaded. */
293 /* Is this particular location enabled. */
296 /* Nonzero if this breakpoint is now inserted. */
299 /* Nonzero if this is not the first breakpoint in the list
300 for the given address. */
303 /* If we someday support real thread-specific breakpoints, then
304 the breakpoint location will need a thread identifier. */
306 /* Data for specific breakpoint types. These could be a union, but
307 simplicity is more important than memory usage for breakpoints. */
309 /* Architecture associated with this location's address. May be
310 different from the breakpoint architecture. */
311 struct gdbarch
*gdbarch
;
313 /* The program space associated with this breakpoint location
314 address. Note that an address space may be represented in more
315 than one program space (e.g. each uClinux program will be given
316 its own program space, but there will only be one address space
317 for all of them), but we must not insert more than one location
318 at the same address in the same address space. */
319 struct program_space
*pspace
;
321 /* Note that zero is a perfectly valid code address on some platforms
322 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
323 is not a special value for this field. Valid for all types except
327 /* For hardware watchpoints, the size of data ad ADDRESS being
331 /* Type of hardware watchpoint. */
332 enum target_hw_bp_type watchpoint_type
;
334 /* For any breakpoint type with an address, this is the section
335 associated with the address. Used primarily for overlay
337 struct obj_section
*section
;
339 /* Address at which breakpoint was requested, either by the user or
340 by GDB for internal breakpoints. This will usually be the same
341 as ``address'' (above) except for cases in which
342 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
343 which to place the breakpoint in order to comply with a
344 processor's architectual constraints. */
345 CORE_ADDR requested_address
;
349 /* Details of the placed breakpoint, when inserted. */
350 struct bp_target_info target_info
;
352 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
353 struct bp_target_info overlay_target_info
;
355 /* In a non-stop mode, it's possible that we delete a breakpoint,
356 but as we do that, some still running thread hits that breakpoint.
357 For that reason, we need to keep locations belonging to deleted
358 breakpoints for a bit, so that don't report unexpected SIGTRAP.
359 We can't keep such locations forever, so we use a heuristic --
360 after we process certain number of inferior events since
361 breakpoint was deleted, we retire all locations of that breakpoint.
362 This variable keeps a number of events still to go, when
363 it becomes 0 this location is retired. */
364 int events_till_retirement
;
367 /* This structure is a collection of function pointers that, if available,
368 will be called instead of the performing the default action for this
371 struct breakpoint_ops
373 /* Insert the breakpoint or activate the catchpoint. Should raise
374 an exception if the operation failed. */
375 void (*insert
) (struct breakpoint
*);
377 /* Remove the breakpoint/catchpoint that was previously inserted
378 with the "insert" method above. Return non-zero if the operation
380 int (*remove
) (struct breakpoint
*);
382 /* Return non-zero if the debugger should tell the user that this
383 breakpoint was hit. */
384 int (*breakpoint_hit
) (struct breakpoint
*);
386 /* The normal print routine for this breakpoint, called when we
388 enum print_stop_action (*print_it
) (struct breakpoint
*);
390 /* Display information about this breakpoint, for "info
392 void (*print_one
) (struct breakpoint
*, struct bp_location
**);
394 /* Display information about this breakpoint after setting it
395 (roughly speaking; this is called from "mention"). */
396 void (*print_mention
) (struct breakpoint
*);
398 /* Print to FP the CLI command that recreates this breakpoint. */
399 void (*print_recreate
) (struct breakpoint
*, struct ui_file
*fp
);
402 enum watchpoint_triggered
404 /* This watchpoint definitely did not trigger. */
405 watch_triggered_no
= 0,
407 /* Some hardware watchpoint triggered, and it might have been this
408 one, but we do not know which it was. */
409 watch_triggered_unknown
,
411 /* This hardware watchpoint definitely did trigger. */
415 /* This is used to declare the VEC syscalls_to_be_caught. */
418 typedef struct bp_location
*bp_location_p
;
419 DEF_VEC_P(bp_location_p
);
421 /* A reference-counted struct command_line. This lets multiple
422 breakpoints share a single command list. This is an implementation
423 detail to the breakpoints module. */
424 struct counted_command_line
;
426 /* Note that the ->silent field is not currently used by any commands
427 (though the code is in there if it was to be, and set_raw_breakpoint
428 does set it to 0). I implemented it because I thought it would be
429 useful for a hack I had to put in; I'm going to leave it in because
430 I can see how there might be times when it would indeed be useful */
432 /* This is for a breakpoint or a watchpoint. */
436 struct breakpoint
*next
;
437 /* Type of breakpoint. */
439 /* Zero means disabled; remember the info but don't break here. */
440 enum enable_state enable_state
;
441 /* What to do with this breakpoint after we hit it. */
442 enum bpdisp disposition
;
443 /* Number assigned to distinguish breakpoints. */
446 /* Location(s) associated with this high-level breakpoint. */
447 struct bp_location
*loc
;
449 /* Line number of this address. */
453 /* Source file name of this address. */
457 /* Non-zero means a silent breakpoint (don't print frame info
459 unsigned char silent
;
460 /* Number of stops at this breakpoint that should
461 be continued automatically before really stopping. */
463 /* Chain of command lines to execute when this breakpoint is
465 struct counted_command_line
*commands
;
466 /* Stack depth (address of frame). If nonzero, break only if fp
468 struct frame_id frame_id
;
470 /* The program space used to set the breakpoint. */
471 struct program_space
*pspace
;
473 /* String we used to set the breakpoint (malloc'd). */
475 /* Architecture we used to set the breakpoint. */
476 struct gdbarch
*gdbarch
;
477 /* Language we used to set the breakpoint. */
478 enum language language
;
479 /* Input radix we used to set the breakpoint. */
481 /* String form of the breakpoint condition (malloc'd), or NULL if
482 there is no condition. */
484 /* String form of exp to use for displaying to the user
485 (malloc'd), or NULL if none. */
487 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
488 char *exp_string_reparse
;
490 /* The expression we are watching, or NULL if not a watchpoint. */
491 struct expression
*exp
;
492 /* The largest block within which it is valid, or NULL if it is
493 valid anywhere (e.g. consists just of global symbols). */
494 struct block
*exp_valid_block
;
495 /* The conditional expression if any. NULL if not a watchpoint. */
496 struct expression
*cond_exp
;
497 /* The largest block within which it is valid, or NULL if it is
498 valid anywhere (e.g. consists just of global symbols). */
499 struct block
*cond_exp_valid_block
;
500 /* Value of the watchpoint the last time we checked it, or NULL
501 when we do not know the value yet or the value was not
502 readable. VAL is never lazy. */
504 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
505 then an error occurred reading the value. */
508 /* Holds the address of the related watchpoint_scope breakpoint
509 when using watchpoints on local variables (might the concept of
510 a related breakpoint be useful elsewhere, if not just call it
511 the watchpoint_scope breakpoint or something like that.
513 struct breakpoint
*related_breakpoint
;
515 /* Holds the frame address which identifies the frame this
516 watchpoint should be evaluated in, or `null' if the watchpoint
517 should be evaluated on the outermost frame. */
518 struct frame_id watchpoint_frame
;
520 /* Holds the thread which identifies the frame this watchpoint
521 should be considered in scope for, or `null_ptid' if the
522 watchpoint should be evaluated in all threads. */
523 ptid_t watchpoint_thread
;
525 /* For hardware watchpoints, the triggered status according to the
527 enum watchpoint_triggered watchpoint_triggered
;
529 /* Thread number for thread-specific breakpoint,
530 or -1 if don't care. */
533 /* Ada task number for task-specific breakpoint,
534 or 0 if don't care. */
537 /* Count of the number of times this breakpoint was taken, dumped
538 with the info, but not used for anything else. Useful for
539 seeing how many times you hit a break prior to the program
540 aborting, so you can back up to just before the abort. */
543 /* Process id of a child process whose forking triggered this
544 catchpoint. This field is only valid immediately after this
545 catchpoint has triggered. */
546 ptid_t forked_inferior_pid
;
548 /* Filename of a program whose exec triggered this catchpoint.
549 This field is only valid immediately after this catchpoint has
553 /* Syscall numbers used for the 'catch syscall' feature. If no
554 syscall has been specified for filtering, its value is NULL.
555 Otherwise, it holds a list of all syscalls to be caught. The
556 list elements are allocated with xmalloc. */
557 VEC(int) *syscalls_to_be_caught
;
559 /* Methods associated with this breakpoint. */
560 struct breakpoint_ops
*ops
;
562 /* Is breakpoint's condition not yet parsed because we found
563 no location initially so had no context to parse
565 int condition_not_parsed
;
567 /* Number of times this tracepoint should single-step
568 and collect additional data. */
571 /* Number of times this tracepoint should be hit before
575 /* The number of the tracepoint on the target. */
576 int number_on_target
;
578 /* The static tracepoint marker id, if known. */
579 char *static_trace_marker_id
;
581 /* LTTng/UST allow more than one marker with the same ID string,
582 although it unadvised because it confuses tools. When setting
583 static tracepoints by marker ID, this will record the index in
584 the array of markers we found for the given marker ID for which
585 this static tracepoint corresponds. When resetting
586 breakpoints, we will use this index to try to find the same
588 int static_trace_marker_id_idx
;
590 /* With a Python scripting enabled GDB, store a reference to the
591 Python object that has been associated with this breakpoint.
592 This is always NULL for a GDB that is not script enabled. It
593 can sometimes be NULL for enabled GDBs as not all breakpoint
594 types are tracked by the Python scripting API. */
595 struct breakpoint_object
*py_bp_object
;
598 typedef struct breakpoint
*breakpoint_p
;
599 DEF_VEC_P(breakpoint_p
);
601 /* The following stuff is an abstract data type "bpstat" ("breakpoint
602 status"). This provides the ability to determine whether we have
603 stopped at a breakpoint, and what we should do about it. */
605 typedef struct bpstats
*bpstat
;
607 /* Clears a chain of bpstat, freeing storage
609 extern void bpstat_clear (bpstat
*);
611 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
612 is part of the bpstat is copied as well. */
613 extern bpstat
bpstat_copy (bpstat
);
615 extern bpstat
bpstat_stop_status (struct address_space
*aspace
,
616 CORE_ADDR pc
, ptid_t ptid
);
618 /* This bpstat_what stuff tells wait_for_inferior what to do with a
619 breakpoint (a challenging task).
621 The enum values order defines priority-like order of the actions.
622 Once you've decided that some action is appropriate, you'll never
623 go back and decide something of a lower priority is better. Each
624 of these actions is mutually exclusive with the others. That
625 means, that if you find yourself adding a new action class here and
626 wanting to tell GDB that you have two simultaneous actions to
627 handle, something is wrong, and you probably don't actually need a
630 Note that a step resume breakpoint overrides another breakpoint of
631 signal handling (see comment in wait_for_inferior at where we set
632 the step_resume breakpoint). */
634 enum bpstat_what_main_action
636 /* Perform various other tests; that is, this bpstat does not
637 say to perform any action (e.g. failed watchpoint and nothing
639 BPSTAT_WHAT_KEEP_CHECKING
,
641 /* Remove breakpoints, single step once, then put them back in and
642 go back to what we were doing. It's possible that this should
643 be removed from the main_action and put into a separate field,
644 to more cleanly handle
645 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
648 /* Set longjmp_resume breakpoint, remove all other breakpoints,
649 and continue. The "remove all other breakpoints" part is
650 required if we are also stepping over another breakpoint as
651 well as doing the longjmp handling. */
652 BPSTAT_WHAT_SET_LONGJMP_RESUME
,
654 /* Clear longjmp_resume breakpoint, then handle as
655 BPSTAT_WHAT_KEEP_CHECKING. */
656 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME
,
658 /* Rather than distinguish between noisy and silent stops here, it
659 might be cleaner to have bpstat_print make that decision (also
660 taking into account stop_print_frame and source_only). But the
661 implications are a bit scary (interaction with auto-displays,
662 etc.), so I won't try it. */
665 BPSTAT_WHAT_STOP_SILENT
,
667 /* Stop and print. */
668 BPSTAT_WHAT_STOP_NOISY
,
670 /* Clear step resume breakpoint, and keep checking. */
671 BPSTAT_WHAT_STEP_RESUME
,
674 /* An enum indicating the kind of "stack dummy" stop. This is a bit
675 of a misnomer because only one kind of truly a stack dummy. */
678 /* We didn't stop at a stack dummy breakpoint. */
681 /* Stopped at a stack dummy. */
684 /* Stopped at std::terminate. */
690 enum bpstat_what_main_action main_action
;
692 /* Did we hit a call dummy breakpoint? This only goes with a
693 main_action of BPSTAT_WHAT_STOP_SILENT or
694 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
695 dummy without popping the frame is not a useful one). */
696 enum stop_stack_kind call_dummy
;
698 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
699 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
700 longjmp, false if we are handling an exception. */
704 /* The possible return values for print_bpstat, print_it_normal,
705 print_it_done, print_it_noop. */
706 enum print_stop_action
714 /* Tell what to do about this bpstat. */
715 struct bpstat_what
bpstat_what (bpstat
);
717 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
718 bpstat
bpstat_find_breakpoint (bpstat
, struct breakpoint
*);
720 /* Nonzero if a signal that we got in wait() was due to circumstances
721 explained by the BS. */
722 /* Currently that is true if we have hit a breakpoint, or if there is
723 a watchpoint enabled. */
724 #define bpstat_explains_signal(bs) ((bs) != NULL)
726 /* Nonzero is this bpstat causes a stop. */
727 extern int bpstat_causes_stop (bpstat
);
729 /* Nonzero if we should step constantly (e.g. watchpoints on machines
730 without hardware support). This isn't related to a specific bpstat,
731 just to things like whether watchpoints are set. */
732 extern int bpstat_should_step (void);
734 /* Print a message indicating what happened. Returns nonzero to
735 say that only the source line should be printed after this (zero
736 return means print the frame as well as the source line). */
737 extern enum print_stop_action
bpstat_print (bpstat
);
739 /* Put in *NUM the breakpoint number of the first breakpoint we are
740 stopped at. *BSP upon return is a bpstat which points to the
741 remaining breakpoints stopped at (but which is not guaranteed to be
742 good for anything but further calls to bpstat_num).
744 Return 0 if passed a bpstat which does not indicate any breakpoints.
745 Return -1 if stopped at a breakpoint that has been deleted since
747 Return 1 otherwise. */
748 extern int bpstat_num (bpstat
*, int *);
750 /* Perform actions associated with the stopped inferior. Actually, we
751 just use this for breakpoint commands. Perhaps other actions will
752 go here later, but this is executed at a late time (from the
754 extern void bpstat_do_actions (void);
756 /* Modify BS so that the actions will not be performed. */
757 extern void bpstat_clear_actions (bpstat
);
759 /* Implementation: */
761 /* Values used to tell the printing routine how to behave for this
765 /* This is used when we want to do a normal printing of the reason
766 for stopping. The output will depend on the type of eventpoint
767 we are dealing with. This is the default value, most commonly
770 /* This is used when nothing should be printed for this bpstat
773 /* This is used when everything which needs to be printed has
774 already been printed. But we still want to print the frame. */
780 /* Linked list because there can be more than one breakpoint at
781 the same place, and a bpstat reflects the fact that all have
785 /* Location that caused the stop. Locations are refcounted, so
786 this will never be NULL. Note that this location may end up
787 detached from a breakpoint, but that does not necessary mean
788 that the struct breakpoint is gone. E.g., consider a
789 watchpoint with a condition that involves an inferior function
790 call. Watchpoint locations are recreated often (on resumes,
791 hence on infcalls too). Between creating the bpstat and after
792 evaluating the watchpoint condition, this location may hence
793 end up detached from its original owner watchpoint, even though
794 the watchpoint is still listed. If it's condition evaluates as
795 true, we still want this location to cause a stop, and we will
796 still need to know which watchpoint it was originally attached.
797 What this means is that we should not (in most cases) follow
798 the `bpstat->bp_location->owner' link, but instead use the
799 `breakpoint_at' field below. */
800 struct bp_location
*bp_location_at
;
802 /* Breakpoint that caused the stop. This is nullified if the
803 breakpoint ends up being deleted. See comments on
804 `bp_location_at' above for why do we need this field instead of
805 following the location's owner. */
806 struct breakpoint
*breakpoint_at
;
808 /* The associated command list. */
809 struct counted_command_line
*commands
;
811 /* Commands left to be done. This points somewhere in
813 struct command_line
*commands_left
;
815 /* Old value associated with a watchpoint. */
816 struct value
*old_val
;
818 /* Nonzero if this breakpoint tells us to print the frame. */
821 /* Nonzero if this breakpoint tells us to stop. */
824 /* Tell bpstat_print and print_bp_stop_message how to print stuff
825 associated with this element of the bpstat chain. */
826 enum bp_print_how print_it
;
837 /* The possible return values for breakpoint_here_p.
838 We guarantee that zero always means "no breakpoint here". */
841 no_breakpoint_here
= 0,
842 ordinary_breakpoint_here
,
843 permanent_breakpoint_here
847 /* Prototypes for breakpoint-related functions. */
849 extern enum breakpoint_here
breakpoint_here_p (struct address_space
*,
852 extern int moribund_breakpoint_here_p (struct address_space
*, CORE_ADDR
);
854 extern int breakpoint_inserted_here_p (struct address_space
*, CORE_ADDR
);
856 extern int regular_breakpoint_inserted_here_p (struct address_space
*,
859 extern int software_breakpoint_inserted_here_p (struct address_space
*,
862 /* Returns true if there's a hardware watchpoint or access watchpoint
863 inserted in the range defined by ADDR and LEN. */
864 extern int hardware_watchpoint_inserted_in_range (struct address_space
*,
868 extern int breakpoint_thread_match (struct address_space
*,
871 extern void until_break_command (char *, int, int);
873 extern void breakpoint_re_set (void);
875 extern void breakpoint_re_set_thread (struct breakpoint
*);
877 extern struct breakpoint
*set_momentary_breakpoint
878 (struct gdbarch
*, struct symtab_and_line
, struct frame_id
, enum bptype
);
880 extern struct breakpoint
*set_momentary_breakpoint_at_pc
881 (struct gdbarch
*, CORE_ADDR pc
, enum bptype type
);
883 extern struct breakpoint
*clone_momentary_breakpoint (struct breakpoint
*bpkt
);
885 extern void set_ignore_count (int, int, int);
887 extern void set_default_breakpoint (int, struct program_space
*,
888 CORE_ADDR
, struct symtab
*, int);
890 extern void breakpoint_init_inferior (enum inf_context
);
892 extern struct cleanup
*make_cleanup_delete_breakpoint (struct breakpoint
*);
894 extern void delete_breakpoint (struct breakpoint
*);
896 extern void breakpoint_auto_delete (bpstat
);
898 /* Return the chain of command lines to execute when this breakpoint
900 extern struct command_line
*breakpoint_commands (struct breakpoint
*b
);
902 extern void break_command (char *, int);
904 extern void hbreak_command_wrapper (char *, int);
905 extern void thbreak_command_wrapper (char *, int);
906 extern void rbreak_command_wrapper (char *, int);
907 extern void watch_command_wrapper (char *, int, int);
908 extern void awatch_command_wrapper (char *, int, int);
909 extern void rwatch_command_wrapper (char *, int, int);
910 extern void tbreak_command (char *, int);
912 extern int create_breakpoint (struct gdbarch
*gdbarch
, char *arg
,
913 char *cond_string
, int thread
,
914 int parse_condition_and_thread
,
915 int tempflag
, enum bptype wanted_type
,
917 enum auto_boolean pending_break_support
,
918 struct breakpoint_ops
*ops
,
923 extern void insert_breakpoints (void);
925 extern int remove_breakpoints (void);
927 extern int remove_breakpoints_pid (int pid
);
929 /* This function can be used to physically insert eventpoints from the
930 specified traced inferior process, without modifying the breakpoint
931 package's state. This can be useful for those targets which
932 support following the processes of a fork() or vfork() system call,
933 when both of the resulting two processes are to be followed. */
934 extern int reattach_breakpoints (int);
936 /* This function can be used to update the breakpoint package's state
937 after an exec() system call has been executed.
939 This function causes the following:
941 - All eventpoints are marked "not inserted".
942 - All eventpoints with a symbolic address are reset such that
943 the symbolic address must be reevaluated before the eventpoints
945 - The solib breakpoints are explicitly removed from the breakpoint
947 - A step-resume breakpoint, if any, is explicitly removed from the
949 - All eventpoints without a symbolic address are removed from the
951 extern void update_breakpoints_after_exec (void);
953 /* This function can be used to physically remove hardware breakpoints
954 and watchpoints from the specified traced inferior process, without
955 modifying the breakpoint package's state. This can be useful for
956 those targets which support following the processes of a fork() or
957 vfork() system call, when one of the resulting two processes is to
958 be detached and allowed to run free.
960 It is an error to use this function on the process whose id is
962 extern int detach_breakpoints (int);
964 /* This function is called when program space PSPACE is about to be
965 deleted. It takes care of updating breakpoints to not reference
966 this PSPACE anymore. */
967 extern void breakpoint_program_space_exit (struct program_space
*pspace
);
969 extern void set_longjmp_breakpoint (struct thread_info
*tp
,
970 struct frame_id frame
);
971 extern void delete_longjmp_breakpoint (int thread
);
973 extern void enable_overlay_breakpoints (void);
974 extern void disable_overlay_breakpoints (void);
976 extern void set_std_terminate_breakpoint (void);
977 extern void delete_std_terminate_breakpoint (void);
979 /* These functions respectively disable or reenable all currently
980 enabled watchpoints. When disabled, the watchpoints are marked
981 call_disabled. When reenabled, they are marked enabled.
983 The intended client of these functions is call_function_by_hand.
985 The inferior must be stopped, and all breakpoints removed, when
986 these functions are used.
988 The need for these functions is that on some targets (e.g., HP-UX),
989 gdb is unable to unwind through the dummy frame that is pushed as
990 part of the implementation of a call command. Watchpoints can
991 cause the inferior to stop in places where this frame is visible,
992 and that can cause execution control to become very confused.
994 Note that if a user sets breakpoints in an interactively called
995 function, the call_disabled watchpoints will have been reenabled
996 when the first such breakpoint is reached. However, on targets
997 that are unable to unwind through the call dummy frame, watches
998 of stack-based storage may then be deleted, because gdb will
999 believe that their watched storage is out of scope. (Sigh.) */
1000 extern void disable_watchpoints_before_interactive_call_start (void);
1002 extern void enable_watchpoints_after_interactive_call_stop (void);
1004 /* These functions disable and re-enable all breakpoints during
1005 inferior startup. They are intended to be called from solib
1006 code where necessary. This is needed on platforms where the
1007 main executable is relocated at some point during startup
1008 processing, making breakpoint addresses invalid.
1010 If additional breakpoints are created after the routine
1011 disable_breakpoints_before_startup but before the routine
1012 enable_breakpoints_after_startup was called, they will also
1013 be marked as disabled. */
1014 extern void disable_breakpoints_before_startup (void);
1015 extern void enable_breakpoints_after_startup (void);
1017 /* For script interpreters that need to define breakpoint commands
1018 after they've already read the commands into a struct
1020 extern enum command_control_type commands_from_control_command
1021 (char *arg
, struct command_line
*cmd
);
1023 extern void clear_breakpoint_hit_counts (void);
1025 extern int get_number (char **);
1027 extern int get_number_or_range (char **);
1029 extern struct breakpoint
*get_breakpoint (int num
);
1031 /* The following are for displays, which aren't really breakpoints,
1032 but here is as good a place as any for them. */
1034 extern void disable_current_display (void);
1036 extern void do_displays (void);
1038 extern void disable_display (int);
1040 extern void clear_displays (void);
1042 extern void disable_breakpoint (struct breakpoint
*);
1044 extern void enable_breakpoint (struct breakpoint
*);
1046 extern void breakpoint_set_commands (struct breakpoint
*b
,
1047 struct command_line
*commands
);
1049 /* Clear the "inserted" flag in all breakpoints. */
1050 extern void mark_breakpoints_out (void);
1052 extern void make_breakpoint_permanent (struct breakpoint
*);
1054 extern struct breakpoint
*create_jit_event_breakpoint (struct gdbarch
*,
1057 extern struct breakpoint
*create_solib_event_breakpoint (struct gdbarch
*,
1060 extern struct breakpoint
*create_thread_event_breakpoint (struct gdbarch
*,
1063 extern void remove_solib_event_breakpoints (void);
1065 extern void remove_thread_event_breakpoints (void);
1067 extern void disable_breakpoints_in_shlibs (void);
1069 /* This function returns TRUE if ep is a catchpoint. */
1070 extern int ep_is_catchpoint (struct breakpoint
*);
1072 /* Enable breakpoints and delete when hit. Called with ARG == NULL
1073 deletes all breakpoints. */
1074 extern void delete_command (char *arg
, int from_tty
);
1076 /* Pull all H/W watchpoints from the target. Return non-zero if the
1078 extern int remove_hw_watchpoints (void);
1080 /* Manage a software single step breakpoint (or two). Insert may be
1081 called twice before remove is called. */
1082 extern void insert_single_step_breakpoint (struct gdbarch
*,
1083 struct address_space
*,
1085 extern int single_step_breakpoints_inserted (void);
1086 extern void remove_single_step_breakpoints (void);
1087 extern void cancel_single_step_breakpoints (void);
1089 /* Manage manual breakpoints, separate from the normal chain of
1090 breakpoints. These functions are used in murky target-specific
1091 ways. Please do not add more uses! */
1092 extern void *deprecated_insert_raw_breakpoint (struct gdbarch
*,
1093 struct address_space
*,
1095 extern int deprecated_remove_raw_breakpoint (struct gdbarch
*, void *);
1097 /* Check if any hardware watchpoints have triggered, according to the
1099 int watchpoints_triggered (struct target_waitstatus
*);
1101 /* Update BUF, which is LEN bytes read from the target address MEMADDR,
1102 by replacing any memory breakpoints with their shadowed contents. */
1103 void breakpoint_restore_shadows (gdb_byte
*buf
, ULONGEST memaddr
,
1106 extern int breakpoints_always_inserted_mode (void);
1108 /* Called each time new event from target is processed.
1109 Retires previously deleted breakpoint locations that
1110 in our opinion won't ever trigger. */
1111 extern void breakpoint_retire_moribund (void);
1113 /* Set break condition of breakpoint B to EXP. */
1114 extern void set_breakpoint_condition (struct breakpoint
*b
, char *exp
,
1117 /* Checks if we are catching syscalls or not.
1118 Returns 0 if not, greater than 0 if we are. */
1119 extern int catch_syscall_enabled (void);
1121 /* Checks if we are catching syscalls with the specific
1122 syscall_number. Used for "filtering" the catchpoints.
1123 Returns 0 if not, greater than 0 if we are. */
1124 extern int catching_syscall_number (int syscall_number
);
1126 /* Tell a breakpoint to be quiet. */
1127 extern void make_breakpoint_silent (struct breakpoint
*);
1129 /* Return a tracepoint with the given number if found. */
1130 extern struct breakpoint
*get_tracepoint (int num
);
1132 extern struct breakpoint
*get_tracepoint_by_number_on_target (int num
);
1134 /* Find a tracepoint by parsing a number in the supplied string. */
1135 extern struct breakpoint
*get_tracepoint_by_number (char **arg
,
1139 /* Return a vector of all tracepoints currently defined. The vector
1140 is newly allocated; the caller should free when done with it. */
1141 extern VEC(breakpoint_p
) *all_tracepoints (void);
1143 extern int is_tracepoint (const struct breakpoint
*b
);
1145 /* Return a vector of all static tracepoints defined at ADDR. The
1146 vector is newly allocated; the caller should free when done with
1148 extern VEC(breakpoint_p
) *static_tracepoints_here (CORE_ADDR addr
);
1150 /* Function that can be passed to read_command_line to validate
1151 that each command is suitable for tracepoint command list. */
1152 extern void check_tracepoint_command (char *line
, void *closure
);
1154 /* Call at the start and end of an "rbreak" command to register
1155 breakpoint numbers for a later "commands" command. */
1156 extern void start_rbreak_breakpoints (void);
1157 extern void end_rbreak_breakpoints (void);
1159 /* Breakpoint iterator function.
1161 Calls a callback function once for each breakpoint, so long as the
1162 callback function returns false. If the callback function returns
1163 true, the iteration will end and the current breakpoint will be
1164 returned. This can be useful for implementing a search for a
1165 breakpoint with arbitrary attributes, or for applying an operation
1166 to every breakpoint. */
1167 extern struct breakpoint
*iterate_over_breakpoints (int (*) (struct breakpoint
*,
1170 #endif /* !defined (BREAKPOINT_H) */