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, 2011
4 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #if !defined (BREAKPOINT_H)
22 #define BREAKPOINT_H 1
30 struct breakpoint_object;
31 struct get_number_or_range_state;
33 /* This is the maximum number of bytes a breakpoint instruction can
34 take. Feel free to increase it. It's just used in a few places to
35 size arrays that should be independent of the target
38 #define BREAKPOINT_MAX 16
41 /* Type of breakpoint. */
42 /* FIXME In the future, we should fold all other breakpoint-like
43 things into here. This includes:
45 * single-step (for machines where we have to simulate single
46 stepping) (probably, though perhaps it is better for it to look as
47 much as possible like a single-step to wait_for_inferior). */
51 bp_none = 0, /* Eventpoint has been deleted */
52 bp_breakpoint, /* Normal breakpoint */
53 bp_hardware_breakpoint, /* Hardware assisted breakpoint */
54 bp_until, /* used by until command */
55 bp_finish, /* used by finish command */
56 bp_watchpoint, /* Watchpoint */
57 bp_hardware_watchpoint, /* Hardware assisted watchpoint */
58 bp_read_watchpoint, /* read watchpoint, (hardware assisted) */
59 bp_access_watchpoint, /* access watchpoint, (hardware assisted) */
60 bp_longjmp, /* secret breakpoint to find longjmp() */
61 bp_longjmp_resume, /* secret breakpoint to escape longjmp() */
63 /* An internal breakpoint that is installed on the unwinder's
66 /* An internal breakpoint that is set at the point where an
67 exception will land. */
70 /* Used by wait_for_inferior for stepping over subroutine calls,
71 for stepping over signal handlers, and for skipping
75 /* Used to detect when a watchpoint expression has gone out of
76 scope. These breakpoints are usually not visible to the user.
78 This breakpoint has some interesting properties:
80 1) There's always a 1:1 mapping between watchpoints
81 on local variables and watchpoint_scope breakpoints.
83 2) It automatically deletes itself and the watchpoint it's
84 associated with when hit.
86 3) It can never be disabled. */
89 /* The breakpoint at the end of a call dummy. */
90 /* FIXME: What if the function we are calling longjmp()s out of
91 the call, or the user gets out with the "return" command? We
92 currently have no way of cleaning up the breakpoint in these
93 (obscure) situations. (Probably can solve this by noticing
94 longjmp, "return", etc., it's similar to noticing when a
95 watchpoint on a local variable goes out of scope (with hardware
96 support for watchpoints)). */
99 /* A breakpoint set on std::terminate, that is used to catch
100 otherwise uncaught exceptions thrown during an inferior call. */
103 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
104 code in the inferior to run when significant events occur in the
105 dynamic linker (for example a library is loaded or unloaded).
107 By placing a breakpoint in this magic code GDB will get control
108 when these significant events occur. GDB can then re-examine
109 the dynamic linker's data structures to discover any newly loaded
110 dynamic libraries. */
113 /* Some multi-threaded systems can arrange for a location in the
114 inferior to be executed when certain thread-related events occur
115 (such as thread creation or thread death).
117 By placing a breakpoint at one of these locations, GDB will get
118 control when these events occur. GDB can then update its thread
123 /* On the same principal, an overlay manager can arrange to call a
124 magic location in the inferior whenever there is an interesting
125 change in overlay status. GDB can update its overlay tables
126 and fiddle with breakpoints in overlays when this breakpoint
131 /* Master copies of longjmp breakpoints. These are always installed
132 as soon as an objfile containing longjmp is loaded, but they are
133 always disabled. While necessary, temporary clones of bp_longjmp
134 type will be created and enabled. */
138 /* Master copies of std::terminate breakpoints. */
139 bp_std_terminate_master,
141 /* Like bp_longjmp_master, but for exceptions. */
148 bp_static_tracepoint,
150 /* Event for JIT compiled code generation or deletion. */
153 /* Breakpoint is placed at the STT_GNU_IFUNC resolver. When hit GDB
154 inserts new bp_gnu_ifunc_resolver_return at the caller.
155 bp_gnu_ifunc_resolver is still being kept here as a different thread
156 may still hit it before bp_gnu_ifunc_resolver_return is hit by the
158 bp_gnu_ifunc_resolver,
160 /* On its hit GDB now know the resolved address of the target
161 STT_GNU_IFUNC function. Associated bp_gnu_ifunc_resolver can be
162 deleted now and the breakpoint moved to the target function entry
164 bp_gnu_ifunc_resolver_return,
167 /* States of enablement of breakpoint. */
171 bp_disabled, /* The eventpoint is inactive, and cannot
173 bp_enabled, /* The eventpoint is active, and can
175 bp_call_disabled, /* The eventpoint has been disabled while a
176 call into the inferior is "in flight",
177 because some eventpoints interfere with
178 the implementation of a call on some
179 targets. The eventpoint will be
180 automatically enabled and reset when the
181 call "lands" (either completes, or stops
182 at another eventpoint). */
183 bp_startup_disabled, /* The eventpoint has been disabled during
184 inferior startup. This is necessary on
185 some targets where the main executable
186 will get relocated during startup, making
187 breakpoint addresses invalid. The
188 eventpoint will be automatically enabled
189 and reset once inferior startup is
191 bp_permanent /* There is a breakpoint instruction
192 hard-wired into the target's code. Don't
193 try to write another breakpoint
194 instruction on top of it, or restore its
195 value. Step over it using the
196 architecture's SKIP_INSN macro. */
200 /* Disposition of breakpoint. Ie: what to do after hitting it. */
204 disp_del, /* Delete it */
205 disp_del_at_next_stop, /* Delete at next stop,
206 whether hit or not */
207 disp_disable, /* Disable it */
208 disp_donttouch /* Leave it alone */
211 enum target_hw_bp_type
213 hw_write = 0, /* Common HW watchpoint */
214 hw_read = 1, /* Read HW watchpoint */
215 hw_access = 2, /* Access HW watchpoint */
216 hw_execute = 3 /* Execute HW breakpoint */
220 /* Information used by targets to insert and remove breakpoints. */
222 struct bp_target_info
224 /* Address space at which the breakpoint was placed. */
225 struct address_space *placed_address_space;
227 /* Address at which the breakpoint was placed. This is normally the
228 same as ADDRESS from the bp_location, except when adjustment
229 happens in gdbarch_breakpoint_from_pc. The most common form of
230 adjustment is stripping an alternate ISA marker from the PC which
231 is used to determine the type of breakpoint to insert. */
232 CORE_ADDR placed_address;
234 /* If this is a ranged breakpoint, then this field contains the
235 length of the range that will be watched for execution. */
238 /* If the breakpoint lives in memory and reading that memory would
239 give back the breakpoint, instead of the original contents, then
240 the original contents are cached here. Only SHADOW_LEN bytes of
241 this buffer are valid, and only when the breakpoint is inserted. */
242 gdb_byte shadow_contents[BREAKPOINT_MAX];
244 /* The length of the data cached in SHADOW_CONTENTS. */
247 /* The size of the placed breakpoint, according to
248 gdbarch_breakpoint_from_pc, when the breakpoint was inserted.
249 This is generally the same as SHADOW_LEN, unless we did not need
250 to read from the target to implement the memory breakpoint
251 (e.g. if a remote stub handled the details). We may still need
252 the size to remove the breakpoint safely. */
256 /* GDB maintains two types of information about each breakpoint (or
257 watchpoint, or other related event). The first type corresponds
258 to struct breakpoint; this is a relatively high-level structure
259 which contains the source location(s), stopping conditions, user
260 commands to execute when the breakpoint is hit, and so forth.
262 The second type of information corresponds to struct bp_location.
263 Each breakpoint has one or (eventually) more locations associated
264 with it, which represent target-specific and machine-specific
265 mechanisms for stopping the program. For instance, a watchpoint
266 expression may require multiple hardware watchpoints in order to
267 catch all changes in the value of the expression being watched. */
271 bp_loc_software_breakpoint,
272 bp_loc_hardware_breakpoint,
273 bp_loc_hardware_watchpoint,
274 bp_loc_other /* Miscellaneous... */
279 /* Chain pointer to the next breakpoint location for
280 the same parent breakpoint. */
281 struct bp_location *next;
283 /* The reference count. */
286 /* Type of this breakpoint location. */
287 enum bp_loc_type loc_type;
289 /* Each breakpoint location must belong to exactly one higher-level
290 breakpoint. This pointer is NULL iff this bp_location is no
291 longer attached to a breakpoint. For example, when a breakpoint
292 is deleted, its locations may still be found in the
293 moribund_locations list, or if we had stopped for it, in
295 struct breakpoint *owner;
297 /* Conditional. Break only if this expression's value is nonzero.
298 Unlike string form of condition, which is associated with
299 breakpoint, this is associated with location, since if breakpoint
300 has several locations, the evaluation of expression can be
301 different for different locations. Only valid for real
302 breakpoints; a watchpoint's conditional expression is stored in
303 the owner breakpoint object. */
304 struct expression *cond;
306 /* This location's address is in an unloaded solib, and so this
307 location should not be inserted. It will be automatically
308 enabled when that solib is loaded. */
311 /* Is this particular location enabled. */
314 /* Nonzero if this breakpoint is now inserted. */
317 /* Nonzero if this is not the first breakpoint in the list
318 for the given address. */
321 /* If we someday support real thread-specific breakpoints, then
322 the breakpoint location will need a thread identifier. */
324 /* Data for specific breakpoint types. These could be a union, but
325 simplicity is more important than memory usage for breakpoints. */
327 /* Architecture associated with this location's address. May be
328 different from the breakpoint architecture. */
329 struct gdbarch *gdbarch;
331 /* The program space associated with this breakpoint location
332 address. Note that an address space may be represented in more
333 than one program space (e.g. each uClinux program will be given
334 its own program space, but there will only be one address space
335 for all of them), but we must not insert more than one location
336 at the same address in the same address space. */
337 struct program_space *pspace;
339 /* Note that zero is a perfectly valid code address on some platforms
340 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
341 is not a special value for this field. Valid for all types except
345 /* For hardware watchpoints, the size of the memory region being
346 watched. For hardware ranged breakpoints, the size of the
350 /* Type of hardware watchpoint. */
351 enum target_hw_bp_type watchpoint_type;
353 /* For any breakpoint type with an address, this is the section
354 associated with the address. Used primarily for overlay
356 struct obj_section *section;
358 /* Address at which breakpoint was requested, either by the user or
359 by GDB for internal breakpoints. This will usually be the same
360 as ``address'' (above) except for cases in which
361 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
362 which to place the breakpoint in order to comply with a
363 processor's architectual constraints. */
364 CORE_ADDR requested_address;
368 /* Details of the placed breakpoint, when inserted. */
369 struct bp_target_info target_info;
371 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
372 struct bp_target_info overlay_target_info;
374 /* In a non-stop mode, it's possible that we delete a breakpoint,
375 but as we do that, some still running thread hits that breakpoint.
376 For that reason, we need to keep locations belonging to deleted
377 breakpoints for a bit, so that don't report unexpected SIGTRAP.
378 We can't keep such locations forever, so we use a heuristic --
379 after we process certain number of inferior events since
380 breakpoint was deleted, we retire all locations of that breakpoint.
381 This variable keeps a number of events still to go, when
382 it becomes 0 this location is retired. */
383 int events_till_retirement;
386 /* This structure is a collection of function pointers that, if available,
387 will be called instead of the performing the default action for this
390 struct breakpoint_ops
392 /* Insert the breakpoint or watchpoint or activate the catchpoint.
393 Return 0 for success, 1 if the breakpoint, watchpoint or catchpoint
394 type is not supported, -1 for failure. */
395 int (*insert_location) (struct bp_location *);
397 /* Remove the breakpoint/catchpoint that was previously inserted
398 with the "insert" method above. Return 0 for success, 1 if the
399 breakpoint, watchpoint or catchpoint type is not supported,
401 int (*remove_location) (struct bp_location *);
403 /* Return non-zero if the debugger should tell the user that this
404 breakpoint was hit. */
405 int (*breakpoint_hit) (const struct bp_location *, struct address_space *,
408 /* Tell how many hardware resources (debug registers) are needed
409 for this breakpoint. If this function is not provided, then
410 the breakpoint or watchpoint needs one debug register. */
411 int (*resources_needed) (const struct bp_location *);
413 /* Tell whether we can downgrade from a hardware watchpoint to a software
414 one. If not, the user will not be able to enable the watchpoint when
415 there are not enough hardware resources available. */
416 int (*works_in_software_mode) (const struct breakpoint *);
418 /* The normal print routine for this breakpoint, called when we
420 enum print_stop_action (*print_it) (struct breakpoint *);
422 /* Display information about this breakpoint, for "info
424 void (*print_one) (struct breakpoint *, struct bp_location **);
426 /* Display extra information about this breakpoint, below the normal
427 breakpoint description in "info breakpoints".
429 In the example below, the "address range" line was printed
430 by print_one_detail_ranged_breakpoint.
432 (gdb) info breakpoints
433 Num Type Disp Enb Address What
434 2 hw breakpoint keep y in main at test-watch.c:70
435 address range: [0x10000458, 0x100004c7]
438 void (*print_one_detail) (const struct breakpoint *, struct ui_out *);
440 /* Display information about this breakpoint after setting it
441 (roughly speaking; this is called from "mention"). */
442 void (*print_mention) (struct breakpoint *);
444 /* Print to FP the CLI command that recreates this breakpoint. */
445 void (*print_recreate) (struct breakpoint *, struct ui_file *fp);
448 enum watchpoint_triggered
450 /* This watchpoint definitely did not trigger. */
451 watch_triggered_no = 0,
453 /* Some hardware watchpoint triggered, and it might have been this
454 one, but we do not know which it was. */
455 watch_triggered_unknown,
457 /* This hardware watchpoint definitely did trigger. */
461 /* This is used to declare the VEC syscalls_to_be_caught. */
464 typedef struct bp_location *bp_location_p;
465 DEF_VEC_P(bp_location_p);
467 /* A reference-counted struct command_line. This lets multiple
468 breakpoints share a single command list. This is an implementation
469 detail to the breakpoints module. */
470 struct counted_command_line;
472 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
473 a watchpoint over a memory region. If this flag is true, GDB will use
474 only one register per watchpoint, thus assuming that all acesses that
475 modify a memory location happen at its starting address. */
477 extern int target_exact_watchpoints;
479 /* Note that the ->silent field is not currently used by any commands
480 (though the code is in there if it was to be, and set_raw_breakpoint
481 does set it to 0). I implemented it because I thought it would be
482 useful for a hack I had to put in; I'm going to leave it in because
483 I can see how there might be times when it would indeed be useful */
485 /* This is for a breakpoint or a watchpoint. */
489 struct breakpoint *next;
490 /* Type of breakpoint. */
492 /* Zero means disabled; remember the info but don't break here. */
493 enum enable_state enable_state;
494 /* What to do with this breakpoint after we hit it. */
495 enum bpdisp disposition;
496 /* Number assigned to distinguish breakpoints. */
499 /* Location(s) associated with this high-level breakpoint. */
500 struct bp_location *loc;
502 /* Line number of this address. */
506 /* Source file name of this address. */
510 /* Non-zero means a silent breakpoint (don't print frame info
512 unsigned char silent;
513 /* Non-zero means display ADDR_STRING to the user verbatim. */
514 unsigned char display_canonical;
515 /* Number of stops at this breakpoint that should
516 be continued automatically before really stopping. */
518 /* Chain of command lines to execute when this breakpoint is
520 struct counted_command_line *commands;
521 /* Stack depth (address of frame). If nonzero, break only if fp
523 struct frame_id frame_id;
525 /* The program space used to set the breakpoint. */
526 struct program_space *pspace;
528 /* String we used to set the breakpoint (malloc'd). */
531 /* For a ranged breakpoint, the string we used to find
532 the end of the range (malloc'd). */
533 char *addr_string_range_end;
535 /* Architecture we used to set the breakpoint. */
536 struct gdbarch *gdbarch;
537 /* Language we used to set the breakpoint. */
538 enum language language;
539 /* Input radix we used to set the breakpoint. */
541 /* String form of the breakpoint condition (malloc'd), or NULL if
542 there is no condition. */
544 /* String form of exp to use for displaying to the user
545 (malloc'd), or NULL if none. */
547 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
548 char *exp_string_reparse;
550 /* The expression we are watching, or NULL if not a watchpoint. */
551 struct expression *exp;
552 /* The largest block within which it is valid, or NULL if it is
553 valid anywhere (e.g. consists just of global symbols). */
554 struct block *exp_valid_block;
555 /* The conditional expression if any. NULL if not a watchpoint. */
556 struct expression *cond_exp;
557 /* The largest block within which it is valid, or NULL if it is
558 valid anywhere (e.g. consists just of global symbols). */
559 struct block *cond_exp_valid_block;
560 /* Value of the watchpoint the last time we checked it, or NULL
561 when we do not know the value yet or the value was not
562 readable. VAL is never lazy. */
564 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
565 then an error occurred reading the value. */
568 /* Holds the address of the related watchpoint_scope breakpoint
569 when using watchpoints on local variables (might the concept of
570 a related breakpoint be useful elsewhere, if not just call it
571 the watchpoint_scope breakpoint or something like that.
573 struct breakpoint *related_breakpoint;
575 /* Holds the frame address which identifies the frame this
576 watchpoint should be evaluated in, or `null' if the watchpoint
577 should be evaluated on the outermost frame. */
578 struct frame_id watchpoint_frame;
580 /* Holds the thread which identifies the frame this watchpoint
581 should be considered in scope for, or `null_ptid' if the
582 watchpoint should be evaluated in all threads. */
583 ptid_t watchpoint_thread;
585 /* For hardware watchpoints, the triggered status according to the
587 enum watchpoint_triggered watchpoint_triggered;
589 /* Thread number for thread-specific breakpoint,
590 or -1 if don't care. */
593 /* Ada task number for task-specific breakpoint,
594 or 0 if don't care. */
597 /* Count of the number of times this breakpoint was taken, dumped
598 with the info, but not used for anything else. Useful for
599 seeing how many times you hit a break prior to the program
600 aborting, so you can back up to just before the abort. */
603 /* Process id of a child process whose forking triggered this
604 catchpoint. This field is only valid immediately after this
605 catchpoint has triggered. */
606 ptid_t forked_inferior_pid;
608 /* Filename of a program whose exec triggered this catchpoint.
609 This field is only valid immediately after this catchpoint has
613 /* Syscall numbers used for the 'catch syscall' feature. If no
614 syscall has been specified for filtering, its value is NULL.
615 Otherwise, it holds a list of all syscalls to be caught. The
616 list elements are allocated with xmalloc. */
617 VEC(int) *syscalls_to_be_caught;
619 /* Methods associated with this breakpoint. */
620 struct breakpoint_ops *ops;
622 /* Is breakpoint's condition not yet parsed because we found
623 no location initially so had no context to parse
625 int condition_not_parsed;
627 /* Number of times this tracepoint should single-step
628 and collect additional data. */
631 /* Number of times this tracepoint should be hit before
635 /* The number of the tracepoint on the target. */
636 int number_on_target;
638 /* The static tracepoint marker id, if known. */
639 char *static_trace_marker_id;
641 /* LTTng/UST allow more than one marker with the same ID string,
642 although it unadvised because it confuses tools. When setting
643 static tracepoints by marker ID, this will record the index in
644 the array of markers we found for the given marker ID for which
645 this static tracepoint corresponds. When resetting
646 breakpoints, we will use this index to try to find the same
648 int static_trace_marker_id_idx;
650 /* With a Python scripting enabled GDB, store a reference to the
651 Python object that has been associated with this breakpoint.
652 This is always NULL for a GDB that is not script enabled. It
653 can sometimes be NULL for enabled GDBs as not all breakpoint
654 types are tracked by the Python scripting API. */
655 struct breakpoint_object *py_bp_object;
657 /* Whether this watchpoint is exact (see target_exact_watchpoints). */
660 /* The mask address for a masked hardware watchpoint. */
661 CORE_ADDR hw_wp_mask;
664 typedef struct breakpoint *breakpoint_p;
665 DEF_VEC_P(breakpoint_p);
667 /* The following stuff is an abstract data type "bpstat" ("breakpoint
668 status"). This provides the ability to determine whether we have
669 stopped at a breakpoint, and what we should do about it. */
671 typedef struct bpstats *bpstat;
673 /* Clears a chain of bpstat, freeing storage
675 extern void bpstat_clear (bpstat *);
677 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
678 is part of the bpstat is copied as well. */
679 extern bpstat bpstat_copy (bpstat);
681 extern bpstat bpstat_stop_status (struct address_space *aspace,
682 CORE_ADDR pc, ptid_t ptid);
684 /* This bpstat_what stuff tells wait_for_inferior what to do with a
685 breakpoint (a challenging task).
687 The enum values order defines priority-like order of the actions.
688 Once you've decided that some action is appropriate, you'll never
689 go back and decide something of a lower priority is better. Each
690 of these actions is mutually exclusive with the others. That
691 means, that if you find yourself adding a new action class here and
692 wanting to tell GDB that you have two simultaneous actions to
693 handle, something is wrong, and you probably don't actually need a
696 Note that a step resume breakpoint overrides another breakpoint of
697 signal handling (see comment in wait_for_inferior at where we set
698 the step_resume breakpoint). */
700 enum bpstat_what_main_action
702 /* Perform various other tests; that is, this bpstat does not
703 say to perform any action (e.g. failed watchpoint and nothing
705 BPSTAT_WHAT_KEEP_CHECKING,
707 /* Remove breakpoints, single step once, then put them back in and
708 go back to what we were doing. It's possible that this should
709 be removed from the main_action and put into a separate field,
710 to more cleanly handle
711 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
714 /* Set longjmp_resume breakpoint, remove all other breakpoints,
715 and continue. The "remove all other breakpoints" part is
716 required if we are also stepping over another breakpoint as
717 well as doing the longjmp handling. */
718 BPSTAT_WHAT_SET_LONGJMP_RESUME,
720 /* Clear longjmp_resume breakpoint, then handle as
721 BPSTAT_WHAT_KEEP_CHECKING. */
722 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
724 /* Rather than distinguish between noisy and silent stops here, it
725 might be cleaner to have bpstat_print make that decision (also
726 taking into account stop_print_frame and source_only). But the
727 implications are a bit scary (interaction with auto-displays,
728 etc.), so I won't try it. */
731 BPSTAT_WHAT_STOP_SILENT,
733 /* Stop and print. */
734 BPSTAT_WHAT_STOP_NOISY,
736 /* Clear step resume breakpoint, and keep checking. */
737 BPSTAT_WHAT_STEP_RESUME,
740 /* An enum indicating the kind of "stack dummy" stop. This is a bit
741 of a misnomer because only one kind of truly a stack dummy. */
744 /* We didn't stop at a stack dummy breakpoint. */
747 /* Stopped at a stack dummy. */
750 /* Stopped at std::terminate. */
756 enum bpstat_what_main_action main_action;
758 /* Did we hit a call dummy breakpoint? This only goes with a
759 main_action of BPSTAT_WHAT_STOP_SILENT or
760 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
761 dummy without popping the frame is not a useful one). */
762 enum stop_stack_kind call_dummy;
764 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
765 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
766 longjmp, false if we are handling an exception. */
770 /* The possible return values for print_bpstat, print_it_normal,
771 print_it_done, print_it_noop. */
772 enum print_stop_action
780 /* Tell what to do about this bpstat. */
781 struct bpstat_what bpstat_what (bpstat);
783 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
784 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
786 /* Nonzero if a signal that we got in wait() was due to circumstances
787 explained by the BS. */
788 /* Currently that is true if we have hit a breakpoint, or if there is
789 a watchpoint enabled. */
790 #define bpstat_explains_signal(bs) ((bs) != NULL)
792 /* Nonzero is this bpstat causes a stop. */
793 extern int bpstat_causes_stop (bpstat);
795 /* Nonzero if we should step constantly (e.g. watchpoints on machines
796 without hardware support). This isn't related to a specific bpstat,
797 just to things like whether watchpoints are set. */
798 extern int bpstat_should_step (void);
800 /* Print a message indicating what happened. Returns nonzero to
801 say that only the source line should be printed after this (zero
802 return means print the frame as well as the source line). */
803 extern enum print_stop_action bpstat_print (bpstat);
805 /* Put in *NUM the breakpoint number of the first breakpoint we are
806 stopped at. *BSP upon return is a bpstat which points to the
807 remaining breakpoints stopped at (but which is not guaranteed to be
808 good for anything but further calls to bpstat_num).
810 Return 0 if passed a bpstat which does not indicate any breakpoints.
811 Return -1 if stopped at a breakpoint that has been deleted since
813 Return 1 otherwise. */
814 extern int bpstat_num (bpstat *, int *);
816 /* Perform actions associated with the stopped inferior. Actually, we
817 just use this for breakpoint commands. Perhaps other actions will
818 go here later, but this is executed at a late time (from the
820 extern void bpstat_do_actions (void);
822 /* Modify BS so that the actions will not be performed. */
823 extern void bpstat_clear_actions (bpstat);
825 /* Implementation: */
827 /* Values used to tell the printing routine how to behave for this
831 /* This is used when we want to do a normal printing of the reason
832 for stopping. The output will depend on the type of eventpoint
833 we are dealing with. This is the default value, most commonly
836 /* This is used when nothing should be printed for this bpstat
839 /* This is used when everything which needs to be printed has
840 already been printed. But we still want to print the frame. */
846 /* Linked list because there can be more than one breakpoint at
847 the same place, and a bpstat reflects the fact that all have
851 /* Location that caused the stop. Locations are refcounted, so
852 this will never be NULL. Note that this location may end up
853 detached from a breakpoint, but that does not necessary mean
854 that the struct breakpoint is gone. E.g., consider a
855 watchpoint with a condition that involves an inferior function
856 call. Watchpoint locations are recreated often (on resumes,
857 hence on infcalls too). Between creating the bpstat and after
858 evaluating the watchpoint condition, this location may hence
859 end up detached from its original owner watchpoint, even though
860 the watchpoint is still listed. If it's condition evaluates as
861 true, we still want this location to cause a stop, and we will
862 still need to know which watchpoint it was originally attached.
863 What this means is that we should not (in most cases) follow
864 the `bpstat->bp_location->owner' link, but instead use the
865 `breakpoint_at' field below. */
866 struct bp_location *bp_location_at;
868 /* Breakpoint that caused the stop. This is nullified if the
869 breakpoint ends up being deleted. See comments on
870 `bp_location_at' above for why do we need this field instead of
871 following the location's owner. */
872 struct breakpoint *breakpoint_at;
874 /* The associated command list. */
875 struct counted_command_line *commands;
877 /* Commands left to be done. This points somewhere in
879 struct command_line *commands_left;
881 /* Old value associated with a watchpoint. */
882 struct value *old_val;
884 /* Nonzero if this breakpoint tells us to print the frame. */
887 /* Nonzero if this breakpoint tells us to stop. */
890 /* Tell bpstat_print and print_bp_stop_message how to print stuff
891 associated with this element of the bpstat chain. */
892 enum bp_print_how print_it;
903 /* The possible return values for breakpoint_here_p.
904 We guarantee that zero always means "no breakpoint here". */
907 no_breakpoint_here = 0,
908 ordinary_breakpoint_here,
909 permanent_breakpoint_here
913 /* Prototypes for breakpoint-related functions. */
915 extern enum breakpoint_here breakpoint_here_p (struct address_space *,
918 extern int moribund_breakpoint_here_p (struct address_space *, CORE_ADDR);
920 extern int breakpoint_inserted_here_p (struct address_space *, CORE_ADDR);
922 extern int regular_breakpoint_inserted_here_p (struct address_space *,
925 extern int software_breakpoint_inserted_here_p (struct address_space *,
928 /* Returns true if there's a hardware watchpoint or access watchpoint
929 inserted in the range defined by ADDR and LEN. */
930 extern int hardware_watchpoint_inserted_in_range (struct address_space *,
934 extern int breakpoint_thread_match (struct address_space *,
937 extern void until_break_command (char *, int, int);
939 extern void update_breakpoint_locations (struct breakpoint *b,
940 struct symtabs_and_lines sals,
941 struct symtabs_and_lines sals_end);
943 extern void breakpoint_re_set (void);
945 extern void breakpoint_re_set_thread (struct breakpoint *);
947 extern struct breakpoint *set_momentary_breakpoint
948 (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype);
950 extern struct breakpoint *set_momentary_breakpoint_at_pc
951 (struct gdbarch *, CORE_ADDR pc, enum bptype type);
953 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt);
955 extern void set_ignore_count (int, int, int);
957 extern void set_default_breakpoint (int, struct program_space *,
958 CORE_ADDR, struct symtab *, int);
960 extern void breakpoint_init_inferior (enum inf_context);
962 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
964 extern void delete_breakpoint (struct breakpoint *);
966 extern void breakpoint_auto_delete (bpstat);
968 /* Return the chain of command lines to execute when this breakpoint
970 extern struct command_line *breakpoint_commands (struct breakpoint *b);
972 /* Return a string image of DISP. The string is static, and thus should
973 NOT be deallocated after use. */
974 const char *bpdisp_text (enum bpdisp disp);
976 extern void break_command (char *, int);
978 extern void hbreak_command_wrapper (char *, int);
979 extern void thbreak_command_wrapper (char *, int);
980 extern void rbreak_command_wrapper (char *, int);
981 extern void watch_command_wrapper (char *, int, int);
982 extern void awatch_command_wrapper (char *, int, int);
983 extern void rwatch_command_wrapper (char *, int, int);
984 extern void tbreak_command (char *, int);
986 extern int create_breakpoint (struct gdbarch *gdbarch, char *arg,
987 char *cond_string, int thread,
988 int parse_condition_and_thread,
989 int tempflag, enum bptype wanted_type,
991 enum auto_boolean pending_break_support,
992 struct breakpoint_ops *ops,
997 extern void insert_breakpoints (void);
999 extern int remove_breakpoints (void);
1001 extern int remove_breakpoints_pid (int pid);
1003 /* This function can be used to physically insert eventpoints from the
1004 specified traced inferior process, without modifying the breakpoint
1005 package's state. This can be useful for those targets which
1006 support following the processes of a fork() or vfork() system call,
1007 when both of the resulting two processes are to be followed. */
1008 extern int reattach_breakpoints (int);
1010 /* This function can be used to update the breakpoint package's state
1011 after an exec() system call has been executed.
1013 This function causes the following:
1015 - All eventpoints are marked "not inserted".
1016 - All eventpoints with a symbolic address are reset such that
1017 the symbolic address must be reevaluated before the eventpoints
1019 - The solib breakpoints are explicitly removed from the breakpoint
1021 - A step-resume breakpoint, if any, is explicitly removed from the
1023 - All eventpoints without a symbolic address are removed from the
1025 extern void update_breakpoints_after_exec (void);
1027 /* This function can be used to physically remove hardware breakpoints
1028 and watchpoints from the specified traced inferior process, without
1029 modifying the breakpoint package's state. This can be useful for
1030 those targets which support following the processes of a fork() or
1031 vfork() system call, when one of the resulting two processes is to
1032 be detached and allowed to run free.
1034 It is an error to use this function on the process whose id is
1036 extern int detach_breakpoints (int);
1038 /* This function is called when program space PSPACE is about to be
1039 deleted. It takes care of updating breakpoints to not reference
1040 this PSPACE anymore. */
1041 extern void breakpoint_program_space_exit (struct program_space *pspace);
1043 extern void set_longjmp_breakpoint (struct thread_info *tp,
1044 struct frame_id frame);
1045 extern void delete_longjmp_breakpoint (int thread);
1047 extern void enable_overlay_breakpoints (void);
1048 extern void disable_overlay_breakpoints (void);
1050 extern void set_std_terminate_breakpoint (void);
1051 extern void delete_std_terminate_breakpoint (void);
1053 /* These functions respectively disable or reenable all currently
1054 enabled watchpoints. When disabled, the watchpoints are marked
1055 call_disabled. When reenabled, they are marked enabled.
1057 The intended client of these functions is call_function_by_hand.
1059 The inferior must be stopped, and all breakpoints removed, when
1060 these functions are used.
1062 The need for these functions is that on some targets (e.g., HP-UX),
1063 gdb is unable to unwind through the dummy frame that is pushed as
1064 part of the implementation of a call command. Watchpoints can
1065 cause the inferior to stop in places where this frame is visible,
1066 and that can cause execution control to become very confused.
1068 Note that if a user sets breakpoints in an interactively called
1069 function, the call_disabled watchpoints will have been reenabled
1070 when the first such breakpoint is reached. However, on targets
1071 that are unable to unwind through the call dummy frame, watches
1072 of stack-based storage may then be deleted, because gdb will
1073 believe that their watched storage is out of scope. (Sigh.) */
1074 extern void disable_watchpoints_before_interactive_call_start (void);
1076 extern void enable_watchpoints_after_interactive_call_stop (void);
1078 /* These functions disable and re-enable all breakpoints during
1079 inferior startup. They are intended to be called from solib
1080 code where necessary. This is needed on platforms where the
1081 main executable is relocated at some point during startup
1082 processing, making breakpoint addresses invalid.
1084 If additional breakpoints are created after the routine
1085 disable_breakpoints_before_startup but before the routine
1086 enable_breakpoints_after_startup was called, they will also
1087 be marked as disabled. */
1088 extern void disable_breakpoints_before_startup (void);
1089 extern void enable_breakpoints_after_startup (void);
1091 /* For script interpreters that need to define breakpoint commands
1092 after they've already read the commands into a struct
1094 extern enum command_control_type commands_from_control_command
1095 (char *arg, struct command_line *cmd);
1097 extern void clear_breakpoint_hit_counts (void);
1099 extern struct breakpoint *get_breakpoint (int num);
1101 /* The following are for displays, which aren't really breakpoints,
1102 but here is as good a place as any for them. */
1104 extern void disable_current_display (void);
1106 extern void do_displays (void);
1108 extern void disable_display (int);
1110 extern void clear_displays (void);
1112 extern void disable_breakpoint (struct breakpoint *);
1114 extern void enable_breakpoint (struct breakpoint *);
1116 extern void breakpoint_set_commands (struct breakpoint *b,
1117 struct command_line *commands);
1119 extern void breakpoint_set_silent (struct breakpoint *b, int silent);
1121 extern void breakpoint_set_thread (struct breakpoint *b, int thread);
1123 extern void breakpoint_set_task (struct breakpoint *b, int task);
1125 /* Clear the "inserted" flag in all breakpoints. */
1126 extern void mark_breakpoints_out (void);
1128 extern void make_breakpoint_permanent (struct breakpoint *);
1130 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *,
1133 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *,
1136 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *,
1139 extern void remove_jit_event_breakpoints (void);
1141 extern void remove_solib_event_breakpoints (void);
1143 extern void remove_thread_event_breakpoints (void);
1145 extern void disable_breakpoints_in_shlibs (void);
1147 /* This function returns TRUE if ep is a catchpoint. */
1148 extern int ep_is_catchpoint (struct breakpoint *);
1150 /* Enable breakpoints and delete when hit. Called with ARG == NULL
1151 deletes all breakpoints. */
1152 extern void delete_command (char *arg, int from_tty);
1154 /* Pull all H/W watchpoints from the target. Return non-zero if the
1156 extern int remove_hw_watchpoints (void);
1158 /* Manage a software single step breakpoint (or two). Insert may be
1159 called twice before remove is called. */
1160 extern void insert_single_step_breakpoint (struct gdbarch *,
1161 struct address_space *,
1163 extern int single_step_breakpoints_inserted (void);
1164 extern void remove_single_step_breakpoints (void);
1165 extern void cancel_single_step_breakpoints (void);
1167 /* Manage manual breakpoints, separate from the normal chain of
1168 breakpoints. These functions are used in murky target-specific
1169 ways. Please do not add more uses! */
1170 extern void *deprecated_insert_raw_breakpoint (struct gdbarch *,
1171 struct address_space *,
1173 extern int deprecated_remove_raw_breakpoint (struct gdbarch *, void *);
1175 /* Check if any hardware watchpoints have triggered, according to the
1177 int watchpoints_triggered (struct target_waitstatus *);
1179 /* Update BUF, which is LEN bytes read from the target address MEMADDR,
1180 by replacing any memory breakpoints with their shadowed contents. */
1181 void breakpoint_restore_shadows (gdb_byte *buf, ULONGEST memaddr,
1184 extern int breakpoints_always_inserted_mode (void);
1186 /* Called each time new event from target is processed.
1187 Retires previously deleted breakpoint locations that
1188 in our opinion won't ever trigger. */
1189 extern void breakpoint_retire_moribund (void);
1191 /* Set break condition of breakpoint B to EXP. */
1192 extern void set_breakpoint_condition (struct breakpoint *b, char *exp,
1195 /* Checks if we are catching syscalls or not.
1196 Returns 0 if not, greater than 0 if we are. */
1197 extern int catch_syscall_enabled (void);
1199 /* Checks if we are catching syscalls with the specific
1200 syscall_number. Used for "filtering" the catchpoints.
1201 Returns 0 if not, greater than 0 if we are. */
1202 extern int catching_syscall_number (int syscall_number);
1204 /* Return a tracepoint with the given number if found. */
1205 extern struct breakpoint *get_tracepoint (int num);
1207 extern struct breakpoint *get_tracepoint_by_number_on_target (int num);
1209 /* Find a tracepoint by parsing a number in the supplied string. */
1210 extern struct breakpoint *
1211 get_tracepoint_by_number (char **arg,
1212 struct get_number_or_range_state *state,
1215 /* Return a vector of all tracepoints currently defined. The vector
1216 is newly allocated; the caller should free when done with it. */
1217 extern VEC(breakpoint_p) *all_tracepoints (void);
1219 extern int is_tracepoint (const struct breakpoint *b);
1221 /* Return a vector of all static tracepoints defined at ADDR. The
1222 vector is newly allocated; the caller should free when done with
1224 extern VEC(breakpoint_p) *static_tracepoints_here (CORE_ADDR addr);
1226 /* Function that can be passed to read_command_line to validate
1227 that each command is suitable for tracepoint command list. */
1228 extern void check_tracepoint_command (char *line, void *closure);
1230 /* Call at the start and end of an "rbreak" command to register
1231 breakpoint numbers for a later "commands" command. */
1232 extern void start_rbreak_breakpoints (void);
1233 extern void end_rbreak_breakpoints (void);
1235 /* Breakpoint iterator function.
1237 Calls a callback function once for each breakpoint, so long as the
1238 callback function returns false. If the callback function returns
1239 true, the iteration will end and the current breakpoint will be
1240 returned. This can be useful for implementing a search for a
1241 breakpoint with arbitrary attributes, or for applying an operation
1242 to every breakpoint. */
1243 extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *,
1246 extern int user_breakpoint_p (struct breakpoint *);
1248 #endif /* !defined (BREAKPOINT_H) */