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 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #if !defined (BREAKPOINT_H)
21 #define BREAKPOINT_H 1
30 /* This is the maximum number of bytes a breakpoint instruction can take.
31 Feel free to increase it. It's just used in a few places to size
32 arrays that should be independent of the target architecture. */
34 #define BREAKPOINT_MAX 16
37 /* Type of breakpoint. */
38 /* FIXME In the future, we should fold all other breakpoint-like things into
41 * single-step (for machines where we have to simulate single stepping)
42 (probably, though perhaps it is better for it to look as much as
43 possible like a single-step to wait_for_inferior). */
47 bp_none
= 0, /* Eventpoint has been deleted. */
48 bp_breakpoint
, /* Normal breakpoint */
49 bp_hardware_breakpoint
, /* Hardware assisted breakpoint */
50 bp_until
, /* used by until command */
51 bp_finish
, /* used by finish command */
52 bp_watchpoint
, /* Watchpoint */
53 bp_hardware_watchpoint
, /* Hardware assisted watchpoint */
54 bp_read_watchpoint
, /* read watchpoint, (hardware assisted) */
55 bp_access_watchpoint
, /* access watchpoint, (hardware assisted) */
56 bp_longjmp
, /* secret breakpoint to find longjmp() */
57 bp_longjmp_resume
, /* secret breakpoint to escape longjmp() */
59 /* Used by wait_for_inferior for stepping over subroutine calls, for
60 stepping over signal handlers, and for skipping prologues. */
63 /* Used to detect when a watchpoint expression has gone out of
64 scope. These breakpoints are usually not visible to the user.
66 This breakpoint has some interesting properties:
68 1) There's always a 1:1 mapping between watchpoints
69 on local variables and watchpoint_scope breakpoints.
71 2) It automatically deletes itself and the watchpoint it's
72 associated with when hit.
74 3) It can never be disabled. */
77 /* The breakpoint at the end of a call dummy. */
78 /* FIXME: What if the function we are calling longjmp()s out of the
79 call, or the user gets out with the "return" command? We currently
80 have no way of cleaning up the breakpoint in these (obscure) situations.
81 (Probably can solve this by noticing longjmp, "return", etc., it's
82 similar to noticing when a watchpoint on a local variable goes out
83 of scope (with hardware support for watchpoints)). */
86 /* A breakpoint set on std::terminate, that is used to catch
87 otherwise uncaught exceptions thrown during an inferior call. */
90 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
91 code in the inferior to run when significant events occur in the
92 dynamic linker (for example a library is loaded or unloaded).
94 By placing a breakpoint in this magic code GDB will get control
95 when these significant events occur. GDB can then re-examine
96 the dynamic linker's data structures to discover any newly loaded
100 /* Some multi-threaded systems can arrange for a location in the
101 inferior to be executed when certain thread-related events occur
102 (such as thread creation or thread death).
104 By placing a breakpoint at one of these locations, GDB will get
105 control when these events occur. GDB can then update its thread
110 /* On the same principal, an overlay manager can arrange to call a
111 magic location in the inferior whenever there is an interesting
112 change in overlay status. GDB can update its overlay tables
113 and fiddle with breakpoints in overlays when this breakpoint
118 /* Master copies of longjmp breakpoints. These are always installed
119 as soon as an objfile containing longjmp is loaded, but they are
120 always disabled. While necessary, temporary clones of bp_longjmp
121 type will be created and enabled. */
125 /* Master copies of std::terminate breakpoints. */
126 bp_std_terminate_master
,
133 /* Event for JIT compiled code generation or deletion. */
137 /* States of enablement of breakpoint. */
141 bp_disabled
, /* The eventpoint is inactive, and cannot trigger. */
142 bp_enabled
, /* The eventpoint is active, and can trigger. */
143 bp_call_disabled
, /* The eventpoint has been disabled while a call
144 into the inferior is "in flight", because some
145 eventpoints interfere with the implementation of
146 a call on some targets. The eventpoint will be
147 automatically enabled and reset when the call
148 "lands" (either completes, or stops at another
150 bp_startup_disabled
,/* The eventpoint has been disabled during inferior
151 startup. This is necessary on some targets where
152 the main executable will get relocated during
153 startup, making breakpoint addresses invalid.
154 The eventpoint will be automatically enabled and
155 reset once inferior startup is complete. */
156 bp_permanent
/* There is a breakpoint instruction hard-wired into
157 the target's code. Don't try to write another
158 breakpoint instruction on top of it, or restore
159 its value. Step over it using the architecture's
164 /* Disposition of breakpoint. Ie: what to do after hitting it. */
168 disp_del
, /* Delete it */
169 disp_del_at_next_stop
, /* Delete at next stop, whether hit or not */
170 disp_disable
, /* Disable it */
171 disp_donttouch
/* Leave it alone */
174 enum target_hw_bp_type
176 hw_write
= 0, /* Common HW watchpoint */
177 hw_read
= 1, /* Read HW watchpoint */
178 hw_access
= 2, /* Access HW watchpoint */
179 hw_execute
= 3 /* Execute HW breakpoint */
183 /* Information used by targets to insert and remove breakpoints. */
185 struct bp_target_info
187 /* Address space at which the breakpoint was placed. */
188 struct address_space
*placed_address_space
;
190 /* Address at which the breakpoint was placed. This is normally the
191 same as ADDRESS from the bp_location, except when adjustment
192 happens in gdbarch_breakpoint_from_pc. The most common form of
193 adjustment is stripping an alternate ISA marker from the PC which
194 is used to determine the type of breakpoint to insert. */
195 CORE_ADDR placed_address
;
197 /* If the breakpoint lives in memory and reading that memory would
198 give back the breakpoint, instead of the original contents, then
199 the original contents are cached here. Only SHADOW_LEN bytes of
200 this buffer are valid, and only when the breakpoint is inserted. */
201 gdb_byte shadow_contents
[BREAKPOINT_MAX
];
203 /* The length of the data cached in SHADOW_CONTENTS. */
206 /* The size of the placed breakpoint, according to
207 gdbarch_breakpoint_from_pc, when the breakpoint was inserted. This is
208 generally the same as SHADOW_LEN, unless we did not need
209 to read from the target to implement the memory breakpoint
210 (e.g. if a remote stub handled the details). We may still
211 need the size to remove the breakpoint safely. */
215 /* GDB maintains two types of information about each breakpoint (or
216 watchpoint, or other related event). The first type corresponds
217 to struct breakpoint; this is a relatively high-level structure
218 which contains the source location(s), stopping conditions, user
219 commands to execute when the breakpoint is hit, and so forth.
221 The second type of information corresponds to struct bp_location.
222 Each breakpoint has one or (eventually) more locations associated
223 with it, which represent target-specific and machine-specific
224 mechanisms for stopping the program. For instance, a watchpoint
225 expression may require multiple hardware watchpoints in order to
226 catch all changes in the value of the expression being watched. */
230 bp_loc_software_breakpoint
,
231 bp_loc_hardware_breakpoint
,
232 bp_loc_hardware_watchpoint
,
233 bp_loc_other
/* Miscellaneous... */
238 /* Chain pointer to the next breakpoint location for
239 the same parent breakpoint. */
240 struct bp_location
*next
;
242 /* Type of this breakpoint location. */
243 enum bp_loc_type loc_type
;
245 /* Each breakpoint location must belong to exactly one higher-level
246 breakpoint. This and the DUPLICATE flag are more straightforward
247 than reference counting. */
248 struct breakpoint
*owner
;
250 /* Conditional. Break only if this expression's value is nonzero.
251 Unlike string form of condition, which is associated with
252 breakpoint, this is associated with location, since if breakpoint
253 has several locations, the evaluation of expression can be
254 different for different locations. Only valid for real
255 breakpoints; a watchpoint's conditional expression is stored in
256 the owner breakpoint object. */
257 struct expression
*cond
;
259 /* This location's address is in an unloaded solib, and so this
260 location should not be inserted. It will be automatically
261 enabled when that solib is loaded. */
264 /* Is this particular location enabled. */
267 /* Nonzero if this breakpoint is now inserted. */
270 /* Nonzero if this is not the first breakpoint in the list
271 for the given address. */
274 /* If we someday support real thread-specific breakpoints, then
275 the breakpoint location will need a thread identifier. */
277 /* Data for specific breakpoint types. These could be a union, but
278 simplicity is more important than memory usage for breakpoints. */
280 /* Architecture associated with this location's address. May be
281 different from the breakpoint architecture. */
282 struct gdbarch
*gdbarch
;
284 /* The program space associated with this breakpoint location
285 address. Note that an address space may be represented in more
286 than one program space (e.g. each uClinux program will be given
287 its own program space, but there will only be one address space
288 for all of them), but we must not insert more than one location
289 at the same address in the same address space. */
290 struct program_space
*pspace
;
292 /* Note that zero is a perfectly valid code address on some platforms
293 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
294 is not a special value for this field. Valid for all types except
298 /* For hardware watchpoints, the size of data ad ADDRESS being watches. */
301 /* Type of hardware watchpoint. */
302 enum target_hw_bp_type watchpoint_type
;
304 /* For any breakpoint type with an address, this is the section
305 associated with the address. Used primarily for overlay debugging. */
306 struct obj_section
*section
;
308 /* Address at which breakpoint was requested, either by the user or
309 by GDB for internal breakpoints. This will usually be the same
310 as ``address'' (above) except for cases in which
311 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
312 which to place the breakpoint in order to comply with a
313 processor's architectual constraints. */
314 CORE_ADDR requested_address
;
318 /* Details of the placed breakpoint, when inserted. */
319 struct bp_target_info target_info
;
321 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
322 struct bp_target_info overlay_target_info
;
324 /* In a non-stop mode, it's possible that we delete a breakpoint,
325 but as we do that, some still running thread hits that breakpoint.
326 For that reason, we need to keep locations belonging to deleted
327 breakpoints for a bit, so that don't report unexpected SIGTRAP.
328 We can't keep such locations forever, so we use a heuristic --
329 after we process certain number of inferior events since
330 breakpoint was deleted, we retire all locations of that breakpoint.
331 This variable keeps a number of events still to go, when
332 it becomes 0 this location is retired. */
333 int events_till_retirement
;
336 /* This structure is a collection of function pointers that, if available,
337 will be called instead of the performing the default action for this
340 struct breakpoint_ops
342 /* Insert the breakpoint or activate the catchpoint. Should raise
343 an exception if the operation failed. */
344 void (*insert
) (struct breakpoint
*);
346 /* Remove the breakpoint/catchpoint that was previously inserted
347 with the "insert" method above. Return non-zero if the operation
349 int (*remove
) (struct breakpoint
*);
351 /* Return non-zero if the debugger should tell the user that this
352 breakpoint was hit. */
353 int (*breakpoint_hit
) (struct breakpoint
*);
355 /* The normal print routine for this breakpoint, called when we
357 enum print_stop_action (*print_it
) (struct breakpoint
*);
359 /* Display information about this breakpoint, for "info breakpoints". */
360 void (*print_one
) (struct breakpoint
*, struct bp_location
**);
362 /* Display information about this breakpoint after setting it (roughly
363 speaking; this is called from "mention"). */
364 void (*print_mention
) (struct breakpoint
*);
367 enum watchpoint_triggered
369 /* This watchpoint definitely did not trigger. */
370 watch_triggered_no
= 0,
372 /* Some hardware watchpoint triggered, and it might have been this
373 one, but we do not know which it was. */
374 watch_triggered_unknown
,
376 /* This hardware watchpoint definitely did trigger. */
380 /* This is used to declare the VEC syscalls_to_be_caught. */
383 typedef struct bp_location
*bp_location_p
;
384 DEF_VEC_P(bp_location_p
);
386 /* A reference-counted struct command_line. This lets multiple
387 breakpoints share a single command list. */
388 struct counted_command_line
390 /* The reference count. */
393 /* The command list. */
394 struct command_line
*commands
;
397 /* Note that the ->silent field is not currently used by any commands
398 (though the code is in there if it was to be, and set_raw_breakpoint
399 does set it to 0). I implemented it because I thought it would be
400 useful for a hack I had to put in; I'm going to leave it in because
401 I can see how there might be times when it would indeed be useful */
403 /* This is for a breakpoint or a watchpoint. */
407 struct breakpoint
*next
;
408 /* Type of breakpoint. */
410 /* Zero means disabled; remember the info but don't break here. */
411 enum enable_state enable_state
;
412 /* What to do with this breakpoint after we hit it. */
413 enum bpdisp disposition
;
414 /* Number assigned to distinguish breakpoints. */
417 /* Location(s) associated with this high-level breakpoint. */
418 struct bp_location
*loc
;
420 /* Line number of this address. */
424 /* Source file name of this address. */
428 /* Non-zero means a silent breakpoint (don't print frame info
430 unsigned char silent
;
431 /* Number of stops at this breakpoint that should
432 be continued automatically before really stopping. */
434 /* Chain of command lines to execute when this breakpoint is hit. */
435 struct counted_command_line
*commands
;
436 /* Stack depth (address of frame). If nonzero, break only if fp
438 struct frame_id frame_id
;
440 /* The program space used to set the breakpoint. */
441 struct program_space
*pspace
;
443 /* String we used to set the breakpoint (malloc'd). */
445 /* Architecture we used to set the breakpoint. */
446 struct gdbarch
*gdbarch
;
447 /* Language we used to set the breakpoint. */
448 enum language language
;
449 /* Input radix we used to set the breakpoint. */
451 /* String form of the breakpoint condition (malloc'd), or NULL if there
454 /* String form of exp (malloc'd), or NULL if none. */
457 /* The expression we are watching, or NULL if not a watchpoint. */
458 struct expression
*exp
;
459 /* The largest block within which it is valid, or NULL if it is
460 valid anywhere (e.g. consists just of global symbols). */
461 struct block
*exp_valid_block
;
462 /* The conditional expression if any. NULL if not a watchpoint. */
463 struct expression
*cond_exp
;
464 /* The largest block within which it is valid, or NULL if it is
465 valid anywhere (e.g. consists just of global symbols). */
466 struct block
*cond_exp_valid_block
;
467 /* Value of the watchpoint the last time we checked it, or NULL
468 when we do not know the value yet or the value was not
469 readable. VAL is never lazy. */
471 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
472 then an error occurred reading the value. */
475 /* Holds the address of the related watchpoint_scope breakpoint
476 when using watchpoints on local variables (might the concept
477 of a related breakpoint be useful elsewhere, if not just call
478 it the watchpoint_scope breakpoint or something like that. FIXME). */
479 struct breakpoint
*related_breakpoint
;
481 /* Holds the frame address which identifies the frame this
482 watchpoint should be evaluated in, or `null' if the watchpoint
483 should be evaluated on the outermost frame. */
484 struct frame_id watchpoint_frame
;
486 /* Holds the thread which identifies the frame this watchpoint
487 should be considered in scope for, or `null_ptid' if the
488 watchpoint should be evaluated in all threads. */
489 ptid_t watchpoint_thread
;
491 /* For hardware watchpoints, the triggered status according to the
493 enum watchpoint_triggered watchpoint_triggered
;
495 /* Thread number for thread-specific breakpoint, or -1 if don't care. */
498 /* Ada task number for task-specific breakpoint, or 0 if don't care. */
501 /* Count of the number of times this breakpoint was taken, dumped
502 with the info, but not used for anything else. Useful for
503 seeing how many times you hit a break prior to the program
504 aborting, so you can back up to just before the abort. */
507 /* Process id of a child process whose forking triggered this
508 catchpoint. This field is only valid immediately after this
509 catchpoint has triggered. */
510 ptid_t forked_inferior_pid
;
512 /* Filename of a program whose exec triggered this catchpoint.
513 This field is only valid immediately after this catchpoint has
517 /* Syscall numbers used for the 'catch syscall' feature.
518 If no syscall has been specified for filtering, its value is NULL.
519 Otherwise, it holds a list of all syscalls to be caught.
520 The list elements are allocated with xmalloc. */
521 VEC(int) *syscalls_to_be_caught
;
523 /* Methods associated with this breakpoint. */
524 struct breakpoint_ops
*ops
;
526 /* Is breakpoint's condition not yet parsed because we found
527 no location initially so had no context to parse
529 int condition_not_parsed
;
531 /* Number of times this tracepoint should single-step
532 and collect additional data. */
535 /* Number of times this tracepoint should be hit before
539 /* The number of the tracepoint on the target. */
540 int number_on_target
;
543 typedef struct breakpoint
*breakpoint_p
;
544 DEF_VEC_P(breakpoint_p
);
546 /* The following stuff is an abstract data type "bpstat" ("breakpoint
547 status"). This provides the ability to determine whether we have
548 stopped at a breakpoint, and what we should do about it. */
550 typedef struct bpstats
*bpstat
;
552 /* Frees any storage that is part of a bpstat.
553 Does not walk the 'next' chain. */
554 extern void bpstat_free (bpstat
);
556 /* Clears a chain of bpstat, freeing storage
558 extern void bpstat_clear (bpstat
*);
560 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
561 is part of the bpstat is copied as well. */
562 extern bpstat
bpstat_copy (bpstat
);
564 extern bpstat
bpstat_stop_status (struct address_space
*aspace
,
565 CORE_ADDR pc
, ptid_t ptid
);
567 /* This bpstat_what stuff tells wait_for_inferior what to do with a
568 breakpoint (a challenging task). */
570 enum bpstat_what_main_action
572 /* Perform various other tests; that is, this bpstat does not
573 say to perform any action (e.g. failed watchpoint and nothing
575 BPSTAT_WHAT_KEEP_CHECKING
,
577 /* Rather than distinguish between noisy and silent stops here, it
578 might be cleaner to have bpstat_print make that decision (also
579 taking into account stop_print_frame and source_only). But the
580 implications are a bit scary (interaction with auto-displays, etc.),
581 so I won't try it. */
584 BPSTAT_WHAT_STOP_SILENT
,
586 /* Stop and print. */
587 BPSTAT_WHAT_STOP_NOISY
,
589 /* Remove breakpoints, single step once, then put them back in and
590 go back to what we were doing. It's possible that this should be
591 removed from the main_action and put into a separate field, to more
592 cleanly handle BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
595 /* Set longjmp_resume breakpoint, remove all other breakpoints,
596 and continue. The "remove all other breakpoints" part is required
597 if we are also stepping over another breakpoint as well as doing
598 the longjmp handling. */
599 BPSTAT_WHAT_SET_LONGJMP_RESUME
,
601 /* Clear longjmp_resume breakpoint, then handle as
602 BPSTAT_WHAT_KEEP_CHECKING. */
603 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME
,
605 /* Clear step resume breakpoint, and keep checking. */
606 BPSTAT_WHAT_STEP_RESUME
,
608 /* Check the dynamic linker's data structures for new libraries, then
610 BPSTAT_WHAT_CHECK_SHLIBS
,
612 /* Check for new JITed code. */
613 BPSTAT_WHAT_CHECK_JIT
,
615 /* This is just used to keep track of how many enums there are. */
619 /* An enum indicating the kind of "stack dummy" stop. This is a bit
620 of a misnomer because only one kind of truly a stack dummy. */
623 /* We didn't stop at a stack dummy breakpoint. */
626 /* Stopped at a stack dummy. */
629 /* Stopped at std::terminate. */
635 enum bpstat_what_main_action main_action
;
637 /* Did we hit a call dummy breakpoint? This only goes with a main_action
638 of BPSTAT_WHAT_STOP_SILENT or BPSTAT_WHAT_STOP_NOISY (the concept of
639 continuing from a call dummy without popping the frame is not a
641 enum stop_stack_kind call_dummy
;
644 /* The possible return values for print_bpstat, print_it_normal,
645 print_it_done, print_it_noop. */
646 enum print_stop_action
654 /* Tell what to do about this bpstat. */
655 struct bpstat_what
bpstat_what (bpstat
);
657 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
658 bpstat
bpstat_find_breakpoint (bpstat
, struct breakpoint
*);
660 /* Find a step_resume breakpoint associated with this bpstat.
661 (If there are multiple step_resume bp's on the list, this function
662 will arbitrarily pick one.)
664 It is an error to use this function if BPSTAT doesn't contain a
665 step_resume breakpoint.
667 See wait_for_inferior's use of this function.
669 extern struct breakpoint
*bpstat_find_step_resume_breakpoint (bpstat
);
671 /* Nonzero if a signal that we got in wait() was due to circumstances
672 explained by the BS. */
673 /* Currently that is true if we have hit a breakpoint, or if there is
674 a watchpoint enabled. */
675 #define bpstat_explains_signal(bs) ((bs) != NULL)
677 /* Nonzero is this bpstat causes a stop. */
678 extern int bpstat_causes_stop (bpstat
);
680 /* Nonzero if we should step constantly (e.g. watchpoints on machines
681 without hardware support). This isn't related to a specific bpstat,
682 just to things like whether watchpoints are set. */
683 extern int bpstat_should_step (void);
685 /* Print a message indicating what happened. Returns nonzero to
686 say that only the source line should be printed after this (zero
687 return means print the frame as well as the source line). */
688 extern enum print_stop_action
bpstat_print (bpstat
);
690 /* Put in *NUM the breakpoint number of the first breakpoint we are stopped
691 at. *BSP upon return is a bpstat which points to the remaining
692 breakpoints stopped at (but which is not guaranteed to be good for
693 anything but further calls to bpstat_num).
694 Return 0 if passed a bpstat which does not indicate any breakpoints.
695 Return -1 if stopped at a breakpoint that has been deleted since
697 Return 1 otherwise. */
698 extern int bpstat_num (bpstat
*, int *);
700 /* Perform actions associated with the stopped inferior. Actually, we
701 just use this for breakpoint commands. Perhaps other actions will
702 go here later, but this is executed at a late time (from the
704 extern void bpstat_do_actions (void);
706 /* Modify BS so that the actions will not be performed. */
707 extern void bpstat_clear_actions (bpstat
);
709 /* Implementation: */
711 /* Values used to tell the printing routine how to behave for this bpstat. */
714 /* This is used when we want to do a normal printing of the reason
715 for stopping. The output will depend on the type of eventpoint
716 we are dealing with. This is the default value, most commonly
719 /* This is used when nothing should be printed for this bpstat entry. */
721 /* This is used when everything which needs to be printed has
722 already been printed. But we still want to print the frame. */
728 /* Linked list because there can be two breakpoints at the same
729 place, and a bpstat reflects the fact that both have been hit. */
731 /* Breakpoint that we are at. */
732 const struct bp_location
*breakpoint_at
;
733 /* The associated command list. */
734 struct counted_command_line
*commands
;
735 /* Commands left to be done. This points somewhere in
737 struct command_line
*commands_left
;
738 /* Old value associated with a watchpoint. */
739 struct value
*old_val
;
741 /* Nonzero if this breakpoint tells us to print the frame. */
744 /* Nonzero if this breakpoint tells us to stop. */
747 /* Tell bpstat_print and print_bp_stop_message how to print stuff
748 associated with this element of the bpstat chain. */
749 enum bp_print_how print_it
;
760 /* The possible return values for breakpoint_here_p.
761 We guarantee that zero always means "no breakpoint here". */
764 no_breakpoint_here
= 0,
765 ordinary_breakpoint_here
,
766 permanent_breakpoint_here
770 /* Prototypes for breakpoint-related functions. */
772 extern enum breakpoint_here
breakpoint_here_p (struct address_space
*, CORE_ADDR
);
774 extern int moribund_breakpoint_here_p (struct address_space
*, CORE_ADDR
);
776 extern int breakpoint_inserted_here_p (struct address_space
*, CORE_ADDR
);
778 extern int regular_breakpoint_inserted_here_p (struct address_space
*, CORE_ADDR
);
780 extern int software_breakpoint_inserted_here_p (struct address_space
*, CORE_ADDR
);
782 /* Returns true if there's a hardware watchpoint or access watchpoint
783 inserted in the range defined by ADDR and LEN. */
784 extern int hardware_watchpoint_inserted_in_range (struct address_space
*,
788 extern int breakpoint_thread_match (struct address_space
*, CORE_ADDR
, ptid_t
);
790 extern void until_break_command (char *, int, int);
792 extern void breakpoint_re_set (void);
794 extern void breakpoint_re_set_thread (struct breakpoint
*);
796 extern struct breakpoint
*set_momentary_breakpoint
797 (struct gdbarch
*, struct symtab_and_line
, struct frame_id
, enum bptype
);
799 extern struct breakpoint
*set_momentary_breakpoint_at_pc
800 (struct gdbarch
*, CORE_ADDR pc
, enum bptype type
);
802 extern struct breakpoint
*clone_momentary_breakpoint (struct breakpoint
*bpkt
);
804 extern void set_ignore_count (int, int, int);
806 extern void set_default_breakpoint (int, struct program_space
*,
807 CORE_ADDR
, struct symtab
*, int);
809 extern void breakpoint_init_inferior (enum inf_context
);
811 extern struct cleanup
*make_cleanup_delete_breakpoint (struct breakpoint
*);
813 extern void delete_breakpoint (struct breakpoint
*);
815 extern void breakpoint_auto_delete (bpstat
);
817 extern void break_command (char *, int);
819 extern void hbreak_command_wrapper (char *, int);
820 extern void thbreak_command_wrapper (char *, int);
821 extern void rbreak_command_wrapper (char *, int);
822 extern void watch_command_wrapper (char *, int);
823 extern void awatch_command_wrapper (char *, int);
824 extern void rwatch_command_wrapper (char *, int);
825 extern void tbreak_command (char *, int);
827 extern int create_breakpoint (struct gdbarch
*gdbarch
, char *arg
,
828 char *cond_string
, int thread
,
829 int parse_condition_and_thread
,
830 int tempflag
, int hardwareflag
, int traceflag
,
832 enum auto_boolean pending_break_support
,
833 struct breakpoint_ops
*ops
,
837 extern void insert_breakpoints (void);
839 extern int remove_breakpoints (void);
841 extern int remove_breakpoints_pid (int pid
);
843 /* This function can be used to physically insert eventpoints from the
844 specified traced inferior process, without modifying the breakpoint
845 package's state. This can be useful for those targets which support
846 following the processes of a fork() or vfork() system call, when both
847 of the resulting two processes are to be followed. */
848 extern int reattach_breakpoints (int);
850 /* This function can be used to update the breakpoint package's state
851 after an exec() system call has been executed.
853 This function causes the following:
855 - All eventpoints are marked "not inserted".
856 - All eventpoints with a symbolic address are reset such that
857 the symbolic address must be reevaluated before the eventpoints
859 - The solib breakpoints are explicitly removed from the breakpoint
861 - A step-resume breakpoint, if any, is explicitly removed from the
863 - All eventpoints without a symbolic address are removed from the
865 extern void update_breakpoints_after_exec (void);
867 /* This function can be used to physically remove hardware breakpoints
868 and watchpoints from the specified traced inferior process, without
869 modifying the breakpoint package's state. This can be useful for
870 those targets which support following the processes of a fork() or
871 vfork() system call, when one of the resulting two processes is to
872 be detached and allowed to run free.
874 It is an error to use this function on the process whose id is
876 extern int detach_breakpoints (int);
878 /* This function is called when program space PSPACE is about to be
879 deleted. It takes care of updating breakpoints to not reference
880 this PSPACE anymore. */
881 extern void breakpoint_program_space_exit (struct program_space
*pspace
);
883 extern void set_longjmp_breakpoint (int thread
);
884 extern void delete_longjmp_breakpoint (int thread
);
886 extern void enable_overlay_breakpoints (void);
887 extern void disable_overlay_breakpoints (void);
889 extern void set_std_terminate_breakpoint (void);
890 extern void delete_std_terminate_breakpoint (void);
892 /* These functions respectively disable or reenable all currently
893 enabled watchpoints. When disabled, the watchpoints are marked
894 call_disabled. When reenabled, they are marked enabled.
896 The intended client of these functions is call_function_by_hand.
898 The inferior must be stopped, and all breakpoints removed, when
899 these functions are used.
901 The need for these functions is that on some targets (e.g., HP-UX),
902 gdb is unable to unwind through the dummy frame that is pushed as
903 part of the implementation of a call command. Watchpoints can
904 cause the inferior to stop in places where this frame is visible,
905 and that can cause execution control to become very confused.
907 Note that if a user sets breakpoints in an interactively called
908 function, the call_disabled watchpoints will have been reenabled
909 when the first such breakpoint is reached. However, on targets
910 that are unable to unwind through the call dummy frame, watches
911 of stack-based storage may then be deleted, because gdb will
912 believe that their watched storage is out of scope. (Sigh.) */
913 extern void disable_watchpoints_before_interactive_call_start (void);
915 extern void enable_watchpoints_after_interactive_call_stop (void);
917 /* These functions disable and re-enable all breakpoints during
918 inferior startup. They are intended to be called from solib
919 code where necessary. This is needed on platforms where the
920 main executable is relocated at some point during startup
921 processing, making breakpoint addresses invalid.
923 If additional breakpoints are created after the routine
924 disable_breakpoints_before_startup but before the routine
925 enable_breakpoints_after_startup was called, they will also
926 be marked as disabled. */
927 extern void disable_breakpoints_before_startup (void);
928 extern void enable_breakpoints_after_startup (void);
930 /* For script interpreters that need to define breakpoint commands
931 after they've already read the commands into a struct command_line. */
932 extern enum command_control_type commands_from_control_command
933 (char *arg
, struct command_line
*cmd
);
935 extern void clear_breakpoint_hit_counts (void);
937 extern int get_number (char **);
939 extern int get_number_or_range (char **);
941 extern struct breakpoint
*get_breakpoint (int num
);
943 /* The following are for displays, which aren't really breakpoints, but
944 here is as good a place as any for them. */
946 extern void disable_current_display (void);
948 extern void do_displays (void);
950 extern void disable_display (int);
952 extern void clear_displays (void);
954 extern void disable_breakpoint (struct breakpoint
*);
956 extern void enable_breakpoint (struct breakpoint
*);
958 extern void breakpoint_set_commands (struct breakpoint
*b
,
959 struct command_line
*commands
);
961 /* Clear the "inserted" flag in all breakpoints. */
962 extern void mark_breakpoints_out (void);
964 extern void make_breakpoint_permanent (struct breakpoint
*);
966 extern struct breakpoint
*create_jit_event_breakpoint (struct gdbarch
*,
969 extern struct breakpoint
*create_solib_event_breakpoint (struct gdbarch
*,
972 extern struct breakpoint
*create_thread_event_breakpoint (struct gdbarch
*,
975 extern void remove_solib_event_breakpoints (void);
977 extern void remove_thread_event_breakpoints (void);
979 extern void disable_breakpoints_in_shlibs (void);
981 /* This function returns TRUE if ep is a catchpoint. */
982 extern int ep_is_catchpoint (struct breakpoint
*);
984 /* Enable breakpoints and delete when hit. Called with ARG == NULL
985 deletes all breakpoints. */
986 extern void delete_command (char *arg
, int from_tty
);
988 /* Pull all H/W watchpoints from the target. Return non-zero if the
990 extern int remove_hw_watchpoints (void);
992 /* Manage a software single step breakpoint (or two). Insert may be called
993 twice before remove is called. */
994 extern void insert_single_step_breakpoint (struct gdbarch
*,
995 struct address_space
*, CORE_ADDR
);
996 extern void remove_single_step_breakpoints (void);
998 /* Manage manual breakpoints, separate from the normal chain of
999 breakpoints. These functions are used in murky target-specific
1000 ways. Please do not add more uses! */
1001 extern void *deprecated_insert_raw_breakpoint (struct gdbarch
*,
1002 struct address_space
*, CORE_ADDR
);
1003 extern int deprecated_remove_raw_breakpoint (struct gdbarch
*, void *);
1005 /* Check if any hardware watchpoints have triggered, according to the
1007 int watchpoints_triggered (struct target_waitstatus
*);
1009 /* Update BUF, which is LEN bytes read from the target address MEMADDR,
1010 by replacing any memory breakpoints with their shadowed contents. */
1011 void breakpoint_restore_shadows (gdb_byte
*buf
, ULONGEST memaddr
,
1014 extern int breakpoints_always_inserted_mode (void);
1016 /* Called each time new event from target is processed.
1017 Retires previously deleted breakpoint locations that
1018 in our opinion won't ever trigger. */
1019 extern void breakpoint_retire_moribund (void);
1021 /* Checks if we are catching syscalls or not.
1022 Returns 0 if not, greater than 0 if we are. */
1023 extern int catch_syscall_enabled (void);
1025 /* Checks if we are catching syscalls with the specific
1026 syscall_number. Used for "filtering" the catchpoints.
1027 Returns 0 if not, greater than 0 if we are. */
1028 extern int catching_syscall_number (int syscall_number
);
1030 /* Tell a breakpoint to be quiet. */
1031 extern void make_breakpoint_silent (struct breakpoint
*);
1033 /* Return a tracepoint with the given number if found. */
1034 extern struct breakpoint
*get_tracepoint (int num
);
1036 extern struct breakpoint
*get_tracepoint_by_number_on_target (int num
);
1038 /* Find a tracepoint by parsing a number in the supplied string. */
1039 extern struct breakpoint
*get_tracepoint_by_number (char **arg
, int multi_p
,
1042 /* Return a vector of all tracepoints currently defined. The vector
1043 is newly allocated; the caller should free when done with it. */
1044 extern VEC(breakpoint_p
) *all_tracepoints (void);
1046 extern int breakpoint_is_tracepoint (const struct breakpoint
*b
);
1048 /* Function that can be passed to read_command_line to validate
1049 that each command is suitable for tracepoint command list. */
1050 extern void check_tracepoint_command (char *line
, void *closure
);
1052 /* Call at the start and end of an "rbreak" command to register
1053 breakpoint numbers for a later "commands" command. */
1054 extern void start_rbreak_breakpoints (void);
1055 extern void end_rbreak_breakpoints (void);
1057 #endif /* !defined (BREAKPOINT_H) */