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 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. */
125 /* Event for JIT compiled code generation or deletion. */
129 /* States of enablement of breakpoint. */
133 bp_disabled, /* The eventpoint is inactive, and cannot trigger. */
134 bp_enabled, /* The eventpoint is active, and can trigger. */
135 bp_call_disabled, /* The eventpoint has been disabled while a call
136 into the inferior is "in flight", because some
137 eventpoints interfere with the implementation of
138 a call on some targets. The eventpoint will be
139 automatically enabled and reset when the call
140 "lands" (either completes, or stops at another
142 bp_startup_disabled,/* The eventpoint has been disabled during inferior
143 startup. This is necessary on some targets where
144 the main executable will get relocated during
145 startup, making breakpoint addresses invalid.
146 The eventpoint will be automatically enabled and
147 reset once inferior startup is complete. */
148 bp_permanent /* There is a breakpoint instruction hard-wired into
149 the target's code. Don't try to write another
150 breakpoint instruction on top of it, or restore
151 its value. Step over it using the architecture's
156 /* Disposition of breakpoint. Ie: what to do after hitting it. */
160 disp_del, /* Delete it */
161 disp_del_at_next_stop, /* Delete at next stop, whether hit or not */
162 disp_disable, /* Disable it */
163 disp_donttouch /* Leave it alone */
166 enum target_hw_bp_type
168 hw_write = 0, /* Common HW watchpoint */
169 hw_read = 1, /* Read HW watchpoint */
170 hw_access = 2, /* Access HW watchpoint */
171 hw_execute = 3 /* Execute HW breakpoint */
175 /* Information used by targets to insert and remove breakpoints. */
177 struct bp_target_info
179 /* Address space at which the breakpoint was placed. */
180 struct address_space *placed_address_space;
182 /* Address at which the breakpoint was placed. This is normally the
183 same as ADDRESS from the bp_location, except when adjustment
184 happens in gdbarch_breakpoint_from_pc. The most common form of
185 adjustment is stripping an alternate ISA marker from the PC which
186 is used to determine the type of breakpoint to insert. */
187 CORE_ADDR placed_address;
189 /* If the breakpoint lives in memory and reading that memory would
190 give back the breakpoint, instead of the original contents, then
191 the original contents are cached here. Only SHADOW_LEN bytes of
192 this buffer are valid, and only when the breakpoint is inserted. */
193 gdb_byte shadow_contents[BREAKPOINT_MAX];
195 /* The length of the data cached in SHADOW_CONTENTS. */
198 /* The size of the placed breakpoint, according to
199 gdbarch_breakpoint_from_pc, when the breakpoint was inserted. This is
200 generally the same as SHADOW_LEN, unless we did not need
201 to read from the target to implement the memory breakpoint
202 (e.g. if a remote stub handled the details). We may still
203 need the size to remove the breakpoint safely. */
207 /* GDB maintains two types of information about each breakpoint (or
208 watchpoint, or other related event). The first type corresponds
209 to struct breakpoint; this is a relatively high-level structure
210 which contains the source location(s), stopping conditions, user
211 commands to execute when the breakpoint is hit, and so forth.
213 The second type of information corresponds to struct bp_location.
214 Each breakpoint has one or (eventually) more locations associated
215 with it, which represent target-specific and machine-specific
216 mechanisms for stopping the program. For instance, a watchpoint
217 expression may require multiple hardware watchpoints in order to
218 catch all changes in the value of the expression being watched. */
222 bp_loc_software_breakpoint,
223 bp_loc_hardware_breakpoint,
224 bp_loc_hardware_watchpoint,
225 bp_loc_other /* Miscellaneous... */
230 /* Chain pointer to the next breakpoint location for
231 the same parent breakpoint. */
232 struct bp_location *next;
234 /* Pointer to the next breakpoint location, in a global
235 list of all breakpoint locations. */
236 struct bp_location *global_next;
238 /* Type of this breakpoint location. */
239 enum bp_loc_type loc_type;
241 /* Each breakpoint location must belong to exactly one higher-level
242 breakpoint. This and the DUPLICATE flag are more straightforward
243 than reference counting. */
244 struct breakpoint *owner;
246 /* Conditional. Break only if this expression's value is nonzero.
247 Unlike string form of condition, which is associated with breakpoint,
248 this is associated with location, since if breakpoint has several
249 locations, the evaluation of expression can be different for
250 different locations. */
251 struct expression *cond;
253 /* This location's address is in an unloaded solib, and so this
254 location should not be inserted. It will be automatically
255 enabled when that solib is loaded. */
258 /* Is this particular location enabled. */
261 /* Nonzero if this breakpoint is now inserted. */
264 /* Nonzero if this is not the first breakpoint in the list
265 for the given address. */
268 /* If we someday support real thread-specific breakpoints, then
269 the breakpoint location will need a thread identifier. */
271 /* Data for specific breakpoint types. These could be a union, but
272 simplicity is more important than memory usage for breakpoints. */
274 /* Architecture associated with this location's address. May be
275 different from the breakpoint architecture. */
276 struct gdbarch *gdbarch;
278 /* The program space associated with this breakpoint location
279 address. Note that an address space may be represented in more
280 than one program space (e.g. each uClinux program will be given
281 its own program space, but there will only be one address space
282 for all of them), but we must not insert more than one location
283 at the same address in the same address space. */
284 struct program_space *pspace;
286 /* Note that zero is a perfectly valid code address on some platforms
287 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
288 is not a special value for this field. Valid for all types except
292 /* For hardware watchpoints, the size of data ad ADDRESS being watches. */
295 /* Type of hardware watchpoint. */
296 enum target_hw_bp_type watchpoint_type;
298 /* For any breakpoint type with an address, this is the section
299 associated with the address. Used primarily for overlay debugging. */
300 struct obj_section *section;
302 /* Address at which breakpoint was requested, either by the user or
303 by GDB for internal breakpoints. This will usually be the same
304 as ``address'' (above) except for cases in which
305 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
306 which to place the breakpoint in order to comply with a
307 processor's architectual constraints. */
308 CORE_ADDR requested_address;
312 /* Details of the placed breakpoint, when inserted. */
313 struct bp_target_info target_info;
315 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
316 struct bp_target_info overlay_target_info;
318 /* In a non-stop mode, it's possible that we delete a breakpoint,
319 but as we do that, some still running thread hits that breakpoint.
320 For that reason, we need to keep locations belonging to deleted
321 breakpoints for a bit, so that don't report unexpected SIGTRAP.
322 We can't keep such locations forever, so we use a heuristic --
323 after we process certain number of inferior events since
324 breakpoint was deleted, we retire all locations of that breakpoint.
325 This variable keeps a number of events still to go, when
326 it becomes 0 this location is retired. */
327 int events_till_retirement;
330 /* This structure is a collection of function pointers that, if available,
331 will be called instead of the performing the default action for this
334 struct breakpoint_ops
336 /* Insert the breakpoint or activate the catchpoint. Should raise
337 an exception if the operation failed. */
338 void (*insert) (struct breakpoint *);
340 /* Remove the breakpoint/catchpoint that was previously inserted
341 with the "insert" method above. Return non-zero if the operation
343 int (*remove) (struct breakpoint *);
345 /* Return non-zero if the debugger should tell the user that this
346 breakpoint was hit. */
347 int (*breakpoint_hit) (struct breakpoint *);
349 /* The normal print routine for this breakpoint, called when we
351 enum print_stop_action (*print_it) (struct breakpoint *);
353 /* Display information about this breakpoint, for "info breakpoints". */
354 void (*print_one) (struct breakpoint *, struct bp_location **);
356 /* Display information about this breakpoint after setting it (roughly
357 speaking; this is called from "mention"). */
358 void (*print_mention) (struct breakpoint *);
361 enum watchpoint_triggered
363 /* This watchpoint definitely did not trigger. */
364 watch_triggered_no = 0,
366 /* Some hardware watchpoint triggered, and it might have been this
367 one, but we do not know which it was. */
368 watch_triggered_unknown,
370 /* This hardware watchpoint definitely did trigger. */
374 /* This is used to declare the VEC syscalls_to_be_caught. */
377 typedef struct bp_location *bp_location_p;
378 DEF_VEC_P(bp_location_p);
380 /* Note that the ->silent field is not currently used by any commands
381 (though the code is in there if it was to be, and set_raw_breakpoint
382 does set it to 0). I implemented it because I thought it would be
383 useful for a hack I had to put in; I'm going to leave it in because
384 I can see how there might be times when it would indeed be useful */
386 /* This is for a breakpoint or a watchpoint. */
390 struct breakpoint *next;
391 /* Type of breakpoint. */
393 /* Zero means disabled; remember the info but don't break here. */
394 enum enable_state enable_state;
395 /* What to do with this breakpoint after we hit it. */
396 enum bpdisp disposition;
397 /* Number assigned to distinguish breakpoints. */
400 /* Location(s) associated with this high-level breakpoint. */
401 struct bp_location *loc;
403 /* Line number of this address. */
407 /* Source file name of this address. */
411 /* Non-zero means a silent breakpoint (don't print frame info
413 unsigned char silent;
414 /* Number of stops at this breakpoint that should
415 be continued automatically before really stopping. */
417 /* Chain of command lines to execute when this breakpoint is hit. */
418 struct command_line *commands;
419 /* Stack depth (address of frame). If nonzero, break only if fp
421 struct frame_id frame_id;
423 /* The program space used to set the breakpoint. */
424 struct program_space *pspace;
426 /* String we used to set the breakpoint (malloc'd). */
428 /* Architecture we used to set the breakpoint. */
429 struct gdbarch *gdbarch;
430 /* Language we used to set the breakpoint. */
431 enum language language;
432 /* Input radix we used to set the breakpoint. */
434 /* String form of the breakpoint condition (malloc'd), or NULL if there
437 /* String form of exp (malloc'd), or NULL if none. */
440 /* The expression we are watching, or NULL if not a watchpoint. */
441 struct expression *exp;
442 /* The largest block within which it is valid, or NULL if it is
443 valid anywhere (e.g. consists just of global symbols). */
444 struct block *exp_valid_block;
445 /* Value of the watchpoint the last time we checked it, or NULL
446 when we do not know the value yet or the value was not
447 readable. VAL is never lazy. */
449 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
450 then an error occurred reading the value. */
453 /* Holds the address of the related watchpoint_scope breakpoint
454 when using watchpoints on local variables (might the concept
455 of a related breakpoint be useful elsewhere, if not just call
456 it the watchpoint_scope breakpoint or something like that. FIXME). */
457 struct breakpoint *related_breakpoint;
459 /* Holds the frame address which identifies the frame this
460 watchpoint should be evaluated in, or `null' if the watchpoint
461 should be evaluated on the outermost frame. */
462 struct frame_id watchpoint_frame;
464 /* For hardware watchpoints, the triggered status according to the
466 enum watchpoint_triggered watchpoint_triggered;
468 /* Thread number for thread-specific breakpoint, or -1 if don't care. */
471 /* Ada task number for task-specific breakpoint, or 0 if don't care. */
474 /* Count of the number of times this breakpoint was taken, dumped
475 with the info, but not used for anything else. Useful for
476 seeing how many times you hit a break prior to the program
477 aborting, so you can back up to just before the abort. */
480 /* Process id of a child process whose forking triggered this
481 catchpoint. This field is only valid immediately after this
482 catchpoint has triggered. */
483 ptid_t forked_inferior_pid;
485 /* Filename of a program whose exec triggered this catchpoint.
486 This field is only valid immediately after this catchpoint has
490 /* Syscall numbers used for the 'catch syscall' feature.
491 If no syscall has been specified for filtering, its value is NULL.
492 Otherwise, it holds a list of all syscalls to be caught.
493 The list elements are allocated with xmalloc. */
494 VEC(int) *syscalls_to_be_caught;
496 /* Methods associated with this breakpoint. */
497 struct breakpoint_ops *ops;
499 /* Is breakpoint's condition not yet parsed because we found
500 no location initially so had no context to parse
502 int condition_not_parsed;
504 /* Number of times this tracepoint should single-step
505 and collect additional data. */
508 /* Number of times this tracepoint should be hit before
512 /* Chain of action lines to execute when this tracepoint is hit. */
513 struct action_line *actions;
516 typedef struct breakpoint *breakpoint_p;
517 DEF_VEC_P(breakpoint_p);
519 /* The following stuff is an abstract data type "bpstat" ("breakpoint
520 status"). This provides the ability to determine whether we have
521 stopped at a breakpoint, and what we should do about it. */
523 typedef struct bpstats *bpstat;
525 /* Frees any storage that is part of a bpstat.
526 Does not walk the 'next' chain. */
527 extern void bpstat_free (bpstat);
529 /* Clears a chain of bpstat, freeing storage
531 extern void bpstat_clear (bpstat *);
533 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
534 is part of the bpstat is copied as well. */
535 extern bpstat bpstat_copy (bpstat);
537 extern bpstat bpstat_stop_status (struct address_space *aspace,
538 CORE_ADDR pc, ptid_t ptid);
540 /* This bpstat_what stuff tells wait_for_inferior what to do with a
541 breakpoint (a challenging task). */
543 enum bpstat_what_main_action
545 /* Perform various other tests; that is, this bpstat does not
546 say to perform any action (e.g. failed watchpoint and nothing
548 BPSTAT_WHAT_KEEP_CHECKING,
550 /* Rather than distinguish between noisy and silent stops here, it
551 might be cleaner to have bpstat_print make that decision (also
552 taking into account stop_print_frame and source_only). But the
553 implications are a bit scary (interaction with auto-displays, etc.),
554 so I won't try it. */
557 BPSTAT_WHAT_STOP_SILENT,
559 /* Stop and print. */
560 BPSTAT_WHAT_STOP_NOISY,
562 /* Remove breakpoints, single step once, then put them back in and
563 go back to what we were doing. It's possible that this should be
564 removed from the main_action and put into a separate field, to more
565 cleanly handle BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
568 /* Set longjmp_resume breakpoint, remove all other breakpoints,
569 and continue. The "remove all other breakpoints" part is required
570 if we are also stepping over another breakpoint as well as doing
571 the longjmp handling. */
572 BPSTAT_WHAT_SET_LONGJMP_RESUME,
574 /* Clear longjmp_resume breakpoint, then handle as
575 BPSTAT_WHAT_KEEP_CHECKING. */
576 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
578 /* Clear step resume breakpoint, and keep checking. */
579 BPSTAT_WHAT_STEP_RESUME,
581 /* Check the dynamic linker's data structures for new libraries, then
583 BPSTAT_WHAT_CHECK_SHLIBS,
585 /* Check for new JITed code. */
586 BPSTAT_WHAT_CHECK_JIT,
588 /* This is just used to keep track of how many enums there are. */
594 enum bpstat_what_main_action main_action;
596 /* Did we hit a call dummy breakpoint? This only goes with a main_action
597 of BPSTAT_WHAT_STOP_SILENT or BPSTAT_WHAT_STOP_NOISY (the concept of
598 continuing from a call dummy without popping the frame is not a
603 /* The possible return values for print_bpstat, print_it_normal,
604 print_it_done, print_it_noop. */
605 enum print_stop_action
613 /* Tell what to do about this bpstat. */
614 struct bpstat_what bpstat_what (bpstat);
616 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
617 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
619 /* Find a step_resume breakpoint associated with this bpstat.
620 (If there are multiple step_resume bp's on the list, this function
621 will arbitrarily pick one.)
623 It is an error to use this function if BPSTAT doesn't contain a
624 step_resume breakpoint.
626 See wait_for_inferior's use of this function.
628 extern struct breakpoint *bpstat_find_step_resume_breakpoint (bpstat);
630 /* Nonzero if a signal that we got in wait() was due to circumstances
631 explained by the BS. */
632 /* Currently that is true if we have hit a breakpoint, or if there is
633 a watchpoint enabled. */
634 #define bpstat_explains_signal(bs) ((bs) != NULL)
636 /* Nonzero if we should step constantly (e.g. watchpoints on machines
637 without hardware support). This isn't related to a specific bpstat,
638 just to things like whether watchpoints are set. */
639 extern int bpstat_should_step (void);
641 /* Print a message indicating what happened. Returns nonzero to
642 say that only the source line should be printed after this (zero
643 return means print the frame as well as the source line). */
644 extern enum print_stop_action bpstat_print (bpstat);
646 /* Put in *NUM the breakpoint number of the first breakpoint we are stopped
647 at. *BSP upon return is a bpstat which points to the remaining
648 breakpoints stopped at (but which is not guaranteed to be good for
649 anything but further calls to bpstat_num).
650 Return 0 if passed a bpstat which does not indicate any breakpoints.
651 Return -1 if stopped at a breakpoint that has been deleted since
653 Return 1 otherwise. */
654 extern int bpstat_num (bpstat *, int *);
656 /* Perform actions associated with the stopped inferior. Actually, we
657 just use this for breakpoint commands. Perhaps other actions will
658 go here later, but this is executed at a late time (from the
660 extern void bpstat_do_actions (void);
662 /* Modify BS so that the actions will not be performed. */
663 extern void bpstat_clear_actions (bpstat);
665 /* Implementation: */
667 /* Values used to tell the printing routine how to behave for this bpstat. */
670 /* This is used when we want to do a normal printing of the reason
671 for stopping. The output will depend on the type of eventpoint
672 we are dealing with. This is the default value, most commonly
675 /* This is used when nothing should be printed for this bpstat entry. */
677 /* This is used when everything which needs to be printed has
678 already been printed. But we still want to print the frame. */
684 /* Linked list because there can be two breakpoints at the same
685 place, and a bpstat reflects the fact that both have been hit. */
687 /* Breakpoint that we are at. */
688 const struct bp_location *breakpoint_at;
689 /* Commands left to be done. */
690 struct command_line *commands;
691 /* Old value associated with a watchpoint. */
692 struct value *old_val;
694 /* Nonzero if this breakpoint tells us to print the frame. */
697 /* Nonzero if this breakpoint tells us to stop. */
700 /* Tell bpstat_print and print_bp_stop_message how to print stuff
701 associated with this element of the bpstat chain. */
702 enum bp_print_how print_it;
713 /* The possible return values for breakpoint_here_p.
714 We guarantee that zero always means "no breakpoint here". */
717 no_breakpoint_here = 0,
718 ordinary_breakpoint_here,
719 permanent_breakpoint_here
723 /* Prototypes for breakpoint-related functions. */
725 extern enum breakpoint_here breakpoint_here_p (struct address_space *, CORE_ADDR);
727 extern int moribund_breakpoint_here_p (struct address_space *, CORE_ADDR);
729 extern int breakpoint_inserted_here_p (struct address_space *, CORE_ADDR);
731 extern int regular_breakpoint_inserted_here_p (struct address_space *, CORE_ADDR);
733 extern int software_breakpoint_inserted_here_p (struct address_space *, CORE_ADDR);
735 extern int breakpoint_thread_match (struct address_space *, CORE_ADDR, ptid_t);
737 extern void until_break_command (char *, int, int);
739 extern void breakpoint_re_set (void);
741 extern void breakpoint_re_set_thread (struct breakpoint *);
743 extern struct breakpoint *set_momentary_breakpoint
744 (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype);
746 extern struct breakpoint *set_momentary_breakpoint_at_pc
747 (struct gdbarch *, CORE_ADDR pc, enum bptype type);
749 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt);
751 extern void set_ignore_count (int, int, int);
753 extern void set_default_breakpoint (int, struct program_space *,
754 CORE_ADDR, struct symtab *, int);
756 extern void breakpoint_init_inferior (enum inf_context);
758 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
760 extern void delete_breakpoint (struct breakpoint *);
762 extern void breakpoint_auto_delete (bpstat);
764 extern void break_command (char *, int);
766 extern void hbreak_command_wrapper (char *, int);
767 extern void thbreak_command_wrapper (char *, int);
768 extern void rbreak_command_wrapper (char *, int);
769 extern void watch_command_wrapper (char *, int);
770 extern void awatch_command_wrapper (char *, int);
771 extern void rwatch_command_wrapper (char *, int);
772 extern void tbreak_command (char *, int);
774 extern void set_breakpoint (struct gdbarch *gdbarch,
775 char *address, char *condition,
776 int hardwareflag, int tempflag,
777 int thread, int ignore_count,
781 extern void insert_breakpoints (void);
783 extern int remove_breakpoints (void);
785 extern int remove_breakpoints_pid (int pid);
787 /* This function can be used to physically insert eventpoints from the
788 specified traced inferior process, without modifying the breakpoint
789 package's state. This can be useful for those targets which support
790 following the processes of a fork() or vfork() system call, when both
791 of the resulting two processes are to be followed. */
792 extern int reattach_breakpoints (int);
794 /* This function can be used to update the breakpoint package's state
795 after an exec() system call has been executed.
797 This function causes the following:
799 - All eventpoints are marked "not inserted".
800 - All eventpoints with a symbolic address are reset such that
801 the symbolic address must be reevaluated before the eventpoints
803 - The solib breakpoints are explicitly removed from the breakpoint
805 - A step-resume breakpoint, if any, is explicitly removed from the
807 - All eventpoints without a symbolic address are removed from the
809 extern void update_breakpoints_after_exec (void);
811 /* This function can be used to physically remove hardware breakpoints
812 and watchpoints from the specified traced inferior process, without
813 modifying the breakpoint package's state. This can be useful for
814 those targets which support following the processes of a fork() or
815 vfork() system call, when one of the resulting two processes is to
816 be detached and allowed to run free.
818 It is an error to use this function on the process whose id is
820 extern int detach_breakpoints (int);
822 /* This function is called when program space PSPACE is about to be
823 deleted. It takes care of updating breakpoints to not reference
824 this PSPACE anymore. */
825 extern void breakpoint_program_space_exit (struct program_space *pspace);
827 extern void set_longjmp_breakpoint (int thread);
828 extern void delete_longjmp_breakpoint (int thread);
830 extern void enable_overlay_breakpoints (void);
831 extern void disable_overlay_breakpoints (void);
833 /* These functions respectively disable or reenable all currently
834 enabled watchpoints. When disabled, the watchpoints are marked
835 call_disabled. When reenabled, they are marked enabled.
837 The intended client of these functions is call_function_by_hand.
839 The inferior must be stopped, and all breakpoints removed, when
840 these functions are used.
842 The need for these functions is that on some targets (e.g., HP-UX),
843 gdb is unable to unwind through the dummy frame that is pushed as
844 part of the implementation of a call command. Watchpoints can
845 cause the inferior to stop in places where this frame is visible,
846 and that can cause execution control to become very confused.
848 Note that if a user sets breakpoints in an interactively called
849 function, the call_disabled watchpoints will have been reenabled
850 when the first such breakpoint is reached. However, on targets
851 that are unable to unwind through the call dummy frame, watches
852 of stack-based storage may then be deleted, because gdb will
853 believe that their watched storage is out of scope. (Sigh.) */
854 extern void disable_watchpoints_before_interactive_call_start (void);
856 extern void enable_watchpoints_after_interactive_call_stop (void);
858 /* These functions disable and re-enable all breakpoints during
859 inferior startup. They are intended to be called from solib
860 code where necessary. This is needed on platforms where the
861 main executable is relocated at some point during startup
862 processing, making breakpoint addresses invalid.
864 If additional breakpoints are created after the routine
865 disable_breakpoints_before_startup but before the routine
866 enable_breakpoints_after_startup was called, they will also
867 be marked as disabled. */
868 extern void disable_breakpoints_before_startup (void);
869 extern void enable_breakpoints_after_startup (void);
871 /* For script interpreters that need to define breakpoint commands
872 after they've already read the commands into a struct command_line. */
873 extern enum command_control_type commands_from_control_command
874 (char *arg, struct command_line *cmd);
876 extern void clear_breakpoint_hit_counts (void);
878 extern int get_number (char **);
880 extern int get_number_or_range (char **);
882 extern struct breakpoint *get_breakpoint (int num);
884 /* The following are for displays, which aren't really breakpoints, but
885 here is as good a place as any for them. */
887 extern void disable_current_display (void);
889 extern void do_displays (void);
891 extern void disable_display (int);
893 extern void clear_displays (void);
895 extern void disable_breakpoint (struct breakpoint *);
897 extern void enable_breakpoint (struct breakpoint *);
899 extern void breakpoint_set_commands (struct breakpoint *b,
900 struct command_line *commands);
902 /* Clear the "inserted" flag in all breakpoints. */
903 extern void mark_breakpoints_out (void);
905 extern void make_breakpoint_permanent (struct breakpoint *);
907 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *,
910 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *,
913 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *,
916 extern void remove_solib_event_breakpoints (void);
918 extern void remove_thread_event_breakpoints (void);
920 extern void disable_breakpoints_in_shlibs (void);
922 /* This function returns TRUE if ep is a catchpoint. */
923 extern int ep_is_catchpoint (struct breakpoint *);
925 /* Enable breakpoints and delete when hit. Called with ARG == NULL
926 deletes all breakpoints. */
927 extern void delete_command (char *arg, int from_tty);
929 /* Pull all H/W watchpoints from the target. Return non-zero if the
931 extern int remove_hw_watchpoints (void);
933 /* Manage a software single step breakpoint (or two). Insert may be called
934 twice before remove is called. */
935 extern void insert_single_step_breakpoint (struct gdbarch *,
936 struct address_space *, CORE_ADDR);
937 extern void remove_single_step_breakpoints (void);
939 /* Manage manual breakpoints, separate from the normal chain of
940 breakpoints. These functions are used in murky target-specific
941 ways. Please do not add more uses! */
942 extern void *deprecated_insert_raw_breakpoint (struct gdbarch *,
943 struct address_space *, CORE_ADDR);
944 extern int deprecated_remove_raw_breakpoint (struct gdbarch *, void *);
946 /* Check if any hardware watchpoints have triggered, according to the
948 int watchpoints_triggered (struct target_waitstatus *);
950 /* Update BUF, which is LEN bytes read from the target address MEMADDR,
951 by replacing any memory breakpoints with their shadowed contents. */
952 void breakpoint_restore_shadows (gdb_byte *buf, ULONGEST memaddr,
955 extern int breakpoints_always_inserted_mode (void);
957 /* Called each time new event from target is processed.
958 Retires previously deleted breakpoint locations that
959 in our opinion won't ever trigger. */
960 extern void breakpoint_retire_moribund (void);
962 /* Checks if we are catching syscalls or not.
963 Returns 0 if not, greater than 0 if we are. */
964 extern int catch_syscall_enabled (void);
966 /* Checks if we are catching syscalls with the specific
967 syscall_number. Used for "filtering" the catchpoints.
968 Returns 0 if not, greater than 0 if we are. */
969 extern int catching_syscall_number (int syscall_number);
971 /* Tell a breakpoint to be quiet. */
972 extern void make_breakpoint_silent (struct breakpoint *);
974 /* Return a tracepoint with the given number if found. */
975 extern struct breakpoint *get_tracepoint (int num);
977 /* Find a tracepoint by parsing a number in the supplied string. */
978 extern struct breakpoint *get_tracepoint_by_number (char **arg, int multi_p,
981 /* Return a vector of all tracepoints currently defined. The vector
982 is newly allocated; the caller should free when done with it. */
983 extern VEC(breakpoint_p) *all_tracepoints (void);
985 #endif /* !defined (BREAKPOINT_H) */
projects / binutils.git / blob