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. This pointer is NULL iff this bp_location is in
248 (and therefore only in) moribund_locations. */
249 struct breakpoint
*owner
;
251 /* Conditional. Break only if this expression's value is nonzero.
252 Unlike string form of condition, which is associated with
253 breakpoint, this is associated with location, since if breakpoint
254 has several locations, the evaluation of expression can be
255 different for different locations. Only valid for real
256 breakpoints; a watchpoint's conditional expression is stored in
257 the owner breakpoint object. */
258 struct expression
*cond
;
260 /* This location's address is in an unloaded solib, and so this
261 location should not be inserted. It will be automatically
262 enabled when that solib is loaded. */
265 /* Is this particular location enabled. */
268 /* Nonzero if this breakpoint is now inserted. */
271 /* Nonzero if this is not the first breakpoint in the list
272 for the given address. */
275 /* If we someday support real thread-specific breakpoints, then
276 the breakpoint location will need a thread identifier. */
278 /* Data for specific breakpoint types. These could be a union, but
279 simplicity is more important than memory usage for breakpoints. */
281 /* Architecture associated with this location's address. May be
282 different from the breakpoint architecture. */
283 struct gdbarch
*gdbarch
;
285 /* The program space associated with this breakpoint location
286 address. Note that an address space may be represented in more
287 than one program space (e.g. each uClinux program will be given
288 its own program space, but there will only be one address space
289 for all of them), but we must not insert more than one location
290 at the same address in the same address space. */
291 struct program_space
*pspace
;
293 /* Note that zero is a perfectly valid code address on some platforms
294 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
295 is not a special value for this field. Valid for all types except
299 /* For hardware watchpoints, the size of data ad ADDRESS being watches. */
302 /* Type of hardware watchpoint. */
303 enum target_hw_bp_type watchpoint_type
;
305 /* For any breakpoint type with an address, this is the section
306 associated with the address. Used primarily for overlay debugging. */
307 struct obj_section
*section
;
309 /* Address at which breakpoint was requested, either by the user or
310 by GDB for internal breakpoints. This will usually be the same
311 as ``address'' (above) except for cases in which
312 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
313 which to place the breakpoint in order to comply with a
314 processor's architectual constraints. */
315 CORE_ADDR requested_address
;
319 /* Details of the placed breakpoint, when inserted. */
320 struct bp_target_info target_info
;
322 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
323 struct bp_target_info overlay_target_info
;
325 /* In a non-stop mode, it's possible that we delete a breakpoint,
326 but as we do that, some still running thread hits that breakpoint.
327 For that reason, we need to keep locations belonging to deleted
328 breakpoints for a bit, so that don't report unexpected SIGTRAP.
329 We can't keep such locations forever, so we use a heuristic --
330 after we process certain number of inferior events since
331 breakpoint was deleted, we retire all locations of that breakpoint.
332 This variable keeps a number of events still to go, when
333 it becomes 0 this location is retired. */
334 int events_till_retirement
;
337 /* This structure is a collection of function pointers that, if available,
338 will be called instead of the performing the default action for this
341 struct breakpoint_ops
343 /* Insert the breakpoint or activate the catchpoint. Should raise
344 an exception if the operation failed. */
345 void (*insert
) (struct breakpoint
*);
347 /* Remove the breakpoint/catchpoint that was previously inserted
348 with the "insert" method above. Return non-zero if the operation
350 int (*remove
) (struct breakpoint
*);
352 /* Return non-zero if the debugger should tell the user that this
353 breakpoint was hit. */
354 int (*breakpoint_hit
) (struct breakpoint
*);
356 /* The normal print routine for this breakpoint, called when we
358 enum print_stop_action (*print_it
) (struct breakpoint
*);
360 /* Display information about this breakpoint, for "info breakpoints". */
361 void (*print_one
) (struct breakpoint
*, struct bp_location
**);
363 /* Display information about this breakpoint after setting it (roughly
364 speaking; this is called from "mention"). */
365 void (*print_mention
) (struct breakpoint
*);
367 /* Print to FP the CLI command that recreates this breakpoint. */
368 void (*print_recreate
) (struct breakpoint
*, struct ui_file
*fp
);
371 enum watchpoint_triggered
373 /* This watchpoint definitely did not trigger. */
374 watch_triggered_no
= 0,
376 /* Some hardware watchpoint triggered, and it might have been this
377 one, but we do not know which it was. */
378 watch_triggered_unknown
,
380 /* This hardware watchpoint definitely did trigger. */
384 /* This is used to declare the VEC syscalls_to_be_caught. */
387 typedef struct bp_location
*bp_location_p
;
388 DEF_VEC_P(bp_location_p
);
390 /* A reference-counted struct command_line. This lets multiple
391 breakpoints share a single command list. This is an implementation
392 detail to the breakpoints module. */
393 struct counted_command_line
;
395 /* Note that the ->silent field is not currently used by any commands
396 (though the code is in there if it was to be, and set_raw_breakpoint
397 does set it to 0). I implemented it because I thought it would be
398 useful for a hack I had to put in; I'm going to leave it in because
399 I can see how there might be times when it would indeed be useful */
401 /* This is for a breakpoint or a watchpoint. */
405 struct breakpoint
*next
;
406 /* Type of breakpoint. */
408 /* Zero means disabled; remember the info but don't break here. */
409 enum enable_state enable_state
;
410 /* What to do with this breakpoint after we hit it. */
411 enum bpdisp disposition
;
412 /* Number assigned to distinguish breakpoints. */
415 /* Location(s) associated with this high-level breakpoint. */
416 struct bp_location
*loc
;
418 /* Line number of this address. */
422 /* Source file name of this address. */
426 /* Non-zero means a silent breakpoint (don't print frame info
428 unsigned char silent
;
429 /* Number of stops at this breakpoint that should
430 be continued automatically before really stopping. */
432 /* Chain of command lines to execute when this breakpoint is hit. */
433 struct counted_command_line
*commands
;
434 /* Stack depth (address of frame). If nonzero, break only if fp
436 struct frame_id frame_id
;
438 /* The program space used to set the breakpoint. */
439 struct program_space
*pspace
;
441 /* String we used to set the breakpoint (malloc'd). */
443 /* Architecture we used to set the breakpoint. */
444 struct gdbarch
*gdbarch
;
445 /* Language we used to set the breakpoint. */
446 enum language language
;
447 /* Input radix we used to set the breakpoint. */
449 /* String form of the breakpoint condition (malloc'd), or NULL if there
452 /* String form of exp (malloc'd), or NULL if none. */
455 /* The expression we are watching, or NULL if not a watchpoint. */
456 struct expression
*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
*exp_valid_block
;
460 /* The conditional expression if any. NULL if not a watchpoint. */
461 struct expression
*cond_exp
;
462 /* The largest block within which it is valid, or NULL if it is
463 valid anywhere (e.g. consists just of global symbols). */
464 struct block
*cond_exp_valid_block
;
465 /* Value of the watchpoint the last time we checked it, or NULL
466 when we do not know the value yet or the value was not
467 readable. VAL is never lazy. */
469 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
470 then an error occurred reading the value. */
473 /* Holds the address of the related watchpoint_scope breakpoint
474 when using watchpoints on local variables (might the concept
475 of a related breakpoint be useful elsewhere, if not just call
476 it the watchpoint_scope breakpoint or something like that. FIXME). */
477 struct breakpoint
*related_breakpoint
;
479 /* Holds the frame address which identifies the frame this
480 watchpoint should be evaluated in, or `null' if the watchpoint
481 should be evaluated on the outermost frame. */
482 struct frame_id watchpoint_frame
;
484 /* Holds the thread which identifies the frame this watchpoint
485 should be considered in scope for, or `null_ptid' if the
486 watchpoint should be evaluated in all threads. */
487 ptid_t watchpoint_thread
;
489 /* For hardware watchpoints, the triggered status according to the
491 enum watchpoint_triggered watchpoint_triggered
;
493 /* Thread number for thread-specific breakpoint, or -1 if don't care. */
496 /* Ada task number for task-specific breakpoint, or 0 if don't care. */
499 /* Count of the number of times this breakpoint was taken, dumped
500 with the info, but not used for anything else. Useful for
501 seeing how many times you hit a break prior to the program
502 aborting, so you can back up to just before the abort. */
505 /* Process id of a child process whose forking triggered this
506 catchpoint. This field is only valid immediately after this
507 catchpoint has triggered. */
508 ptid_t forked_inferior_pid
;
510 /* Filename of a program whose exec triggered this catchpoint.
511 This field is only valid immediately after this catchpoint has
515 /* Syscall numbers used for the 'catch syscall' feature.
516 If no syscall has been specified for filtering, its value is NULL.
517 Otherwise, it holds a list of all syscalls to be caught.
518 The list elements are allocated with xmalloc. */
519 VEC(int) *syscalls_to_be_caught
;
521 /* Methods associated with this breakpoint. */
522 struct breakpoint_ops
*ops
;
524 /* Is breakpoint's condition not yet parsed because we found
525 no location initially so had no context to parse
527 int condition_not_parsed
;
529 /* Number of times this tracepoint should single-step
530 and collect additional data. */
533 /* Number of times this tracepoint should be hit before
537 /* The number of the tracepoint on the target. */
538 int number_on_target
;
541 typedef struct breakpoint
*breakpoint_p
;
542 DEF_VEC_P(breakpoint_p
);
544 /* The following stuff is an abstract data type "bpstat" ("breakpoint
545 status"). This provides the ability to determine whether we have
546 stopped at a breakpoint, and what we should do about it. */
548 typedef struct bpstats
*bpstat
;
550 /* Frees any storage that is part of a bpstat.
551 Does not walk the 'next' chain. */
552 extern void bpstat_free (bpstat
);
554 /* Clears a chain of bpstat, freeing storage
556 extern void bpstat_clear (bpstat
*);
558 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
559 is part of the bpstat is copied as well. */
560 extern bpstat
bpstat_copy (bpstat
);
562 extern bpstat
bpstat_stop_status (struct address_space
*aspace
,
563 CORE_ADDR pc
, ptid_t ptid
);
565 /* This bpstat_what stuff tells wait_for_inferior what to do with a
566 breakpoint (a challenging task). */
568 enum bpstat_what_main_action
570 /* Perform various other tests; that is, this bpstat does not
571 say to perform any action (e.g. failed watchpoint and nothing
573 BPSTAT_WHAT_KEEP_CHECKING
,
575 /* Rather than distinguish between noisy and silent stops here, it
576 might be cleaner to have bpstat_print make that decision (also
577 taking into account stop_print_frame and source_only). But the
578 implications are a bit scary (interaction with auto-displays, etc.),
579 so I won't try it. */
582 BPSTAT_WHAT_STOP_SILENT
,
584 /* Stop and print. */
585 BPSTAT_WHAT_STOP_NOISY
,
587 /* Remove breakpoints, single step once, then put them back in and
588 go back to what we were doing. It's possible that this should be
589 removed from the main_action and put into a separate field, to more
590 cleanly handle BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
593 /* Set longjmp_resume breakpoint, remove all other breakpoints,
594 and continue. The "remove all other breakpoints" part is required
595 if we are also stepping over another breakpoint as well as doing
596 the longjmp handling. */
597 BPSTAT_WHAT_SET_LONGJMP_RESUME
,
599 /* Clear longjmp_resume breakpoint, then handle as
600 BPSTAT_WHAT_KEEP_CHECKING. */
601 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME
,
603 /* Clear step resume breakpoint, and keep checking. */
604 BPSTAT_WHAT_STEP_RESUME
,
606 /* Check the dynamic linker's data structures for new libraries, then
608 BPSTAT_WHAT_CHECK_SHLIBS
,
610 /* Check for new JITed code. */
611 BPSTAT_WHAT_CHECK_JIT
,
613 /* This is just used to keep track of how many enums there are. */
617 /* An enum indicating the kind of "stack dummy" stop. This is a bit
618 of a misnomer because only one kind of truly a stack dummy. */
621 /* We didn't stop at a stack dummy breakpoint. */
624 /* Stopped at a stack dummy. */
627 /* Stopped at std::terminate. */
633 enum bpstat_what_main_action main_action
;
635 /* Did we hit a call dummy breakpoint? This only goes with a main_action
636 of BPSTAT_WHAT_STOP_SILENT or BPSTAT_WHAT_STOP_NOISY (the concept of
637 continuing from a call dummy without popping the frame is not a
639 enum stop_stack_kind call_dummy
;
642 /* The possible return values for print_bpstat, print_it_normal,
643 print_it_done, print_it_noop. */
644 enum print_stop_action
652 /* Tell what to do about this bpstat. */
653 struct bpstat_what
bpstat_what (bpstat
);
655 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
656 bpstat
bpstat_find_breakpoint (bpstat
, struct breakpoint
*);
658 /* Nonzero if a signal that we got in wait() was due to circumstances
659 explained by the BS. */
660 /* Currently that is true if we have hit a breakpoint, or if there is
661 a watchpoint enabled. */
662 #define bpstat_explains_signal(bs) ((bs) != NULL)
664 /* Nonzero is this bpstat causes a stop. */
665 extern int bpstat_causes_stop (bpstat
);
667 /* Nonzero if we should step constantly (e.g. watchpoints on machines
668 without hardware support). This isn't related to a specific bpstat,
669 just to things like whether watchpoints are set. */
670 extern int bpstat_should_step (void);
672 /* Print a message indicating what happened. Returns nonzero to
673 say that only the source line should be printed after this (zero
674 return means print the frame as well as the source line). */
675 extern enum print_stop_action
bpstat_print (bpstat
);
677 /* Put in *NUM the breakpoint number of the first breakpoint we are stopped
678 at. *BSP upon return is a bpstat which points to the remaining
679 breakpoints stopped at (but which is not guaranteed to be good for
680 anything but further calls to bpstat_num).
681 Return 0 if passed a bpstat which does not indicate any breakpoints.
682 Return -1 if stopped at a breakpoint that has been deleted since
684 Return 1 otherwise. */
685 extern int bpstat_num (bpstat
*, int *);
687 /* Perform actions associated with the stopped inferior. Actually, we
688 just use this for breakpoint commands. Perhaps other actions will
689 go here later, but this is executed at a late time (from the
691 extern void bpstat_do_actions (void);
693 /* Modify BS so that the actions will not be performed. */
694 extern void bpstat_clear_actions (bpstat
);
696 /* Implementation: */
698 /* Values used to tell the printing routine how to behave for this bpstat. */
701 /* This is used when we want to do a normal printing of the reason
702 for stopping. The output will depend on the type of eventpoint
703 we are dealing with. This is the default value, most commonly
706 /* This is used when nothing should be printed for this bpstat entry. */
708 /* This is used when everything which needs to be printed has
709 already been printed. But we still want to print the frame. */
715 /* Linked list because there can be two breakpoints at the same
716 place, and a bpstat reflects the fact that both have been hit. */
718 /* Breakpoint that we are at. */
719 const struct bp_location
*breakpoint_at
;
720 /* The associated command list. */
721 struct counted_command_line
*commands
;
722 /* Commands left to be done. This points somewhere in
724 struct command_line
*commands_left
;
725 /* Old value associated with a watchpoint. */
726 struct value
*old_val
;
728 /* Nonzero if this breakpoint tells us to print the frame. */
731 /* Nonzero if this breakpoint tells us to stop. */
734 /* Tell bpstat_print and print_bp_stop_message how to print stuff
735 associated with this element of the bpstat chain. */
736 enum bp_print_how print_it
;
747 /* The possible return values for breakpoint_here_p.
748 We guarantee that zero always means "no breakpoint here". */
751 no_breakpoint_here
= 0,
752 ordinary_breakpoint_here
,
753 permanent_breakpoint_here
757 /* Prototypes for breakpoint-related functions. */
759 extern enum breakpoint_here
breakpoint_here_p (struct address_space
*, CORE_ADDR
);
761 extern int moribund_breakpoint_here_p (struct address_space
*, CORE_ADDR
);
763 extern int breakpoint_inserted_here_p (struct address_space
*, CORE_ADDR
);
765 extern int regular_breakpoint_inserted_here_p (struct address_space
*, CORE_ADDR
);
767 extern int software_breakpoint_inserted_here_p (struct address_space
*, CORE_ADDR
);
769 /* Returns true if there's a hardware watchpoint or access watchpoint
770 inserted in the range defined by ADDR and LEN. */
771 extern int hardware_watchpoint_inserted_in_range (struct address_space
*,
775 extern int breakpoint_thread_match (struct address_space
*, CORE_ADDR
, ptid_t
);
777 extern void until_break_command (char *, int, int);
779 extern void breakpoint_re_set (void);
781 extern void breakpoint_re_set_thread (struct breakpoint
*);
783 extern struct breakpoint
*set_momentary_breakpoint
784 (struct gdbarch
*, struct symtab_and_line
, struct frame_id
, enum bptype
);
786 extern struct breakpoint
*set_momentary_breakpoint_at_pc
787 (struct gdbarch
*, CORE_ADDR pc
, enum bptype type
);
789 extern struct breakpoint
*clone_momentary_breakpoint (struct breakpoint
*bpkt
);
791 extern void set_ignore_count (int, int, int);
793 extern void set_default_breakpoint (int, struct program_space
*,
794 CORE_ADDR
, struct symtab
*, int);
796 extern void breakpoint_init_inferior (enum inf_context
);
798 extern struct cleanup
*make_cleanup_delete_breakpoint (struct breakpoint
*);
800 extern void delete_breakpoint (struct breakpoint
*);
802 extern void breakpoint_auto_delete (bpstat
);
804 /* Return the chain of command lines to execute when this breakpoint
806 extern struct command_line
*breakpoint_commands (struct breakpoint
*b
);
808 extern void break_command (char *, int);
810 extern void hbreak_command_wrapper (char *, int);
811 extern void thbreak_command_wrapper (char *, int);
812 extern void rbreak_command_wrapper (char *, int);
813 extern void watch_command_wrapper (char *, int);
814 extern void awatch_command_wrapper (char *, int);
815 extern void rwatch_command_wrapper (char *, int);
816 extern void tbreak_command (char *, int);
818 extern int create_breakpoint (struct gdbarch
*gdbarch
, char *arg
,
819 char *cond_string
, int thread
,
820 int parse_condition_and_thread
,
821 int tempflag
, int hardwareflag
, int traceflag
,
823 enum auto_boolean pending_break_support
,
824 struct breakpoint_ops
*ops
,
828 extern void insert_breakpoints (void);
830 extern int remove_breakpoints (void);
832 extern int remove_breakpoints_pid (int pid
);
834 /* This function can be used to physically insert eventpoints from the
835 specified traced inferior process, without modifying the breakpoint
836 package's state. This can be useful for those targets which support
837 following the processes of a fork() or vfork() system call, when both
838 of the resulting two processes are to be followed. */
839 extern int reattach_breakpoints (int);
841 /* This function can be used to update the breakpoint package's state
842 after an exec() system call has been executed.
844 This function causes the following:
846 - All eventpoints are marked "not inserted".
847 - All eventpoints with a symbolic address are reset such that
848 the symbolic address must be reevaluated before the eventpoints
850 - The solib breakpoints are explicitly removed from the breakpoint
852 - A step-resume breakpoint, if any, is explicitly removed from the
854 - All eventpoints without a symbolic address are removed from the
856 extern void update_breakpoints_after_exec (void);
858 /* This function can be used to physically remove hardware breakpoints
859 and watchpoints from the specified traced inferior process, without
860 modifying the breakpoint package's state. This can be useful for
861 those targets which support following the processes of a fork() or
862 vfork() system call, when one of the resulting two processes is to
863 be detached and allowed to run free.
865 It is an error to use this function on the process whose id is
867 extern int detach_breakpoints (int);
869 /* This function is called when program space PSPACE is about to be
870 deleted. It takes care of updating breakpoints to not reference
871 this PSPACE anymore. */
872 extern void breakpoint_program_space_exit (struct program_space
*pspace
);
874 extern void set_longjmp_breakpoint (int thread
);
875 extern void delete_longjmp_breakpoint (int thread
);
877 extern void enable_overlay_breakpoints (void);
878 extern void disable_overlay_breakpoints (void);
880 extern void set_std_terminate_breakpoint (void);
881 extern void delete_std_terminate_breakpoint (void);
883 /* These functions respectively disable or reenable all currently
884 enabled watchpoints. When disabled, the watchpoints are marked
885 call_disabled. When reenabled, they are marked enabled.
887 The intended client of these functions is call_function_by_hand.
889 The inferior must be stopped, and all breakpoints removed, when
890 these functions are used.
892 The need for these functions is that on some targets (e.g., HP-UX),
893 gdb is unable to unwind through the dummy frame that is pushed as
894 part of the implementation of a call command. Watchpoints can
895 cause the inferior to stop in places where this frame is visible,
896 and that can cause execution control to become very confused.
898 Note that if a user sets breakpoints in an interactively called
899 function, the call_disabled watchpoints will have been reenabled
900 when the first such breakpoint is reached. However, on targets
901 that are unable to unwind through the call dummy frame, watches
902 of stack-based storage may then be deleted, because gdb will
903 believe that their watched storage is out of scope. (Sigh.) */
904 extern void disable_watchpoints_before_interactive_call_start (void);
906 extern void enable_watchpoints_after_interactive_call_stop (void);
908 /* These functions disable and re-enable all breakpoints during
909 inferior startup. They are intended to be called from solib
910 code where necessary. This is needed on platforms where the
911 main executable is relocated at some point during startup
912 processing, making breakpoint addresses invalid.
914 If additional breakpoints are created after the routine
915 disable_breakpoints_before_startup but before the routine
916 enable_breakpoints_after_startup was called, they will also
917 be marked as disabled. */
918 extern void disable_breakpoints_before_startup (void);
919 extern void enable_breakpoints_after_startup (void);
921 /* For script interpreters that need to define breakpoint commands
922 after they've already read the commands into a struct command_line. */
923 extern enum command_control_type commands_from_control_command
924 (char *arg
, struct command_line
*cmd
);
926 extern void clear_breakpoint_hit_counts (void);
928 extern int get_number (char **);
930 extern int get_number_or_range (char **);
932 extern struct breakpoint
*get_breakpoint (int num
);
934 /* The following are for displays, which aren't really breakpoints, but
935 here is as good a place as any for them. */
937 extern void disable_current_display (void);
939 extern void do_displays (void);
941 extern void disable_display (int);
943 extern void clear_displays (void);
945 extern void disable_breakpoint (struct breakpoint
*);
947 extern void enable_breakpoint (struct breakpoint
*);
949 extern void breakpoint_set_commands (struct breakpoint
*b
,
950 struct command_line
*commands
);
952 /* Clear the "inserted" flag in all breakpoints. */
953 extern void mark_breakpoints_out (void);
955 extern void make_breakpoint_permanent (struct breakpoint
*);
957 extern struct breakpoint
*create_jit_event_breakpoint (struct gdbarch
*,
960 extern struct breakpoint
*create_solib_event_breakpoint (struct gdbarch
*,
963 extern struct breakpoint
*create_thread_event_breakpoint (struct gdbarch
*,
966 extern void remove_solib_event_breakpoints (void);
968 extern void remove_thread_event_breakpoints (void);
970 extern void disable_breakpoints_in_shlibs (void);
972 /* This function returns TRUE if ep is a catchpoint. */
973 extern int ep_is_catchpoint (struct breakpoint
*);
975 /* Enable breakpoints and delete when hit. Called with ARG == NULL
976 deletes all breakpoints. */
977 extern void delete_command (char *arg
, int from_tty
);
979 /* Pull all H/W watchpoints from the target. Return non-zero if the
981 extern int remove_hw_watchpoints (void);
983 /* Manage a software single step breakpoint (or two). Insert may be called
984 twice before remove is called. */
985 extern void insert_single_step_breakpoint (struct gdbarch
*,
986 struct address_space
*, CORE_ADDR
);
987 extern void remove_single_step_breakpoints (void);
989 /* Manage manual breakpoints, separate from the normal chain of
990 breakpoints. These functions are used in murky target-specific
991 ways. Please do not add more uses! */
992 extern void *deprecated_insert_raw_breakpoint (struct gdbarch
*,
993 struct address_space
*, CORE_ADDR
);
994 extern int deprecated_remove_raw_breakpoint (struct gdbarch
*, void *);
996 /* Check if any hardware watchpoints have triggered, according to the
998 int watchpoints_triggered (struct target_waitstatus
*);
1000 /* Update BUF, which is LEN bytes read from the target address MEMADDR,
1001 by replacing any memory breakpoints with their shadowed contents. */
1002 void breakpoint_restore_shadows (gdb_byte
*buf
, ULONGEST memaddr
,
1005 extern int breakpoints_always_inserted_mode (void);
1007 /* Called each time new event from target is processed.
1008 Retires previously deleted breakpoint locations that
1009 in our opinion won't ever trigger. */
1010 extern void breakpoint_retire_moribund (void);
1012 /* Set break condition of breakpoint B to EXP. */
1013 extern void set_breakpoint_condition (struct breakpoint
*b
, char *exp
,
1016 /* Checks if we are catching syscalls or not.
1017 Returns 0 if not, greater than 0 if we are. */
1018 extern int catch_syscall_enabled (void);
1020 /* Checks if we are catching syscalls with the specific
1021 syscall_number. Used for "filtering" the catchpoints.
1022 Returns 0 if not, greater than 0 if we are. */
1023 extern int catching_syscall_number (int syscall_number
);
1025 /* Tell a breakpoint to be quiet. */
1026 extern void make_breakpoint_silent (struct breakpoint
*);
1028 /* Return a tracepoint with the given number if found. */
1029 extern struct breakpoint
*get_tracepoint (int num
);
1031 extern struct breakpoint
*get_tracepoint_by_number_on_target (int num
);
1033 /* Find a tracepoint by parsing a number in the supplied string. */
1034 extern struct breakpoint
*get_tracepoint_by_number (char **arg
, int multi_p
,
1037 /* Return a vector of all tracepoints currently defined. The vector
1038 is newly allocated; the caller should free when done with it. */
1039 extern VEC(breakpoint_p
) *all_tracepoints (void);
1041 extern int is_tracepoint (const struct breakpoint
*b
);
1043 /* Function that can be passed to read_command_line to validate
1044 that each command is suitable for tracepoint command list. */
1045 extern void check_tracepoint_command (char *line
, void *closure
);
1047 /* Call at the start and end of an "rbreak" command to register
1048 breakpoint numbers for a later "commands" command. */
1049 extern void start_rbreak_breakpoints (void);
1050 extern void end_rbreak_breakpoints (void);
1052 #endif /* !defined (BREAKPOINT_H) */