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 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
87 code in the inferior to run when significant events occur in the
88 dynamic linker (for example a library is loaded or unloaded).
90 By placing a breakpoint in this magic code GDB will get control
91 when these significant events occur. GDB can then re-examine
92 the dynamic linker's data structures to discover any newly loaded
96 /* Some multi-threaded systems can arrange for a location in the
97 inferior to be executed when certain thread-related events occur
98 (such as thread creation or thread death).
100 By placing a breakpoint at one of these locations, GDB will get
101 control when these events occur. GDB can then update its thread
106 /* On the same principal, an overlay manager can arrange to call a
107 magic location in the inferior whenever there is an interesting
108 change in overlay status. GDB can update its overlay tables
109 and fiddle with breakpoints in overlays when this breakpoint
114 /* Master copies of longjmp breakpoints. These are always installed
115 as soon as an objfile containing longjmp is loaded, but they are
116 always disabled. While necessary, temporary clones of bp_longjmp
117 type will be created and enabled. */
126 /* Event for JIT compiled code generation or deletion. */
130 /* States of enablement of breakpoint. */
134 bp_disabled
, /* The eventpoint is inactive, and cannot trigger. */
135 bp_enabled
, /* The eventpoint is active, and can trigger. */
136 bp_call_disabled
, /* The eventpoint has been disabled while a call
137 into the inferior is "in flight", because some
138 eventpoints interfere with the implementation of
139 a call on some targets. The eventpoint will be
140 automatically enabled and reset when the call
141 "lands" (either completes, or stops at another
143 bp_startup_disabled
,/* The eventpoint has been disabled during inferior
144 startup. This is necessary on some targets where
145 the main executable will get relocated during
146 startup, making breakpoint addresses invalid.
147 The eventpoint will be automatically enabled and
148 reset once inferior startup is complete. */
149 bp_permanent
/* There is a breakpoint instruction hard-wired into
150 the target's code. Don't try to write another
151 breakpoint instruction on top of it, or restore
152 its value. Step over it using the architecture's
157 /* Disposition of breakpoint. Ie: what to do after hitting it. */
161 disp_del
, /* Delete it */
162 disp_del_at_next_stop
, /* Delete at next stop, whether hit or not */
163 disp_disable
, /* Disable it */
164 disp_donttouch
/* Leave it alone */
167 enum target_hw_bp_type
169 hw_write
= 0, /* Common HW watchpoint */
170 hw_read
= 1, /* Read HW watchpoint */
171 hw_access
= 2, /* Access HW watchpoint */
172 hw_execute
= 3 /* Execute HW breakpoint */
176 /* Information used by targets to insert and remove breakpoints. */
178 struct bp_target_info
180 /* Address space at which the breakpoint was placed. */
181 struct address_space
*placed_address_space
;
183 /* Address at which the breakpoint was placed. This is normally the
184 same as ADDRESS from the bp_location, except when adjustment
185 happens in gdbarch_breakpoint_from_pc. The most common form of
186 adjustment is stripping an alternate ISA marker from the PC which
187 is used to determine the type of breakpoint to insert. */
188 CORE_ADDR placed_address
;
190 /* If the breakpoint lives in memory and reading that memory would
191 give back the breakpoint, instead of the original contents, then
192 the original contents are cached here. Only SHADOW_LEN bytes of
193 this buffer are valid, and only when the breakpoint is inserted. */
194 gdb_byte shadow_contents
[BREAKPOINT_MAX
];
196 /* The length of the data cached in SHADOW_CONTENTS. */
199 /* The size of the placed breakpoint, according to
200 gdbarch_breakpoint_from_pc, when the breakpoint was inserted. This is
201 generally the same as SHADOW_LEN, unless we did not need
202 to read from the target to implement the memory breakpoint
203 (e.g. if a remote stub handled the details). We may still
204 need the size to remove the breakpoint safely. */
208 /* GDB maintains two types of information about each breakpoint (or
209 watchpoint, or other related event). The first type corresponds
210 to struct breakpoint; this is a relatively high-level structure
211 which contains the source location(s), stopping conditions, user
212 commands to execute when the breakpoint is hit, and so forth.
214 The second type of information corresponds to struct bp_location.
215 Each breakpoint has one or (eventually) more locations associated
216 with it, which represent target-specific and machine-specific
217 mechanisms for stopping the program. For instance, a watchpoint
218 expression may require multiple hardware watchpoints in order to
219 catch all changes in the value of the expression being watched. */
223 bp_loc_software_breakpoint
,
224 bp_loc_hardware_breakpoint
,
225 bp_loc_hardware_watchpoint
,
226 bp_loc_other
/* Miscellaneous... */
231 /* Chain pointer to the next breakpoint location for
232 the same parent breakpoint. */
233 struct bp_location
*next
;
235 /* Type of this breakpoint location. */
236 enum bp_loc_type loc_type
;
238 /* Each breakpoint location must belong to exactly one higher-level
239 breakpoint. This and the DUPLICATE flag are more straightforward
240 than reference counting. */
241 struct breakpoint
*owner
;
243 /* Conditional. Break only if this expression's value is nonzero.
244 Unlike string form of condition, which is associated with
245 breakpoint, this is associated with location, since if breakpoint
246 has several locations, the evaluation of expression can be
247 different for different locations. Only valid for real
248 breakpoints; a watchpoint's conditional expression is stored in
249 the owner breakpoint object. */
250 struct expression
*cond
;
252 /* This location's address is in an unloaded solib, and so this
253 location should not be inserted. It will be automatically
254 enabled when that solib is loaded. */
257 /* Is this particular location enabled. */
260 /* Nonzero if this breakpoint is now inserted. */
263 /* Nonzero if this is not the first breakpoint in the list
264 for the given address. */
267 /* If we someday support real thread-specific breakpoints, then
268 the breakpoint location will need a thread identifier. */
270 /* Data for specific breakpoint types. These could be a union, but
271 simplicity is more important than memory usage for breakpoints. */
273 /* Architecture associated with this location's address. May be
274 different from the breakpoint architecture. */
275 struct gdbarch
*gdbarch
;
277 /* The program space associated with this breakpoint location
278 address. Note that an address space may be represented in more
279 than one program space (e.g. each uClinux program will be given
280 its own program space, but there will only be one address space
281 for all of them), but we must not insert more than one location
282 at the same address in the same address space. */
283 struct program_space
*pspace
;
285 /* Note that zero is a perfectly valid code address on some platforms
286 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
287 is not a special value for this field. Valid for all types except
291 /* For hardware watchpoints, the size of data ad ADDRESS being watches. */
294 /* Type of hardware watchpoint. */
295 enum target_hw_bp_type watchpoint_type
;
297 /* For any breakpoint type with an address, this is the section
298 associated with the address. Used primarily for overlay debugging. */
299 struct obj_section
*section
;
301 /* Address at which breakpoint was requested, either by the user or
302 by GDB for internal breakpoints. This will usually be the same
303 as ``address'' (above) except for cases in which
304 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
305 which to place the breakpoint in order to comply with a
306 processor's architectual constraints. */
307 CORE_ADDR requested_address
;
311 /* Details of the placed breakpoint, when inserted. */
312 struct bp_target_info target_info
;
314 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
315 struct bp_target_info overlay_target_info
;
317 /* In a non-stop mode, it's possible that we delete a breakpoint,
318 but as we do that, some still running thread hits that breakpoint.
319 For that reason, we need to keep locations belonging to deleted
320 breakpoints for a bit, so that don't report unexpected SIGTRAP.
321 We can't keep such locations forever, so we use a heuristic --
322 after we process certain number of inferior events since
323 breakpoint was deleted, we retire all locations of that breakpoint.
324 This variable keeps a number of events still to go, when
325 it becomes 0 this location is retired. */
326 int events_till_retirement
;
329 /* This structure is a collection of function pointers that, if available,
330 will be called instead of the performing the default action for this
333 struct breakpoint_ops
335 /* Insert the breakpoint or activate the catchpoint. Should raise
336 an exception if the operation failed. */
337 void (*insert
) (struct breakpoint
*);
339 /* Remove the breakpoint/catchpoint that was previously inserted
340 with the "insert" method above. Return non-zero if the operation
342 int (*remove
) (struct breakpoint
*);
344 /* Return non-zero if the debugger should tell the user that this
345 breakpoint was hit. */
346 int (*breakpoint_hit
) (struct breakpoint
*);
348 /* The normal print routine for this breakpoint, called when we
350 enum print_stop_action (*print_it
) (struct breakpoint
*);
352 /* Display information about this breakpoint, for "info breakpoints". */
353 void (*print_one
) (struct breakpoint
*, struct bp_location
**);
355 /* Display information about this breakpoint after setting it (roughly
356 speaking; this is called from "mention"). */
357 void (*print_mention
) (struct breakpoint
*);
360 enum watchpoint_triggered
362 /* This watchpoint definitely did not trigger. */
363 watch_triggered_no
= 0,
365 /* Some hardware watchpoint triggered, and it might have been this
366 one, but we do not know which it was. */
367 watch_triggered_unknown
,
369 /* This hardware watchpoint definitely did trigger. */
373 /* This is used to declare the VEC syscalls_to_be_caught. */
376 typedef struct bp_location
*bp_location_p
;
377 DEF_VEC_P(bp_location_p
);
379 /* A reference-counted struct command_line. This lets multiple
380 breakpoints share a single command list. */
381 struct counted_command_line
383 /* The reference count. */
386 /* The command list. */
387 struct command_line
*commands
;
390 /* Note that the ->silent field is not currently used by any commands
391 (though the code is in there if it was to be, and set_raw_breakpoint
392 does set it to 0). I implemented it because I thought it would be
393 useful for a hack I had to put in; I'm going to leave it in because
394 I can see how there might be times when it would indeed be useful */
396 /* This is for a breakpoint or a watchpoint. */
400 struct breakpoint
*next
;
401 /* Type of breakpoint. */
403 /* Zero means disabled; remember the info but don't break here. */
404 enum enable_state enable_state
;
405 /* What to do with this breakpoint after we hit it. */
406 enum bpdisp disposition
;
407 /* Number assigned to distinguish breakpoints. */
410 /* Location(s) associated with this high-level breakpoint. */
411 struct bp_location
*loc
;
413 /* Line number of this address. */
417 /* Source file name of this address. */
421 /* Non-zero means a silent breakpoint (don't print frame info
423 unsigned char silent
;
424 /* Number of stops at this breakpoint that should
425 be continued automatically before really stopping. */
427 /* Chain of command lines to execute when this breakpoint is hit. */
428 struct counted_command_line
*commands
;
429 /* Stack depth (address of frame). If nonzero, break only if fp
431 struct frame_id frame_id
;
433 /* The program space used to set the breakpoint. */
434 struct program_space
*pspace
;
436 /* String we used to set the breakpoint (malloc'd). */
438 /* Architecture we used to set the breakpoint. */
439 struct gdbarch
*gdbarch
;
440 /* Language we used to set the breakpoint. */
441 enum language language
;
442 /* Input radix we used to set the breakpoint. */
444 /* String form of the breakpoint condition (malloc'd), or NULL if there
447 /* String form of exp (malloc'd), or NULL if none. */
450 /* The expression we are watching, or NULL if not a watchpoint. */
451 struct expression
*exp
;
452 /* The largest block within which it is valid, or NULL if it is
453 valid anywhere (e.g. consists just of global symbols). */
454 struct block
*exp_valid_block
;
455 /* The conditional expression if any. NULL if not a watchpoint. */
456 struct expression
*cond_exp
;
457 /* The largest block within which it is valid, or NULL if it is
458 valid anywhere (e.g. consists just of global symbols). */
459 struct block
*cond_exp_valid_block
;
460 /* Value of the watchpoint the last time we checked it, or NULL
461 when we do not know the value yet or the value was not
462 readable. VAL is never lazy. */
464 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
465 then an error occurred reading the value. */
468 /* Holds the address of the related watchpoint_scope breakpoint
469 when using watchpoints on local variables (might the concept
470 of a related breakpoint be useful elsewhere, if not just call
471 it the watchpoint_scope breakpoint or something like that. FIXME). */
472 struct breakpoint
*related_breakpoint
;
474 /* Holds the frame address which identifies the frame this
475 watchpoint should be evaluated in, or `null' if the watchpoint
476 should be evaluated on the outermost frame. */
477 struct frame_id watchpoint_frame
;
479 /* Holds the thread which identifies the frame this watchpoint
480 should be considered in scope for, or `null_ptid' if the
481 watchpoint should be evaluated in all threads. */
482 ptid_t watchpoint_thread
;
484 /* For hardware watchpoints, the triggered status according to the
486 enum watchpoint_triggered watchpoint_triggered
;
488 /* Thread number for thread-specific breakpoint, or -1 if don't care. */
491 /* Ada task number for task-specific breakpoint, or 0 if don't care. */
494 /* Count of the number of times this breakpoint was taken, dumped
495 with the info, but not used for anything else. Useful for
496 seeing how many times you hit a break prior to the program
497 aborting, so you can back up to just before the abort. */
500 /* Process id of a child process whose forking triggered this
501 catchpoint. This field is only valid immediately after this
502 catchpoint has triggered. */
503 ptid_t forked_inferior_pid
;
505 /* Filename of a program whose exec triggered this catchpoint.
506 This field is only valid immediately after this catchpoint has
510 /* Syscall numbers used for the 'catch syscall' feature.
511 If no syscall has been specified for filtering, its value is NULL.
512 Otherwise, it holds a list of all syscalls to be caught.
513 The list elements are allocated with xmalloc. */
514 VEC(int) *syscalls_to_be_caught
;
516 /* Methods associated with this breakpoint. */
517 struct breakpoint_ops
*ops
;
519 /* Is breakpoint's condition not yet parsed because we found
520 no location initially so had no context to parse
522 int condition_not_parsed
;
524 /* Number of times this tracepoint should single-step
525 and collect additional data. */
528 /* Number of times this tracepoint should be hit before
532 /* The number of the tracepoint on the target. */
533 int number_on_target
;
536 typedef struct breakpoint
*breakpoint_p
;
537 DEF_VEC_P(breakpoint_p
);
539 /* The following stuff is an abstract data type "bpstat" ("breakpoint
540 status"). This provides the ability to determine whether we have
541 stopped at a breakpoint, and what we should do about it. */
543 typedef struct bpstats
*bpstat
;
545 /* Frees any storage that is part of a bpstat.
546 Does not walk the 'next' chain. */
547 extern void bpstat_free (bpstat
);
549 /* Clears a chain of bpstat, freeing storage
551 extern void bpstat_clear (bpstat
*);
553 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
554 is part of the bpstat is copied as well. */
555 extern bpstat
bpstat_copy (bpstat
);
557 extern bpstat
bpstat_stop_status (struct address_space
*aspace
,
558 CORE_ADDR pc
, ptid_t ptid
);
560 /* This bpstat_what stuff tells wait_for_inferior what to do with a
561 breakpoint (a challenging task). */
563 enum bpstat_what_main_action
565 /* Perform various other tests; that is, this bpstat does not
566 say to perform any action (e.g. failed watchpoint and nothing
568 BPSTAT_WHAT_KEEP_CHECKING
,
570 /* Rather than distinguish between noisy and silent stops here, it
571 might be cleaner to have bpstat_print make that decision (also
572 taking into account stop_print_frame and source_only). But the
573 implications are a bit scary (interaction with auto-displays, etc.),
574 so I won't try it. */
577 BPSTAT_WHAT_STOP_SILENT
,
579 /* Stop and print. */
580 BPSTAT_WHAT_STOP_NOISY
,
582 /* Remove breakpoints, single step once, then put them back in and
583 go back to what we were doing. It's possible that this should be
584 removed from the main_action and put into a separate field, to more
585 cleanly handle BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
588 /* Set longjmp_resume breakpoint, remove all other breakpoints,
589 and continue. The "remove all other breakpoints" part is required
590 if we are also stepping over another breakpoint as well as doing
591 the longjmp handling. */
592 BPSTAT_WHAT_SET_LONGJMP_RESUME
,
594 /* Clear longjmp_resume breakpoint, then handle as
595 BPSTAT_WHAT_KEEP_CHECKING. */
596 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME
,
598 /* Clear step resume breakpoint, and keep checking. */
599 BPSTAT_WHAT_STEP_RESUME
,
601 /* Check the dynamic linker's data structures for new libraries, then
603 BPSTAT_WHAT_CHECK_SHLIBS
,
605 /* Check for new JITed code. */
606 BPSTAT_WHAT_CHECK_JIT
,
608 /* This is just used to keep track of how many enums there are. */
614 enum bpstat_what_main_action main_action
;
616 /* Did we hit a call dummy breakpoint? This only goes with a main_action
617 of BPSTAT_WHAT_STOP_SILENT or BPSTAT_WHAT_STOP_NOISY (the concept of
618 continuing from a call dummy without popping the frame is not a
623 /* The possible return values for print_bpstat, print_it_normal,
624 print_it_done, print_it_noop. */
625 enum print_stop_action
633 /* Tell what to do about this bpstat. */
634 struct bpstat_what
bpstat_what (bpstat
);
636 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
637 bpstat
bpstat_find_breakpoint (bpstat
, struct breakpoint
*);
639 /* Find a step_resume breakpoint associated with this bpstat.
640 (If there are multiple step_resume bp's on the list, this function
641 will arbitrarily pick one.)
643 It is an error to use this function if BPSTAT doesn't contain a
644 step_resume breakpoint.
646 See wait_for_inferior's use of this function.
648 extern struct breakpoint
*bpstat_find_step_resume_breakpoint (bpstat
);
650 /* Nonzero if a signal that we got in wait() was due to circumstances
651 explained by the BS. */
652 /* Currently that is true if we have hit a breakpoint, or if there is
653 a watchpoint enabled. */
654 #define bpstat_explains_signal(bs) ((bs) != NULL)
656 /* Nonzero is this bpstat causes a stop. */
657 extern int bpstat_causes_stop (bpstat
);
659 /* Nonzero if we should step constantly (e.g. watchpoints on machines
660 without hardware support). This isn't related to a specific bpstat,
661 just to things like whether watchpoints are set. */
662 extern int bpstat_should_step (void);
664 /* Print a message indicating what happened. Returns nonzero to
665 say that only the source line should be printed after this (zero
666 return means print the frame as well as the source line). */
667 extern enum print_stop_action
bpstat_print (bpstat
);
669 /* Put in *NUM the breakpoint number of the first breakpoint we are stopped
670 at. *BSP upon return is a bpstat which points to the remaining
671 breakpoints stopped at (but which is not guaranteed to be good for
672 anything but further calls to bpstat_num).
673 Return 0 if passed a bpstat which does not indicate any breakpoints.
674 Return -1 if stopped at a breakpoint that has been deleted since
676 Return 1 otherwise. */
677 extern int bpstat_num (bpstat
*, int *);
679 /* Perform actions associated with the stopped inferior. Actually, we
680 just use this for breakpoint commands. Perhaps other actions will
681 go here later, but this is executed at a late time (from the
683 extern void bpstat_do_actions (void);
685 /* Modify BS so that the actions will not be performed. */
686 extern void bpstat_clear_actions (bpstat
);
688 /* Implementation: */
690 /* Values used to tell the printing routine how to behave for this bpstat. */
693 /* This is used when we want to do a normal printing of the reason
694 for stopping. The output will depend on the type of eventpoint
695 we are dealing with. This is the default value, most commonly
698 /* This is used when nothing should be printed for this bpstat entry. */
700 /* This is used when everything which needs to be printed has
701 already been printed. But we still want to print the frame. */
707 /* Linked list because there can be two breakpoints at the same
708 place, and a bpstat reflects the fact that both have been hit. */
710 /* Breakpoint that we are at. */
711 const struct bp_location
*breakpoint_at
;
712 /* The associated command list. */
713 struct counted_command_line
*commands
;
714 /* Commands left to be done. This points somewhere in
716 struct command_line
*commands_left
;
717 /* Old value associated with a watchpoint. */
718 struct value
*old_val
;
720 /* Nonzero if this breakpoint tells us to print the frame. */
723 /* Nonzero if this breakpoint tells us to stop. */
726 /* Tell bpstat_print and print_bp_stop_message how to print stuff
727 associated with this element of the bpstat chain. */
728 enum bp_print_how print_it
;
739 /* The possible return values for breakpoint_here_p.
740 We guarantee that zero always means "no breakpoint here". */
743 no_breakpoint_here
= 0,
744 ordinary_breakpoint_here
,
745 permanent_breakpoint_here
749 /* Prototypes for breakpoint-related functions. */
751 extern enum breakpoint_here
breakpoint_here_p (struct address_space
*, CORE_ADDR
);
753 extern int moribund_breakpoint_here_p (struct address_space
*, CORE_ADDR
);
755 extern int breakpoint_inserted_here_p (struct address_space
*, CORE_ADDR
);
757 extern int regular_breakpoint_inserted_here_p (struct address_space
*, CORE_ADDR
);
759 extern int software_breakpoint_inserted_here_p (struct address_space
*, CORE_ADDR
);
761 /* Returns true if there's a hardware watchpoint or access watchpoint
762 inserted in the range defined by ADDR and LEN. */
763 extern int hardware_watchpoint_inserted_in_range (struct address_space
*,
767 extern int breakpoint_thread_match (struct address_space
*, CORE_ADDR
, ptid_t
);
769 extern void until_break_command (char *, int, int);
771 extern void breakpoint_re_set (void);
773 extern void breakpoint_re_set_thread (struct breakpoint
*);
775 extern struct breakpoint
*set_momentary_breakpoint
776 (struct gdbarch
*, struct symtab_and_line
, struct frame_id
, enum bptype
);
778 extern struct breakpoint
*set_momentary_breakpoint_at_pc
779 (struct gdbarch
*, CORE_ADDR pc
, enum bptype type
);
781 extern struct breakpoint
*clone_momentary_breakpoint (struct breakpoint
*bpkt
);
783 extern void set_ignore_count (int, int, int);
785 extern void set_default_breakpoint (int, struct program_space
*,
786 CORE_ADDR
, struct symtab
*, int);
788 extern void breakpoint_init_inferior (enum inf_context
);
790 extern struct cleanup
*make_cleanup_delete_breakpoint (struct breakpoint
*);
792 extern void delete_breakpoint (struct breakpoint
*);
794 extern void breakpoint_auto_delete (bpstat
);
796 extern void break_command (char *, int);
798 extern void hbreak_command_wrapper (char *, int);
799 extern void thbreak_command_wrapper (char *, int);
800 extern void rbreak_command_wrapper (char *, int);
801 extern void watch_command_wrapper (char *, int);
802 extern void awatch_command_wrapper (char *, int);
803 extern void rwatch_command_wrapper (char *, int);
804 extern void tbreak_command (char *, int);
806 extern int create_breakpoint (struct gdbarch
*gdbarch
, char *arg
,
807 char *cond_string
, int thread
,
808 int parse_condition_and_thread
,
809 int tempflag
, int hardwareflag
, int traceflag
,
811 enum auto_boolean pending_break_support
,
812 struct breakpoint_ops
*ops
,
816 extern void insert_breakpoints (void);
818 extern int remove_breakpoints (void);
820 extern int remove_breakpoints_pid (int pid
);
822 /* This function can be used to physically insert eventpoints from the
823 specified traced inferior process, without modifying the breakpoint
824 package's state. This can be useful for those targets which support
825 following the processes of a fork() or vfork() system call, when both
826 of the resulting two processes are to be followed. */
827 extern int reattach_breakpoints (int);
829 /* This function can be used to update the breakpoint package's state
830 after an exec() system call has been executed.
832 This function causes the following:
834 - All eventpoints are marked "not inserted".
835 - All eventpoints with a symbolic address are reset such that
836 the symbolic address must be reevaluated before the eventpoints
838 - The solib breakpoints are explicitly removed from the breakpoint
840 - A step-resume breakpoint, if any, is explicitly removed from the
842 - All eventpoints without a symbolic address are removed from the
844 extern void update_breakpoints_after_exec (void);
846 /* This function can be used to physically remove hardware breakpoints
847 and watchpoints from the specified traced inferior process, without
848 modifying the breakpoint package's state. This can be useful for
849 those targets which support following the processes of a fork() or
850 vfork() system call, when one of the resulting two processes is to
851 be detached and allowed to run free.
853 It is an error to use this function on the process whose id is
855 extern int detach_breakpoints (int);
857 /* This function is called when program space PSPACE is about to be
858 deleted. It takes care of updating breakpoints to not reference
859 this PSPACE anymore. */
860 extern void breakpoint_program_space_exit (struct program_space
*pspace
);
862 extern void set_longjmp_breakpoint (int thread
);
863 extern void delete_longjmp_breakpoint (int thread
);
865 extern void enable_overlay_breakpoints (void);
866 extern void disable_overlay_breakpoints (void);
868 /* These functions respectively disable or reenable all currently
869 enabled watchpoints. When disabled, the watchpoints are marked
870 call_disabled. When reenabled, they are marked enabled.
872 The intended client of these functions is call_function_by_hand.
874 The inferior must be stopped, and all breakpoints removed, when
875 these functions are used.
877 The need for these functions is that on some targets (e.g., HP-UX),
878 gdb is unable to unwind through the dummy frame that is pushed as
879 part of the implementation of a call command. Watchpoints can
880 cause the inferior to stop in places where this frame is visible,
881 and that can cause execution control to become very confused.
883 Note that if a user sets breakpoints in an interactively called
884 function, the call_disabled watchpoints will have been reenabled
885 when the first such breakpoint is reached. However, on targets
886 that are unable to unwind through the call dummy frame, watches
887 of stack-based storage may then be deleted, because gdb will
888 believe that their watched storage is out of scope. (Sigh.) */
889 extern void disable_watchpoints_before_interactive_call_start (void);
891 extern void enable_watchpoints_after_interactive_call_stop (void);
893 /* These functions disable and re-enable all breakpoints during
894 inferior startup. They are intended to be called from solib
895 code where necessary. This is needed on platforms where the
896 main executable is relocated at some point during startup
897 processing, making breakpoint addresses invalid.
899 If additional breakpoints are created after the routine
900 disable_breakpoints_before_startup but before the routine
901 enable_breakpoints_after_startup was called, they will also
902 be marked as disabled. */
903 extern void disable_breakpoints_before_startup (void);
904 extern void enable_breakpoints_after_startup (void);
906 /* For script interpreters that need to define breakpoint commands
907 after they've already read the commands into a struct command_line. */
908 extern enum command_control_type commands_from_control_command
909 (char *arg
, struct command_line
*cmd
);
911 extern void clear_breakpoint_hit_counts (void);
913 extern int get_number (char **);
915 extern int get_number_or_range (char **);
917 extern struct breakpoint
*get_breakpoint (int num
);
919 /* The following are for displays, which aren't really breakpoints, but
920 here is as good a place as any for them. */
922 extern void disable_current_display (void);
924 extern void do_displays (void);
926 extern void disable_display (int);
928 extern void clear_displays (void);
930 extern void disable_breakpoint (struct breakpoint
*);
932 extern void enable_breakpoint (struct breakpoint
*);
934 extern void breakpoint_set_commands (struct breakpoint
*b
,
935 struct command_line
*commands
);
937 /* Clear the "inserted" flag in all breakpoints. */
938 extern void mark_breakpoints_out (void);
940 extern void make_breakpoint_permanent (struct breakpoint
*);
942 extern struct breakpoint
*create_jit_event_breakpoint (struct gdbarch
*,
945 extern struct breakpoint
*create_solib_event_breakpoint (struct gdbarch
*,
948 extern struct breakpoint
*create_thread_event_breakpoint (struct gdbarch
*,
951 extern void remove_solib_event_breakpoints (void);
953 extern void remove_thread_event_breakpoints (void);
955 extern void disable_breakpoints_in_shlibs (void);
957 /* This function returns TRUE if ep is a catchpoint. */
958 extern int ep_is_catchpoint (struct breakpoint
*);
960 /* Enable breakpoints and delete when hit. Called with ARG == NULL
961 deletes all breakpoints. */
962 extern void delete_command (char *arg
, int from_tty
);
964 /* Pull all H/W watchpoints from the target. Return non-zero if the
966 extern int remove_hw_watchpoints (void);
968 /* Manage a software single step breakpoint (or two). Insert may be called
969 twice before remove is called. */
970 extern void insert_single_step_breakpoint (struct gdbarch
*,
971 struct address_space
*, CORE_ADDR
);
972 extern void remove_single_step_breakpoints (void);
974 /* Manage manual breakpoints, separate from the normal chain of
975 breakpoints. These functions are used in murky target-specific
976 ways. Please do not add more uses! */
977 extern void *deprecated_insert_raw_breakpoint (struct gdbarch
*,
978 struct address_space
*, CORE_ADDR
);
979 extern int deprecated_remove_raw_breakpoint (struct gdbarch
*, void *);
981 /* Check if any hardware watchpoints have triggered, according to the
983 int watchpoints_triggered (struct target_waitstatus
*);
985 /* Update BUF, which is LEN bytes read from the target address MEMADDR,
986 by replacing any memory breakpoints with their shadowed contents. */
987 void breakpoint_restore_shadows (gdb_byte
*buf
, ULONGEST memaddr
,
990 extern int breakpoints_always_inserted_mode (void);
992 /* Called each time new event from target is processed.
993 Retires previously deleted breakpoint locations that
994 in our opinion won't ever trigger. */
995 extern void breakpoint_retire_moribund (void);
997 /* Checks if we are catching syscalls or not.
998 Returns 0 if not, greater than 0 if we are. */
999 extern int catch_syscall_enabled (void);
1001 /* Checks if we are catching syscalls with the specific
1002 syscall_number. Used for "filtering" the catchpoints.
1003 Returns 0 if not, greater than 0 if we are. */
1004 extern int catching_syscall_number (int syscall_number
);
1006 /* Tell a breakpoint to be quiet. */
1007 extern void make_breakpoint_silent (struct breakpoint
*);
1009 /* Return a tracepoint with the given number if found. */
1010 extern struct breakpoint
*get_tracepoint (int num
);
1012 extern struct breakpoint
*get_tracepoint_by_number_on_target (int num
);
1014 /* Find a tracepoint by parsing a number in the supplied string. */
1015 extern struct breakpoint
*get_tracepoint_by_number (char **arg
, int multi_p
,
1018 /* Return a vector of all tracepoints currently defined. The vector
1019 is newly allocated; the caller should free when done with it. */
1020 extern VEC(breakpoint_p
) *all_tracepoints (void);
1022 extern int breakpoint_is_tracepoint (const struct breakpoint
*b
);
1024 /* Function that can be passed to read_command_line to validate
1025 that each command is suitable for tracepoint command list. */
1026 extern void check_tracepoint_command (char *line
, void *closure
);
1028 #endif /* !defined (BREAKPOINT_H) */