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
29 struct breakpoint_object
;
31 /* This is the maximum number of bytes a breakpoint instruction can take.
32 Feel free to increase it. It's just used in a few places to size
33 arrays that should be independent of the target architecture. */
35 #define BREAKPOINT_MAX 16
38 /* Type of breakpoint. */
39 /* FIXME In the future, we should fold all other breakpoint-like things into
42 * single-step (for machines where we have to simulate single stepping)
43 (probably, though perhaps it is better for it to look as much as
44 possible like a single-step to wait_for_inferior). */
48 bp_none
= 0, /* Eventpoint has been deleted. */
49 bp_breakpoint
, /* Normal breakpoint */
50 bp_hardware_breakpoint
, /* Hardware assisted breakpoint */
51 bp_until
, /* used by until command */
52 bp_finish
, /* used by finish command */
53 bp_watchpoint
, /* Watchpoint */
54 bp_hardware_watchpoint
, /* Hardware assisted watchpoint */
55 bp_read_watchpoint
, /* read watchpoint, (hardware assisted) */
56 bp_access_watchpoint
, /* access watchpoint, (hardware assisted) */
57 bp_longjmp
, /* secret breakpoint to find longjmp() */
58 bp_longjmp_resume
, /* secret breakpoint to escape longjmp() */
60 /* An internal breakpoint that is installed on the unwinder's
63 /* An internal breakpoint that is set at the point where an
64 exception will land. */
67 /* Used by wait_for_inferior for stepping over subroutine calls, for
68 stepping over signal handlers, and for skipping prologues. */
71 /* Used to detect when a watchpoint expression has gone out of
72 scope. These breakpoints are usually not visible to the user.
74 This breakpoint has some interesting properties:
76 1) There's always a 1:1 mapping between watchpoints
77 on local variables and watchpoint_scope breakpoints.
79 2) It automatically deletes itself and the watchpoint it's
80 associated with when hit.
82 3) It can never be disabled. */
85 /* The breakpoint at the end of a call dummy. */
86 /* FIXME: What if the function we are calling longjmp()s out of the
87 call, or the user gets out with the "return" command? We currently
88 have no way of cleaning up the breakpoint in these (obscure) situations.
89 (Probably can solve this by noticing longjmp, "return", etc., it's
90 similar to noticing when a watchpoint on a local variable goes out
91 of scope (with hardware support for watchpoints)). */
94 /* A breakpoint set on std::terminate, that is used to catch
95 otherwise uncaught exceptions thrown during an inferior call. */
98 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
99 code in the inferior to run when significant events occur in the
100 dynamic linker (for example a library is loaded or unloaded).
102 By placing a breakpoint in this magic code GDB will get control
103 when these significant events occur. GDB can then re-examine
104 the dynamic linker's data structures to discover any newly loaded
105 dynamic libraries. */
108 /* Some multi-threaded systems can arrange for a location in the
109 inferior to be executed when certain thread-related events occur
110 (such as thread creation or thread death).
112 By placing a breakpoint at one of these locations, GDB will get
113 control when these events occur. GDB can then update its thread
118 /* On the same principal, an overlay manager can arrange to call a
119 magic location in the inferior whenever there is an interesting
120 change in overlay status. GDB can update its overlay tables
121 and fiddle with breakpoints in overlays when this breakpoint
126 /* Master copies of longjmp breakpoints. These are always installed
127 as soon as an objfile containing longjmp is loaded, but they are
128 always disabled. While necessary, temporary clones of bp_longjmp
129 type will be created and enabled. */
133 /* Master copies of std::terminate breakpoints. */
134 bp_std_terminate_master
,
136 /* Like bp_longjmp_master, but for exceptions. */
143 bp_static_tracepoint
,
145 /* Event for JIT compiled code generation or deletion. */
149 /* States of enablement of breakpoint. */
153 bp_disabled
, /* The eventpoint is inactive, and cannot trigger. */
154 bp_enabled
, /* The eventpoint is active, and can trigger. */
155 bp_call_disabled
, /* The eventpoint has been disabled while a call
156 into the inferior is "in flight", because some
157 eventpoints interfere with the implementation of
158 a call on some targets. The eventpoint will be
159 automatically enabled and reset when the call
160 "lands" (either completes, or stops at another
162 bp_startup_disabled
,/* The eventpoint has been disabled during inferior
163 startup. This is necessary on some targets where
164 the main executable will get relocated during
165 startup, making breakpoint addresses invalid.
166 The eventpoint will be automatically enabled and
167 reset once inferior startup is complete. */
168 bp_permanent
/* There is a breakpoint instruction hard-wired into
169 the target's code. Don't try to write another
170 breakpoint instruction on top of it, or restore
171 its value. Step over it using the architecture's
176 /* Disposition of breakpoint. Ie: what to do after hitting it. */
180 disp_del
, /* Delete it */
181 disp_del_at_next_stop
, /* Delete at next stop, whether hit or not */
182 disp_disable
, /* Disable it */
183 disp_donttouch
/* Leave it alone */
186 enum target_hw_bp_type
188 hw_write
= 0, /* Common HW watchpoint */
189 hw_read
= 1, /* Read HW watchpoint */
190 hw_access
= 2, /* Access HW watchpoint */
191 hw_execute
= 3 /* Execute HW breakpoint */
195 /* Information used by targets to insert and remove breakpoints. */
197 struct bp_target_info
199 /* Address space at which the breakpoint was placed. */
200 struct address_space
*placed_address_space
;
202 /* Address at which the breakpoint was placed. This is normally the
203 same as ADDRESS from the bp_location, except when adjustment
204 happens in gdbarch_breakpoint_from_pc. The most common form of
205 adjustment is stripping an alternate ISA marker from the PC which
206 is used to determine the type of breakpoint to insert. */
207 CORE_ADDR placed_address
;
209 /* If the breakpoint lives in memory and reading that memory would
210 give back the breakpoint, instead of the original contents, then
211 the original contents are cached here. Only SHADOW_LEN bytes of
212 this buffer are valid, and only when the breakpoint is inserted. */
213 gdb_byte shadow_contents
[BREAKPOINT_MAX
];
215 /* The length of the data cached in SHADOW_CONTENTS. */
218 /* The size of the placed breakpoint, according to
219 gdbarch_breakpoint_from_pc, when the breakpoint was inserted. This is
220 generally the same as SHADOW_LEN, unless we did not need
221 to read from the target to implement the memory breakpoint
222 (e.g. if a remote stub handled the details). We may still
223 need the size to remove the breakpoint safely. */
227 /* GDB maintains two types of information about each breakpoint (or
228 watchpoint, or other related event). The first type corresponds
229 to struct breakpoint; this is a relatively high-level structure
230 which contains the source location(s), stopping conditions, user
231 commands to execute when the breakpoint is hit, and so forth.
233 The second type of information corresponds to struct bp_location.
234 Each breakpoint has one or (eventually) more locations associated
235 with it, which represent target-specific and machine-specific
236 mechanisms for stopping the program. For instance, a watchpoint
237 expression may require multiple hardware watchpoints in order to
238 catch all changes in the value of the expression being watched. */
242 bp_loc_software_breakpoint
,
243 bp_loc_hardware_breakpoint
,
244 bp_loc_hardware_watchpoint
,
245 bp_loc_other
/* Miscellaneous... */
250 /* Chain pointer to the next breakpoint location for
251 the same parent breakpoint. */
252 struct bp_location
*next
;
254 /* The reference count. */
257 /* Type of this breakpoint location. */
258 enum bp_loc_type loc_type
;
260 /* Each breakpoint location must belong to exactly one higher-level
261 breakpoint. This pointer is NULL iff this bp_location is no
262 longer attached to a breakpoint. For example, when a breakpoint
263 is deleted, its locations may still be found in the
264 moribund_locations list, or if we had stopped for it, in
266 struct breakpoint
*owner
;
268 /* Conditional. Break only if this expression's value is nonzero.
269 Unlike string form of condition, which is associated with
270 breakpoint, this is associated with location, since if breakpoint
271 has several locations, the evaluation of expression can be
272 different for different locations. Only valid for real
273 breakpoints; a watchpoint's conditional expression is stored in
274 the owner breakpoint object. */
275 struct expression
*cond
;
277 /* This location's address is in an unloaded solib, and so this
278 location should not be inserted. It will be automatically
279 enabled when that solib is loaded. */
282 /* Is this particular location enabled. */
285 /* Nonzero if this breakpoint is now inserted. */
288 /* Nonzero if this is not the first breakpoint in the list
289 for the given address. */
292 /* If we someday support real thread-specific breakpoints, then
293 the breakpoint location will need a thread identifier. */
295 /* Data for specific breakpoint types. These could be a union, but
296 simplicity is more important than memory usage for breakpoints. */
298 /* Architecture associated with this location's address. May be
299 different from the breakpoint architecture. */
300 struct gdbarch
*gdbarch
;
302 /* The program space associated with this breakpoint location
303 address. Note that an address space may be represented in more
304 than one program space (e.g. each uClinux program will be given
305 its own program space, but there will only be one address space
306 for all of them), but we must not insert more than one location
307 at the same address in the same address space. */
308 struct program_space
*pspace
;
310 /* Note that zero is a perfectly valid code address on some platforms
311 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
312 is not a special value for this field. Valid for all types except
316 /* For hardware watchpoints, the size of data ad ADDRESS being watches. */
319 /* Type of hardware watchpoint. */
320 enum target_hw_bp_type watchpoint_type
;
322 /* For any breakpoint type with an address, this is the section
323 associated with the address. Used primarily for overlay debugging. */
324 struct obj_section
*section
;
326 /* Address at which breakpoint was requested, either by the user or
327 by GDB for internal breakpoints. This will usually be the same
328 as ``address'' (above) except for cases in which
329 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
330 which to place the breakpoint in order to comply with a
331 processor's architectual constraints. */
332 CORE_ADDR requested_address
;
336 /* Details of the placed breakpoint, when inserted. */
337 struct bp_target_info target_info
;
339 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
340 struct bp_target_info overlay_target_info
;
342 /* In a non-stop mode, it's possible that we delete a breakpoint,
343 but as we do that, some still running thread hits that breakpoint.
344 For that reason, we need to keep locations belonging to deleted
345 breakpoints for a bit, so that don't report unexpected SIGTRAP.
346 We can't keep such locations forever, so we use a heuristic --
347 after we process certain number of inferior events since
348 breakpoint was deleted, we retire all locations of that breakpoint.
349 This variable keeps a number of events still to go, when
350 it becomes 0 this location is retired. */
351 int events_till_retirement
;
354 /* This structure is a collection of function pointers that, if available,
355 will be called instead of the performing the default action for this
358 struct breakpoint_ops
360 /* Insert the breakpoint or activate the catchpoint. Should raise
361 an exception if the operation failed. */
362 void (*insert
) (struct breakpoint
*);
364 /* Remove the breakpoint/catchpoint that was previously inserted
365 with the "insert" method above. Return non-zero if the operation
367 int (*remove
) (struct breakpoint
*);
369 /* Return non-zero if the debugger should tell the user that this
370 breakpoint was hit. */
371 int (*breakpoint_hit
) (struct breakpoint
*);
373 /* The normal print routine for this breakpoint, called when we
375 enum print_stop_action (*print_it
) (struct breakpoint
*);
377 /* Display information about this breakpoint, for "info breakpoints". */
378 void (*print_one
) (struct breakpoint
*, struct bp_location
**);
380 /* Display information about this breakpoint after setting it (roughly
381 speaking; this is called from "mention"). */
382 void (*print_mention
) (struct breakpoint
*);
384 /* Print to FP the CLI command that recreates this breakpoint. */
385 void (*print_recreate
) (struct breakpoint
*, struct ui_file
*fp
);
388 enum watchpoint_triggered
390 /* This watchpoint definitely did not trigger. */
391 watch_triggered_no
= 0,
393 /* Some hardware watchpoint triggered, and it might have been this
394 one, but we do not know which it was. */
395 watch_triggered_unknown
,
397 /* This hardware watchpoint definitely did trigger. */
401 /* This is used to declare the VEC syscalls_to_be_caught. */
404 typedef struct bp_location
*bp_location_p
;
405 DEF_VEC_P(bp_location_p
);
407 /* A reference-counted struct command_line. This lets multiple
408 breakpoints share a single command list. This is an implementation
409 detail to the breakpoints module. */
410 struct counted_command_line
;
412 /* Note that the ->silent field is not currently used by any commands
413 (though the code is in there if it was to be, and set_raw_breakpoint
414 does set it to 0). I implemented it because I thought it would be
415 useful for a hack I had to put in; I'm going to leave it in because
416 I can see how there might be times when it would indeed be useful */
418 /* This is for a breakpoint or a watchpoint. */
422 struct breakpoint
*next
;
423 /* Type of breakpoint. */
425 /* Zero means disabled; remember the info but don't break here. */
426 enum enable_state enable_state
;
427 /* What to do with this breakpoint after we hit it. */
428 enum bpdisp disposition
;
429 /* Number assigned to distinguish breakpoints. */
432 /* Location(s) associated with this high-level breakpoint. */
433 struct bp_location
*loc
;
435 /* Line number of this address. */
439 /* Source file name of this address. */
443 /* Non-zero means a silent breakpoint (don't print frame info
445 unsigned char silent
;
446 /* Number of stops at this breakpoint that should
447 be continued automatically before really stopping. */
449 /* Chain of command lines to execute when this breakpoint is hit. */
450 struct counted_command_line
*commands
;
451 /* Stack depth (address of frame). If nonzero, break only if fp
453 struct frame_id frame_id
;
455 /* The program space used to set the breakpoint. */
456 struct program_space
*pspace
;
458 /* String we used to set the breakpoint (malloc'd). */
460 /* Architecture we used to set the breakpoint. */
461 struct gdbarch
*gdbarch
;
462 /* Language we used to set the breakpoint. */
463 enum language language
;
464 /* Input radix we used to set the breakpoint. */
466 /* String form of the breakpoint condition (malloc'd), or NULL if there
469 /* String form of exp to use for displaying to the user (malloc'd), or
472 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
473 char *exp_string_reparse
;
475 /* The expression we are watching, or NULL if not a watchpoint. */
476 struct expression
*exp
;
477 /* The largest block within which it is valid, or NULL if it is
478 valid anywhere (e.g. consists just of global symbols). */
479 struct block
*exp_valid_block
;
480 /* The conditional expression if any. NULL if not a watchpoint. */
481 struct expression
*cond_exp
;
482 /* The largest block within which it is valid, or NULL if it is
483 valid anywhere (e.g. consists just of global symbols). */
484 struct block
*cond_exp_valid_block
;
485 /* Value of the watchpoint the last time we checked it, or NULL
486 when we do not know the value yet or the value was not
487 readable. VAL is never lazy. */
489 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
490 then an error occurred reading the value. */
493 /* Holds the address of the related watchpoint_scope breakpoint
494 when using watchpoints on local variables (might the concept
495 of a related breakpoint be useful elsewhere, if not just call
496 it the watchpoint_scope breakpoint or something like that. FIXME). */
497 struct breakpoint
*related_breakpoint
;
499 /* Holds the frame address which identifies the frame this
500 watchpoint should be evaluated in, or `null' if the watchpoint
501 should be evaluated on the outermost frame. */
502 struct frame_id watchpoint_frame
;
504 /* Holds the thread which identifies the frame this watchpoint
505 should be considered in scope for, or `null_ptid' if the
506 watchpoint should be evaluated in all threads. */
507 ptid_t watchpoint_thread
;
509 /* For hardware watchpoints, the triggered status according to the
511 enum watchpoint_triggered watchpoint_triggered
;
513 /* Thread number for thread-specific breakpoint, or -1 if don't care. */
516 /* Ada task number for task-specific breakpoint, or 0 if don't care. */
519 /* Count of the number of times this breakpoint was taken, dumped
520 with the info, but not used for anything else. Useful for
521 seeing how many times you hit a break prior to the program
522 aborting, so you can back up to just before the abort. */
525 /* Process id of a child process whose forking triggered this
526 catchpoint. This field is only valid immediately after this
527 catchpoint has triggered. */
528 ptid_t forked_inferior_pid
;
530 /* Filename of a program whose exec triggered this catchpoint.
531 This field is only valid immediately after this catchpoint has
535 /* Syscall numbers used for the 'catch syscall' feature.
536 If no syscall has been specified for filtering, its value is NULL.
537 Otherwise, it holds a list of all syscalls to be caught.
538 The list elements are allocated with xmalloc. */
539 VEC(int) *syscalls_to_be_caught
;
541 /* Methods associated with this breakpoint. */
542 struct breakpoint_ops
*ops
;
544 /* Is breakpoint's condition not yet parsed because we found
545 no location initially so had no context to parse
547 int condition_not_parsed
;
549 /* Number of times this tracepoint should single-step
550 and collect additional data. */
553 /* Number of times this tracepoint should be hit before
557 /* The number of the tracepoint on the target. */
558 int number_on_target
;
560 /* The static tracepoint marker id, if known. */
561 char *static_trace_marker_id
;
563 /* LTTng/UST allow more than one marker with the same ID string,
564 although it unadvised because it confuses tools. When setting
565 static tracepoints by marker ID, this will record the index in
566 the array of markers we found for the given marker ID for which
567 this static tracepoint corresponds. When resetting
568 breakpoints, we will use this index to try to find the same
570 int static_trace_marker_id_idx
;
572 /* With a Python scripting enabled GDB, store a reference to the
573 Python object that has been associated with this breakpoint.
574 This is always NULL for a GDB that is not script enabled. It
575 can sometimes be NULL for enabled GDBs as not all breakpoint
576 types are tracked by the Python scripting API. */
577 struct breakpoint_object
*py_bp_object
;
580 typedef struct breakpoint
*breakpoint_p
;
581 DEF_VEC_P(breakpoint_p
);
583 /* The following stuff is an abstract data type "bpstat" ("breakpoint
584 status"). This provides the ability to determine whether we have
585 stopped at a breakpoint, and what we should do about it. */
587 typedef struct bpstats
*bpstat
;
589 /* Clears a chain of bpstat, freeing storage
591 extern void bpstat_clear (bpstat
*);
593 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
594 is part of the bpstat is copied as well. */
595 extern bpstat
bpstat_copy (bpstat
);
597 extern bpstat
bpstat_stop_status (struct address_space
*aspace
,
598 CORE_ADDR pc
, ptid_t ptid
);
600 /* This bpstat_what stuff tells wait_for_inferior what to do with a
601 breakpoint (a challenging task).
603 The enum values order defines priority-like order of the actions.
604 Once you've decided that some action is appropriate, you'll never
605 go back and decide something of a lower priority is better. Each
606 of these actions is mutually exclusive with the others. That
607 means, that if you find yourself adding a new action class here and
608 wanting to tell GDB that you have two simultaneous actions to
609 handle, something is wrong, and you probably don't actually need a
612 Note that a step resume breakpoint overrides another breakpoint of
613 signal handling (see comment in wait_for_inferior at where we set
614 the step_resume breakpoint). */
616 enum bpstat_what_main_action
618 /* Perform various other tests; that is, this bpstat does not
619 say to perform any action (e.g. failed watchpoint and nothing
621 BPSTAT_WHAT_KEEP_CHECKING
,
623 /* Remove breakpoints, single step once, then put them back in and
624 go back to what we were doing. It's possible that this should be
625 removed from the main_action and put into a separate field, to more
626 cleanly handle BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
629 /* Set longjmp_resume breakpoint, remove all other breakpoints,
630 and continue. The "remove all other breakpoints" part is required
631 if we are also stepping over another breakpoint as well as doing
632 the longjmp handling. */
633 BPSTAT_WHAT_SET_LONGJMP_RESUME
,
635 /* Clear longjmp_resume breakpoint, then handle as
636 BPSTAT_WHAT_KEEP_CHECKING. */
637 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME
,
639 /* Rather than distinguish between noisy and silent stops here, it
640 might be cleaner to have bpstat_print make that decision (also
641 taking into account stop_print_frame and source_only). But the
642 implications are a bit scary (interaction with auto-displays, etc.),
643 so I won't try it. */
646 BPSTAT_WHAT_STOP_SILENT
,
648 /* Stop and print. */
649 BPSTAT_WHAT_STOP_NOISY
,
651 /* Clear step resume breakpoint, and keep checking. */
652 BPSTAT_WHAT_STEP_RESUME
,
655 /* An enum indicating the kind of "stack dummy" stop. This is a bit
656 of a misnomer because only one kind of truly a stack dummy. */
659 /* We didn't stop at a stack dummy breakpoint. */
662 /* Stopped at a stack dummy. */
665 /* Stopped at std::terminate. */
671 enum bpstat_what_main_action main_action
;
673 /* Did we hit a call dummy breakpoint? This only goes with a main_action
674 of BPSTAT_WHAT_STOP_SILENT or BPSTAT_WHAT_STOP_NOISY (the concept of
675 continuing from a call dummy without popping the frame is not a
677 enum stop_stack_kind call_dummy
;
679 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
680 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
681 longjmp, false if we are handling an exception. */
685 /* The possible return values for print_bpstat, print_it_normal,
686 print_it_done, print_it_noop. */
687 enum print_stop_action
695 /* Tell what to do about this bpstat. */
696 struct bpstat_what
bpstat_what (bpstat
);
698 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
699 bpstat
bpstat_find_breakpoint (bpstat
, struct breakpoint
*);
701 /* Nonzero if a signal that we got in wait() was due to circumstances
702 explained by the BS. */
703 /* Currently that is true if we have hit a breakpoint, or if there is
704 a watchpoint enabled. */
705 #define bpstat_explains_signal(bs) ((bs) != NULL)
707 /* Nonzero is this bpstat causes a stop. */
708 extern int bpstat_causes_stop (bpstat
);
710 /* Nonzero if we should step constantly (e.g. watchpoints on machines
711 without hardware support). This isn't related to a specific bpstat,
712 just to things like whether watchpoints are set. */
713 extern int bpstat_should_step (void);
715 /* Print a message indicating what happened. Returns nonzero to
716 say that only the source line should be printed after this (zero
717 return means print the frame as well as the source line). */
718 extern enum print_stop_action
bpstat_print (bpstat
);
720 /* Put in *NUM the breakpoint number of the first breakpoint we are stopped
721 at. *BSP upon return is a bpstat which points to the remaining
722 breakpoints stopped at (but which is not guaranteed to be good for
723 anything but further calls to bpstat_num).
724 Return 0 if passed a bpstat which does not indicate any breakpoints.
725 Return -1 if stopped at a breakpoint that has been deleted since
727 Return 1 otherwise. */
728 extern int bpstat_num (bpstat
*, int *);
730 /* Perform actions associated with the stopped inferior. Actually, we
731 just use this for breakpoint commands. Perhaps other actions will
732 go here later, but this is executed at a late time (from the
734 extern void bpstat_do_actions (void);
736 /* Modify BS so that the actions will not be performed. */
737 extern void bpstat_clear_actions (bpstat
);
739 /* Implementation: */
741 /* Values used to tell the printing routine how to behave for this bpstat. */
744 /* This is used when we want to do a normal printing of the reason
745 for stopping. The output will depend on the type of eventpoint
746 we are dealing with. This is the default value, most commonly
749 /* This is used when nothing should be printed for this bpstat entry. */
751 /* This is used when everything which needs to be printed has
752 already been printed. But we still want to print the frame. */
758 /* Linked list because there can be more than one breakpoint at
759 the same place, and a bpstat reflects the fact that all have
763 /* Location that caused the stop. Locations are refcounted, so
764 this will never be NULL. Note that this location may end up
765 detached from a breakpoint, but that does not necessary mean
766 that the struct breakpoint is gone. E.g., consider a
767 watchpoint with a condition that involves an inferior function
768 call. Watchpoint locations are recreated often (on resumes,
769 hence on infcalls too). Between creating the bpstat and after
770 evaluating the watchpoint condition, this location may hence
771 end up detached from its original owner watchpoint, even though
772 the watchpoint is still listed. If it's condition evaluates as
773 true, we still want this location to cause a stop, and we will
774 still need to know which watchpoint it was originally attached.
775 What this means is that we should not (in most cases) follow
776 the `bpstat->bp_location->owner' link, but instead use the
777 `breakpoint_at' field below. */
778 struct bp_location
*bp_location_at
;
780 /* Breakpoint that caused the stop. This is nullified if the
781 breakpoint ends up being deleted. See comments on
782 `bp_location_at' above for why do we need this field instead of
783 following the location's owner. */
784 struct breakpoint
*breakpoint_at
;
786 /* The associated command list. */
787 struct counted_command_line
*commands
;
789 /* Commands left to be done. This points somewhere in
791 struct command_line
*commands_left
;
793 /* Old value associated with a watchpoint. */
794 struct value
*old_val
;
796 /* Nonzero if this breakpoint tells us to print the frame. */
799 /* Nonzero if this breakpoint tells us to stop. */
802 /* Tell bpstat_print and print_bp_stop_message how to print stuff
803 associated with this element of the bpstat chain. */
804 enum bp_print_how print_it
;
815 /* The possible return values for breakpoint_here_p.
816 We guarantee that zero always means "no breakpoint here". */
819 no_breakpoint_here
= 0,
820 ordinary_breakpoint_here
,
821 permanent_breakpoint_here
825 /* Prototypes for breakpoint-related functions. */
827 extern enum breakpoint_here
breakpoint_here_p (struct address_space
*, CORE_ADDR
);
829 extern int moribund_breakpoint_here_p (struct address_space
*, CORE_ADDR
);
831 extern int breakpoint_inserted_here_p (struct address_space
*, CORE_ADDR
);
833 extern int regular_breakpoint_inserted_here_p (struct address_space
*, CORE_ADDR
);
835 extern int software_breakpoint_inserted_here_p (struct address_space
*, CORE_ADDR
);
837 /* Returns true if there's a hardware watchpoint or access watchpoint
838 inserted in the range defined by ADDR and LEN. */
839 extern int hardware_watchpoint_inserted_in_range (struct address_space
*,
843 extern int breakpoint_thread_match (struct address_space
*, CORE_ADDR
, ptid_t
);
845 extern void until_break_command (char *, int, int);
847 extern void breakpoint_re_set (void);
849 extern void breakpoint_re_set_thread (struct breakpoint
*);
851 extern struct breakpoint
*set_momentary_breakpoint
852 (struct gdbarch
*, struct symtab_and_line
, struct frame_id
, enum bptype
);
854 extern struct breakpoint
*set_momentary_breakpoint_at_pc
855 (struct gdbarch
*, CORE_ADDR pc
, enum bptype type
);
857 extern struct breakpoint
*clone_momentary_breakpoint (struct breakpoint
*bpkt
);
859 extern void set_ignore_count (int, int, int);
861 extern void set_default_breakpoint (int, struct program_space
*,
862 CORE_ADDR
, struct symtab
*, int);
864 extern void breakpoint_init_inferior (enum inf_context
);
866 extern struct cleanup
*make_cleanup_delete_breakpoint (struct breakpoint
*);
868 extern void delete_breakpoint (struct breakpoint
*);
870 extern void breakpoint_auto_delete (bpstat
);
872 /* Return the chain of command lines to execute when this breakpoint
874 extern struct command_line
*breakpoint_commands (struct breakpoint
*b
);
876 extern void break_command (char *, int);
878 extern void hbreak_command_wrapper (char *, int);
879 extern void thbreak_command_wrapper (char *, int);
880 extern void rbreak_command_wrapper (char *, int);
881 extern void watch_command_wrapper (char *, int, int);
882 extern void awatch_command_wrapper (char *, int, int);
883 extern void rwatch_command_wrapper (char *, int, int);
884 extern void tbreak_command (char *, int);
886 extern int create_breakpoint (struct gdbarch
*gdbarch
, char *arg
,
887 char *cond_string
, int thread
,
888 int parse_condition_and_thread
,
889 int tempflag
, enum bptype wanted_type
,
891 enum auto_boolean pending_break_support
,
892 struct breakpoint_ops
*ops
,
897 extern void insert_breakpoints (void);
899 extern int remove_breakpoints (void);
901 extern int remove_breakpoints_pid (int pid
);
903 /* This function can be used to physically insert eventpoints from the
904 specified traced inferior process, without modifying the breakpoint
905 package's state. This can be useful for those targets which support
906 following the processes of a fork() or vfork() system call, when both
907 of the resulting two processes are to be followed. */
908 extern int reattach_breakpoints (int);
910 /* This function can be used to update the breakpoint package's state
911 after an exec() system call has been executed.
913 This function causes the following:
915 - All eventpoints are marked "not inserted".
916 - All eventpoints with a symbolic address are reset such that
917 the symbolic address must be reevaluated before the eventpoints
919 - The solib breakpoints are explicitly removed from the breakpoint
921 - A step-resume breakpoint, if any, is explicitly removed from the
923 - All eventpoints without a symbolic address are removed from the
925 extern void update_breakpoints_after_exec (void);
927 /* This function can be used to physically remove hardware breakpoints
928 and watchpoints from the specified traced inferior process, without
929 modifying the breakpoint package's state. This can be useful for
930 those targets which support following the processes of a fork() or
931 vfork() system call, when one of the resulting two processes is to
932 be detached and allowed to run free.
934 It is an error to use this function on the process whose id is
936 extern int detach_breakpoints (int);
938 /* This function is called when program space PSPACE is about to be
939 deleted. It takes care of updating breakpoints to not reference
940 this PSPACE anymore. */
941 extern void breakpoint_program_space_exit (struct program_space
*pspace
);
943 extern void set_longjmp_breakpoint (struct thread_info
*tp
,
944 struct frame_id frame
);
945 extern void delete_longjmp_breakpoint (int thread
);
947 extern void enable_overlay_breakpoints (void);
948 extern void disable_overlay_breakpoints (void);
950 extern void set_std_terminate_breakpoint (void);
951 extern void delete_std_terminate_breakpoint (void);
953 /* These functions respectively disable or reenable all currently
954 enabled watchpoints. When disabled, the watchpoints are marked
955 call_disabled. When reenabled, they are marked enabled.
957 The intended client of these functions is call_function_by_hand.
959 The inferior must be stopped, and all breakpoints removed, when
960 these functions are used.
962 The need for these functions is that on some targets (e.g., HP-UX),
963 gdb is unable to unwind through the dummy frame that is pushed as
964 part of the implementation of a call command. Watchpoints can
965 cause the inferior to stop in places where this frame is visible,
966 and that can cause execution control to become very confused.
968 Note that if a user sets breakpoints in an interactively called
969 function, the call_disabled watchpoints will have been reenabled
970 when the first such breakpoint is reached. However, on targets
971 that are unable to unwind through the call dummy frame, watches
972 of stack-based storage may then be deleted, because gdb will
973 believe that their watched storage is out of scope. (Sigh.) */
974 extern void disable_watchpoints_before_interactive_call_start (void);
976 extern void enable_watchpoints_after_interactive_call_stop (void);
978 /* These functions disable and re-enable all breakpoints during
979 inferior startup. They are intended to be called from solib
980 code where necessary. This is needed on platforms where the
981 main executable is relocated at some point during startup
982 processing, making breakpoint addresses invalid.
984 If additional breakpoints are created after the routine
985 disable_breakpoints_before_startup but before the routine
986 enable_breakpoints_after_startup was called, they will also
987 be marked as disabled. */
988 extern void disable_breakpoints_before_startup (void);
989 extern void enable_breakpoints_after_startup (void);
991 /* For script interpreters that need to define breakpoint commands
992 after they've already read the commands into a struct command_line. */
993 extern enum command_control_type commands_from_control_command
994 (char *arg
, struct command_line
*cmd
);
996 extern void clear_breakpoint_hit_counts (void);
998 extern int get_number (char **);
1000 extern int get_number_or_range (char **);
1002 extern struct breakpoint
*get_breakpoint (int num
);
1004 /* The following are for displays, which aren't really breakpoints, but
1005 here is as good a place as any for them. */
1007 extern void disable_current_display (void);
1009 extern void do_displays (void);
1011 extern void disable_display (int);
1013 extern void clear_displays (void);
1015 extern void disable_breakpoint (struct breakpoint
*);
1017 extern void enable_breakpoint (struct breakpoint
*);
1019 extern void breakpoint_set_commands (struct breakpoint
*b
,
1020 struct command_line
*commands
);
1022 /* Clear the "inserted" flag in all breakpoints. */
1023 extern void mark_breakpoints_out (void);
1025 extern void make_breakpoint_permanent (struct breakpoint
*);
1027 extern struct breakpoint
*create_jit_event_breakpoint (struct gdbarch
*,
1030 extern struct breakpoint
*create_solib_event_breakpoint (struct gdbarch
*,
1033 extern struct breakpoint
*create_thread_event_breakpoint (struct gdbarch
*,
1036 extern void remove_solib_event_breakpoints (void);
1038 extern void remove_thread_event_breakpoints (void);
1040 extern void disable_breakpoints_in_shlibs (void);
1042 /* This function returns TRUE if ep is a catchpoint. */
1043 extern int ep_is_catchpoint (struct breakpoint
*);
1045 /* Enable breakpoints and delete when hit. Called with ARG == NULL
1046 deletes all breakpoints. */
1047 extern void delete_command (char *arg
, int from_tty
);
1049 /* Pull all H/W watchpoints from the target. Return non-zero if the
1051 extern int remove_hw_watchpoints (void);
1053 /* Manage a software single step breakpoint (or two). Insert may be called
1054 twice before remove is called. */
1055 extern void insert_single_step_breakpoint (struct gdbarch
*,
1056 struct address_space
*, CORE_ADDR
);
1057 extern int single_step_breakpoints_inserted (void);
1058 extern void remove_single_step_breakpoints (void);
1059 extern void cancel_single_step_breakpoints (void);
1061 /* Manage manual breakpoints, separate from the normal chain of
1062 breakpoints. These functions are used in murky target-specific
1063 ways. Please do not add more uses! */
1064 extern void *deprecated_insert_raw_breakpoint (struct gdbarch
*,
1065 struct address_space
*, CORE_ADDR
);
1066 extern int deprecated_remove_raw_breakpoint (struct gdbarch
*, void *);
1068 /* Check if any hardware watchpoints have triggered, according to the
1070 int watchpoints_triggered (struct target_waitstatus
*);
1072 /* Update BUF, which is LEN bytes read from the target address MEMADDR,
1073 by replacing any memory breakpoints with their shadowed contents. */
1074 void breakpoint_restore_shadows (gdb_byte
*buf
, ULONGEST memaddr
,
1077 extern int breakpoints_always_inserted_mode (void);
1079 /* Called each time new event from target is processed.
1080 Retires previously deleted breakpoint locations that
1081 in our opinion won't ever trigger. */
1082 extern void breakpoint_retire_moribund (void);
1084 /* Set break condition of breakpoint B to EXP. */
1085 extern void set_breakpoint_condition (struct breakpoint
*b
, char *exp
,
1088 /* Checks if we are catching syscalls or not.
1089 Returns 0 if not, greater than 0 if we are. */
1090 extern int catch_syscall_enabled (void);
1092 /* Checks if we are catching syscalls with the specific
1093 syscall_number. Used for "filtering" the catchpoints.
1094 Returns 0 if not, greater than 0 if we are. */
1095 extern int catching_syscall_number (int syscall_number
);
1097 /* Tell a breakpoint to be quiet. */
1098 extern void make_breakpoint_silent (struct breakpoint
*);
1100 /* Return a tracepoint with the given number if found. */
1101 extern struct breakpoint
*get_tracepoint (int num
);
1103 extern struct breakpoint
*get_tracepoint_by_number_on_target (int num
);
1105 /* Find a tracepoint by parsing a number in the supplied string. */
1106 extern struct breakpoint
*get_tracepoint_by_number (char **arg
, int multi_p
,
1109 /* Return a vector of all tracepoints currently defined. The vector
1110 is newly allocated; the caller should free when done with it. */
1111 extern VEC(breakpoint_p
) *all_tracepoints (void);
1113 extern int is_tracepoint (const struct breakpoint
*b
);
1115 /* Return a vector of all static tracepoints defined at ADDR. The
1116 vector is newly allocated; the caller should free when done with
1118 extern VEC(breakpoint_p
) *static_tracepoints_here (CORE_ADDR addr
);
1120 /* Function that can be passed to read_command_line to validate
1121 that each command is suitable for tracepoint command list. */
1122 extern void check_tracepoint_command (char *line
, void *closure
);
1124 /* Call at the start and end of an "rbreak" command to register
1125 breakpoint numbers for a later "commands" command. */
1126 extern void start_rbreak_breakpoints (void);
1127 extern void end_rbreak_breakpoints (void);
1129 /* Breakpoint iterator function.
1131 Calls a callback function once for each breakpoint, so long as the
1132 callback function returns false. If the callback function returns
1133 true, the iteration will end and the current breakpoint will be
1134 returned. This can be useful for implementing a search for a
1135 breakpoint with arbitrary attributes, or for applying an operation
1136 to every breakpoint. */
1137 extern struct breakpoint
*iterate_over_breakpoints (int (*) (struct breakpoint
*,
1140 #endif /* !defined (BREAKPOINT_H) */