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 the breakpoint lives in memory and reading that memory would
235 give back the breakpoint, instead of the original contents, then
236 the original contents are cached here. Only SHADOW_LEN bytes of
237 this buffer are valid, and only when the breakpoint is inserted. */
238 gdb_byte shadow_contents[BREAKPOINT_MAX];
240 /* The length of the data cached in SHADOW_CONTENTS. */
243 /* The size of the placed breakpoint, according to
244 gdbarch_breakpoint_from_pc, when the breakpoint was inserted.
245 This is generally the same as SHADOW_LEN, unless we did not need
246 to read from the target to implement the memory breakpoint
247 (e.g. if a remote stub handled the details). We may still need
248 the size to remove the breakpoint safely. */
252 /* GDB maintains two types of information about each breakpoint (or
253 watchpoint, or other related event). The first type corresponds
254 to struct breakpoint; this is a relatively high-level structure
255 which contains the source location(s), stopping conditions, user
256 commands to execute when the breakpoint is hit, and so forth.
258 The second type of information corresponds to struct bp_location.
259 Each breakpoint has one or (eventually) more locations associated
260 with it, which represent target-specific and machine-specific
261 mechanisms for stopping the program. For instance, a watchpoint
262 expression may require multiple hardware watchpoints in order to
263 catch all changes in the value of the expression being watched. */
267 bp_loc_software_breakpoint,
268 bp_loc_hardware_breakpoint,
269 bp_loc_hardware_watchpoint,
270 bp_loc_other /* Miscellaneous... */
275 /* Chain pointer to the next breakpoint location for
276 the same parent breakpoint. */
277 struct bp_location *next;
279 /* The reference count. */
282 /* Type of this breakpoint location. */
283 enum bp_loc_type loc_type;
285 /* Each breakpoint location must belong to exactly one higher-level
286 breakpoint. This pointer is NULL iff this bp_location is no
287 longer attached to a breakpoint. For example, when a breakpoint
288 is deleted, its locations may still be found in the
289 moribund_locations list, or if we had stopped for it, in
291 struct breakpoint *owner;
293 /* Conditional. Break only if this expression's value is nonzero.
294 Unlike string form of condition, which is associated with
295 breakpoint, this is associated with location, since if breakpoint
296 has several locations, the evaluation of expression can be
297 different for different locations. Only valid for real
298 breakpoints; a watchpoint's conditional expression is stored in
299 the owner breakpoint object. */
300 struct expression *cond;
302 /* This location's address is in an unloaded solib, and so this
303 location should not be inserted. It will be automatically
304 enabled when that solib is loaded. */
307 /* Is this particular location enabled. */
310 /* Nonzero if this breakpoint is now inserted. */
313 /* Nonzero if this is not the first breakpoint in the list
314 for the given address. */
317 /* If we someday support real thread-specific breakpoints, then
318 the breakpoint location will need a thread identifier. */
320 /* Data for specific breakpoint types. These could be a union, but
321 simplicity is more important than memory usage for breakpoints. */
323 /* Architecture associated with this location's address. May be
324 different from the breakpoint architecture. */
325 struct gdbarch *gdbarch;
327 /* The program space associated with this breakpoint location
328 address. Note that an address space may be represented in more
329 than one program space (e.g. each uClinux program will be given
330 its own program space, but there will only be one address space
331 for all of them), but we must not insert more than one location
332 at the same address in the same address space. */
333 struct program_space *pspace;
335 /* Note that zero is a perfectly valid code address on some platforms
336 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
337 is not a special value for this field. Valid for all types except
341 /* For hardware watchpoints, the size of the memory region being
345 /* Type of hardware watchpoint. */
346 enum target_hw_bp_type watchpoint_type;
348 /* For any breakpoint type with an address, this is the section
349 associated with the address. Used primarily for overlay
351 struct obj_section *section;
353 /* Address at which breakpoint was requested, either by the user or
354 by GDB for internal breakpoints. This will usually be the same
355 as ``address'' (above) except for cases in which
356 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
357 which to place the breakpoint in order to comply with a
358 processor's architectual constraints. */
359 CORE_ADDR requested_address;
363 /* Details of the placed breakpoint, when inserted. */
364 struct bp_target_info target_info;
366 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
367 struct bp_target_info overlay_target_info;
369 /* In a non-stop mode, it's possible that we delete a breakpoint,
370 but as we do that, some still running thread hits that breakpoint.
371 For that reason, we need to keep locations belonging to deleted
372 breakpoints for a bit, so that don't report unexpected SIGTRAP.
373 We can't keep such locations forever, so we use a heuristic --
374 after we process certain number of inferior events since
375 breakpoint was deleted, we retire all locations of that breakpoint.
376 This variable keeps a number of events still to go, when
377 it becomes 0 this location is retired. */
378 int events_till_retirement;
381 /* This structure is a collection of function pointers that, if available,
382 will be called instead of the performing the default action for this
385 struct breakpoint_ops
387 /* Insert the breakpoint or watchpoint or activate the catchpoint.
388 Return 0 for success, 1 if the breakpoint, watchpoint or catchpoint
389 type is not supported, -1 for failure. */
390 int (*insert_location) (struct bp_location *);
392 /* Remove the breakpoint/catchpoint that was previously inserted
393 with the "insert" method above. Return 0 for success, 1 if the
394 breakpoint, watchpoint or catchpoint type is not supported,
396 int (*remove_location) (struct bp_location *);
398 /* Return non-zero if the debugger should tell the user that this
399 breakpoint was hit. */
400 int (*breakpoint_hit) (struct breakpoint *);
402 /* Tell how many hardware resources (debug registers) are needed
403 for this breakpoint. If this function is not provided, then
404 the breakpoint or watchpoint needs one debug register. */
405 int (*resources_needed) (const struct bp_location *);
407 /* The normal print routine for this breakpoint, called when we
409 enum print_stop_action (*print_it) (struct breakpoint *);
411 /* Display information about this breakpoint, for "info
413 void (*print_one) (struct breakpoint *, struct bp_location **);
415 /* Display information about this breakpoint after setting it
416 (roughly speaking; this is called from "mention"). */
417 void (*print_mention) (struct breakpoint *);
419 /* Print to FP the CLI command that recreates this breakpoint. */
420 void (*print_recreate) (struct breakpoint *, struct ui_file *fp);
423 enum watchpoint_triggered
425 /* This watchpoint definitely did not trigger. */
426 watch_triggered_no = 0,
428 /* Some hardware watchpoint triggered, and it might have been this
429 one, but we do not know which it was. */
430 watch_triggered_unknown,
432 /* This hardware watchpoint definitely did trigger. */
436 /* This is used to declare the VEC syscalls_to_be_caught. */
439 typedef struct bp_location *bp_location_p;
440 DEF_VEC_P(bp_location_p);
442 /* A reference-counted struct command_line. This lets multiple
443 breakpoints share a single command list. This is an implementation
444 detail to the breakpoints module. */
445 struct counted_command_line;
447 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
448 a watchpoint over a memory region. If this flag is true, GDB will use
449 only one register per watchpoint, thus assuming that all acesses that
450 modify a memory location happen at its starting address. */
452 extern int target_exact_watchpoints;
454 /* Note that the ->silent field is not currently used by any commands
455 (though the code is in there if it was to be, and set_raw_breakpoint
456 does set it to 0). I implemented it because I thought it would be
457 useful for a hack I had to put in; I'm going to leave it in because
458 I can see how there might be times when it would indeed be useful */
460 /* This is for a breakpoint or a watchpoint. */
464 struct breakpoint *next;
465 /* Type of breakpoint. */
467 /* Zero means disabled; remember the info but don't break here. */
468 enum enable_state enable_state;
469 /* What to do with this breakpoint after we hit it. */
470 enum bpdisp disposition;
471 /* Number assigned to distinguish breakpoints. */
474 /* Location(s) associated with this high-level breakpoint. */
475 struct bp_location *loc;
477 /* Line number of this address. */
481 /* Source file name of this address. */
485 /* Non-zero means a silent breakpoint (don't print frame info
487 unsigned char silent;
488 /* Non-zero means display ADDR_STRING to the user verbatim. */
489 unsigned char display_canonical;
490 /* Number of stops at this breakpoint that should
491 be continued automatically before really stopping. */
493 /* Chain of command lines to execute when this breakpoint is
495 struct counted_command_line *commands;
496 /* Stack depth (address of frame). If nonzero, break only if fp
498 struct frame_id frame_id;
500 /* The program space used to set the breakpoint. */
501 struct program_space *pspace;
503 /* String we used to set the breakpoint (malloc'd). */
505 /* Architecture we used to set the breakpoint. */
506 struct gdbarch *gdbarch;
507 /* Language we used to set the breakpoint. */
508 enum language language;
509 /* Input radix we used to set the breakpoint. */
511 /* String form of the breakpoint condition (malloc'd), or NULL if
512 there is no condition. */
514 /* String form of exp to use for displaying to the user
515 (malloc'd), or NULL if none. */
517 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
518 char *exp_string_reparse;
520 /* The expression we are watching, or NULL if not a watchpoint. */
521 struct expression *exp;
522 /* The largest block within which it is valid, or NULL if it is
523 valid anywhere (e.g. consists just of global symbols). */
524 struct block *exp_valid_block;
525 /* The conditional expression if any. NULL if not a watchpoint. */
526 struct expression *cond_exp;
527 /* The largest block within which it is valid, or NULL if it is
528 valid anywhere (e.g. consists just of global symbols). */
529 struct block *cond_exp_valid_block;
530 /* Value of the watchpoint the last time we checked it, or NULL
531 when we do not know the value yet or the value was not
532 readable. VAL is never lazy. */
534 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
535 then an error occurred reading the value. */
538 /* Holds the address of the related watchpoint_scope breakpoint
539 when using watchpoints on local variables (might the concept of
540 a related breakpoint be useful elsewhere, if not just call it
541 the watchpoint_scope breakpoint or something like that.
543 struct breakpoint *related_breakpoint;
545 /* Holds the frame address which identifies the frame this
546 watchpoint should be evaluated in, or `null' if the watchpoint
547 should be evaluated on the outermost frame. */
548 struct frame_id watchpoint_frame;
550 /* Holds the thread which identifies the frame this watchpoint
551 should be considered in scope for, or `null_ptid' if the
552 watchpoint should be evaluated in all threads. */
553 ptid_t watchpoint_thread;
555 /* For hardware watchpoints, the triggered status according to the
557 enum watchpoint_triggered watchpoint_triggered;
559 /* Thread number for thread-specific breakpoint,
560 or -1 if don't care. */
563 /* Ada task number for task-specific breakpoint,
564 or 0 if don't care. */
567 /* Count of the number of times this breakpoint was taken, dumped
568 with the info, but not used for anything else. Useful for
569 seeing how many times you hit a break prior to the program
570 aborting, so you can back up to just before the abort. */
573 /* Process id of a child process whose forking triggered this
574 catchpoint. This field is only valid immediately after this
575 catchpoint has triggered. */
576 ptid_t forked_inferior_pid;
578 /* Filename of a program whose exec triggered this catchpoint.
579 This field is only valid immediately after this catchpoint has
583 /* Syscall numbers used for the 'catch syscall' feature. If no
584 syscall has been specified for filtering, its value is NULL.
585 Otherwise, it holds a list of all syscalls to be caught. The
586 list elements are allocated with xmalloc. */
587 VEC(int) *syscalls_to_be_caught;
589 /* Methods associated with this breakpoint. */
590 struct breakpoint_ops *ops;
592 /* Is breakpoint's condition not yet parsed because we found
593 no location initially so had no context to parse
595 int condition_not_parsed;
597 /* Number of times this tracepoint should single-step
598 and collect additional data. */
601 /* Number of times this tracepoint should be hit before
605 /* The number of the tracepoint on the target. */
606 int number_on_target;
608 /* The static tracepoint marker id, if known. */
609 char *static_trace_marker_id;
611 /* LTTng/UST allow more than one marker with the same ID string,
612 although it unadvised because it confuses tools. When setting
613 static tracepoints by marker ID, this will record the index in
614 the array of markers we found for the given marker ID for which
615 this static tracepoint corresponds. When resetting
616 breakpoints, we will use this index to try to find the same
618 int static_trace_marker_id_idx;
620 /* With a Python scripting enabled GDB, store a reference to the
621 Python object that has been associated with this breakpoint.
622 This is always NULL for a GDB that is not script enabled. It
623 can sometimes be NULL for enabled GDBs as not all breakpoint
624 types are tracked by the Python scripting API. */
625 struct breakpoint_object *py_bp_object;
627 /* Whether this watchpoint is exact (see target_exact_watchpoints). */
631 typedef struct breakpoint *breakpoint_p;
632 DEF_VEC_P(breakpoint_p);
634 /* The following stuff is an abstract data type "bpstat" ("breakpoint
635 status"). This provides the ability to determine whether we have
636 stopped at a breakpoint, and what we should do about it. */
638 typedef struct bpstats *bpstat;
640 /* Clears a chain of bpstat, freeing storage
642 extern void bpstat_clear (bpstat *);
644 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
645 is part of the bpstat is copied as well. */
646 extern bpstat bpstat_copy (bpstat);
648 extern bpstat bpstat_stop_status (struct address_space *aspace,
649 CORE_ADDR pc, ptid_t ptid);
651 /* This bpstat_what stuff tells wait_for_inferior what to do with a
652 breakpoint (a challenging task).
654 The enum values order defines priority-like order of the actions.
655 Once you've decided that some action is appropriate, you'll never
656 go back and decide something of a lower priority is better. Each
657 of these actions is mutually exclusive with the others. That
658 means, that if you find yourself adding a new action class here and
659 wanting to tell GDB that you have two simultaneous actions to
660 handle, something is wrong, and you probably don't actually need a
663 Note that a step resume breakpoint overrides another breakpoint of
664 signal handling (see comment in wait_for_inferior at where we set
665 the step_resume breakpoint). */
667 enum bpstat_what_main_action
669 /* Perform various other tests; that is, this bpstat does not
670 say to perform any action (e.g. failed watchpoint and nothing
672 BPSTAT_WHAT_KEEP_CHECKING,
674 /* Remove breakpoints, single step once, then put them back in and
675 go back to what we were doing. It's possible that this should
676 be removed from the main_action and put into a separate field,
677 to more cleanly handle
678 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
681 /* Set longjmp_resume breakpoint, remove all other breakpoints,
682 and continue. The "remove all other breakpoints" part is
683 required if we are also stepping over another breakpoint as
684 well as doing the longjmp handling. */
685 BPSTAT_WHAT_SET_LONGJMP_RESUME,
687 /* Clear longjmp_resume breakpoint, then handle as
688 BPSTAT_WHAT_KEEP_CHECKING. */
689 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
691 /* Rather than distinguish between noisy and silent stops here, it
692 might be cleaner to have bpstat_print make that decision (also
693 taking into account stop_print_frame and source_only). But the
694 implications are a bit scary (interaction with auto-displays,
695 etc.), so I won't try it. */
698 BPSTAT_WHAT_STOP_SILENT,
700 /* Stop and print. */
701 BPSTAT_WHAT_STOP_NOISY,
703 /* Clear step resume breakpoint, and keep checking. */
704 BPSTAT_WHAT_STEP_RESUME,
707 /* An enum indicating the kind of "stack dummy" stop. This is a bit
708 of a misnomer because only one kind of truly a stack dummy. */
711 /* We didn't stop at a stack dummy breakpoint. */
714 /* Stopped at a stack dummy. */
717 /* Stopped at std::terminate. */
723 enum bpstat_what_main_action main_action;
725 /* Did we hit a call dummy breakpoint? This only goes with a
726 main_action of BPSTAT_WHAT_STOP_SILENT or
727 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
728 dummy without popping the frame is not a useful one). */
729 enum stop_stack_kind call_dummy;
731 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
732 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
733 longjmp, false if we are handling an exception. */
737 /* The possible return values for print_bpstat, print_it_normal,
738 print_it_done, print_it_noop. */
739 enum print_stop_action
747 /* Tell what to do about this bpstat. */
748 struct bpstat_what bpstat_what (bpstat);
750 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
751 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
753 /* Nonzero if a signal that we got in wait() was due to circumstances
754 explained by the BS. */
755 /* Currently that is true if we have hit a breakpoint, or if there is
756 a watchpoint enabled. */
757 #define bpstat_explains_signal(bs) ((bs) != NULL)
759 /* Nonzero is this bpstat causes a stop. */
760 extern int bpstat_causes_stop (bpstat);
762 /* Nonzero if we should step constantly (e.g. watchpoints on machines
763 without hardware support). This isn't related to a specific bpstat,
764 just to things like whether watchpoints are set. */
765 extern int bpstat_should_step (void);
767 /* Print a message indicating what happened. Returns nonzero to
768 say that only the source line should be printed after this (zero
769 return means print the frame as well as the source line). */
770 extern enum print_stop_action bpstat_print (bpstat);
772 /* Put in *NUM the breakpoint number of the first breakpoint we are
773 stopped at. *BSP upon return is a bpstat which points to the
774 remaining breakpoints stopped at (but which is not guaranteed to be
775 good for anything but further calls to bpstat_num).
777 Return 0 if passed a bpstat which does not indicate any breakpoints.
778 Return -1 if stopped at a breakpoint that has been deleted since
780 Return 1 otherwise. */
781 extern int bpstat_num (bpstat *, int *);
783 /* Perform actions associated with the stopped inferior. Actually, we
784 just use this for breakpoint commands. Perhaps other actions will
785 go here later, but this is executed at a late time (from the
787 extern void bpstat_do_actions (void);
789 /* Modify BS so that the actions will not be performed. */
790 extern void bpstat_clear_actions (bpstat);
792 /* Implementation: */
794 /* Values used to tell the printing routine how to behave for this
798 /* This is used when we want to do a normal printing of the reason
799 for stopping. The output will depend on the type of eventpoint
800 we are dealing with. This is the default value, most commonly
803 /* This is used when nothing should be printed for this bpstat
806 /* This is used when everything which needs to be printed has
807 already been printed. But we still want to print the frame. */
813 /* Linked list because there can be more than one breakpoint at
814 the same place, and a bpstat reflects the fact that all have
818 /* Location that caused the stop. Locations are refcounted, so
819 this will never be NULL. Note that this location may end up
820 detached from a breakpoint, but that does not necessary mean
821 that the struct breakpoint is gone. E.g., consider a
822 watchpoint with a condition that involves an inferior function
823 call. Watchpoint locations are recreated often (on resumes,
824 hence on infcalls too). Between creating the bpstat and after
825 evaluating the watchpoint condition, this location may hence
826 end up detached from its original owner watchpoint, even though
827 the watchpoint is still listed. If it's condition evaluates as
828 true, we still want this location to cause a stop, and we will
829 still need to know which watchpoint it was originally attached.
830 What this means is that we should not (in most cases) follow
831 the `bpstat->bp_location->owner' link, but instead use the
832 `breakpoint_at' field below. */
833 struct bp_location *bp_location_at;
835 /* Breakpoint that caused the stop. This is nullified if the
836 breakpoint ends up being deleted. See comments on
837 `bp_location_at' above for why do we need this field instead of
838 following the location's owner. */
839 struct breakpoint *breakpoint_at;
841 /* The associated command list. */
842 struct counted_command_line *commands;
844 /* Commands left to be done. This points somewhere in
846 struct command_line *commands_left;
848 /* Old value associated with a watchpoint. */
849 struct value *old_val;
851 /* Nonzero if this breakpoint tells us to print the frame. */
854 /* Nonzero if this breakpoint tells us to stop. */
857 /* Tell bpstat_print and print_bp_stop_message how to print stuff
858 associated with this element of the bpstat chain. */
859 enum bp_print_how print_it;
870 /* The possible return values for breakpoint_here_p.
871 We guarantee that zero always means "no breakpoint here". */
874 no_breakpoint_here = 0,
875 ordinary_breakpoint_here,
876 permanent_breakpoint_here
880 /* Prototypes for breakpoint-related functions. */
882 extern enum breakpoint_here breakpoint_here_p (struct address_space *,
885 extern int moribund_breakpoint_here_p (struct address_space *, CORE_ADDR);
887 extern int breakpoint_inserted_here_p (struct address_space *, CORE_ADDR);
889 extern int regular_breakpoint_inserted_here_p (struct address_space *,
892 extern int software_breakpoint_inserted_here_p (struct address_space *,
895 /* Returns true if there's a hardware watchpoint or access watchpoint
896 inserted in the range defined by ADDR and LEN. */
897 extern int hardware_watchpoint_inserted_in_range (struct address_space *,
901 extern int breakpoint_thread_match (struct address_space *,
904 extern void until_break_command (char *, int, int);
906 extern void update_breakpoint_locations (struct breakpoint *b,
907 struct symtabs_and_lines sals);
909 extern void breakpoint_re_set (void);
911 extern void breakpoint_re_set_thread (struct breakpoint *);
913 extern struct breakpoint *set_momentary_breakpoint
914 (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype);
916 extern struct breakpoint *set_momentary_breakpoint_at_pc
917 (struct gdbarch *, CORE_ADDR pc, enum bptype type);
919 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt);
921 extern void set_ignore_count (int, int, int);
923 extern void set_default_breakpoint (int, struct program_space *,
924 CORE_ADDR, struct symtab *, int);
926 extern void breakpoint_init_inferior (enum inf_context);
928 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
930 extern void delete_breakpoint (struct breakpoint *);
932 extern void breakpoint_auto_delete (bpstat);
934 /* Return the chain of command lines to execute when this breakpoint
936 extern struct command_line *breakpoint_commands (struct breakpoint *b);
938 extern void break_command (char *, int);
940 extern void hbreak_command_wrapper (char *, int);
941 extern void thbreak_command_wrapper (char *, int);
942 extern void rbreak_command_wrapper (char *, int);
943 extern void watch_command_wrapper (char *, int, int);
944 extern void awatch_command_wrapper (char *, int, int);
945 extern void rwatch_command_wrapper (char *, int, int);
946 extern void tbreak_command (char *, int);
948 extern int create_breakpoint (struct gdbarch *gdbarch, char *arg,
949 char *cond_string, int thread,
950 int parse_condition_and_thread,
951 int tempflag, enum bptype wanted_type,
953 enum auto_boolean pending_break_support,
954 struct breakpoint_ops *ops,
959 extern void insert_breakpoints (void);
961 extern int remove_breakpoints (void);
963 extern int remove_breakpoints_pid (int pid);
965 /* This function can be used to physically insert eventpoints from the
966 specified traced inferior process, without modifying the breakpoint
967 package's state. This can be useful for those targets which
968 support following the processes of a fork() or vfork() system call,
969 when both of the resulting two processes are to be followed. */
970 extern int reattach_breakpoints (int);
972 /* This function can be used to update the breakpoint package's state
973 after an exec() system call has been executed.
975 This function causes the following:
977 - All eventpoints are marked "not inserted".
978 - All eventpoints with a symbolic address are reset such that
979 the symbolic address must be reevaluated before the eventpoints
981 - The solib breakpoints are explicitly removed from the breakpoint
983 - A step-resume breakpoint, if any, is explicitly removed from the
985 - All eventpoints without a symbolic address are removed from the
987 extern void update_breakpoints_after_exec (void);
989 /* This function can be used to physically remove hardware breakpoints
990 and watchpoints from the specified traced inferior process, without
991 modifying the breakpoint package's state. This can be useful for
992 those targets which support following the processes of a fork() or
993 vfork() system call, when one of the resulting two processes is to
994 be detached and allowed to run free.
996 It is an error to use this function on the process whose id is
998 extern int detach_breakpoints (int);
1000 /* This function is called when program space PSPACE is about to be
1001 deleted. It takes care of updating breakpoints to not reference
1002 this PSPACE anymore. */
1003 extern void breakpoint_program_space_exit (struct program_space *pspace);
1005 extern void set_longjmp_breakpoint (struct thread_info *tp,
1006 struct frame_id frame);
1007 extern void delete_longjmp_breakpoint (int thread);
1009 extern void enable_overlay_breakpoints (void);
1010 extern void disable_overlay_breakpoints (void);
1012 extern void set_std_terminate_breakpoint (void);
1013 extern void delete_std_terminate_breakpoint (void);
1015 /* These functions respectively disable or reenable all currently
1016 enabled watchpoints. When disabled, the watchpoints are marked
1017 call_disabled. When reenabled, they are marked enabled.
1019 The intended client of these functions is call_function_by_hand.
1021 The inferior must be stopped, and all breakpoints removed, when
1022 these functions are used.
1024 The need for these functions is that on some targets (e.g., HP-UX),
1025 gdb is unable to unwind through the dummy frame that is pushed as
1026 part of the implementation of a call command. Watchpoints can
1027 cause the inferior to stop in places where this frame is visible,
1028 and that can cause execution control to become very confused.
1030 Note that if a user sets breakpoints in an interactively called
1031 function, the call_disabled watchpoints will have been reenabled
1032 when the first such breakpoint is reached. However, on targets
1033 that are unable to unwind through the call dummy frame, watches
1034 of stack-based storage may then be deleted, because gdb will
1035 believe that their watched storage is out of scope. (Sigh.) */
1036 extern void disable_watchpoints_before_interactive_call_start (void);
1038 extern void enable_watchpoints_after_interactive_call_stop (void);
1040 /* These functions disable and re-enable all breakpoints during
1041 inferior startup. They are intended to be called from solib
1042 code where necessary. This is needed on platforms where the
1043 main executable is relocated at some point during startup
1044 processing, making breakpoint addresses invalid.
1046 If additional breakpoints are created after the routine
1047 disable_breakpoints_before_startup but before the routine
1048 enable_breakpoints_after_startup was called, they will also
1049 be marked as disabled. */
1050 extern void disable_breakpoints_before_startup (void);
1051 extern void enable_breakpoints_after_startup (void);
1053 /* For script interpreters that need to define breakpoint commands
1054 after they've already read the commands into a struct
1056 extern enum command_control_type commands_from_control_command
1057 (char *arg, struct command_line *cmd);
1059 extern void clear_breakpoint_hit_counts (void);
1061 extern struct breakpoint *get_breakpoint (int num);
1063 /* The following are for displays, which aren't really breakpoints,
1064 but here is as good a place as any for them. */
1066 extern void disable_current_display (void);
1068 extern void do_displays (void);
1070 extern void disable_display (int);
1072 extern void clear_displays (void);
1074 extern void disable_breakpoint (struct breakpoint *);
1076 extern void enable_breakpoint (struct breakpoint *);
1078 extern void breakpoint_set_commands (struct breakpoint *b,
1079 struct command_line *commands);
1081 extern void breakpoint_set_silent (struct breakpoint *b, int silent);
1083 extern void breakpoint_set_thread (struct breakpoint *b, int thread);
1085 extern void breakpoint_set_task (struct breakpoint *b, int task);
1087 /* Clear the "inserted" flag in all breakpoints. */
1088 extern void mark_breakpoints_out (void);
1090 extern void make_breakpoint_permanent (struct breakpoint *);
1092 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *,
1095 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *,
1098 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *,
1101 extern void remove_jit_event_breakpoints (void);
1103 extern void remove_solib_event_breakpoints (void);
1105 extern void remove_thread_event_breakpoints (void);
1107 extern void disable_breakpoints_in_shlibs (void);
1109 /* This function returns TRUE if ep is a catchpoint. */
1110 extern int ep_is_catchpoint (struct breakpoint *);
1112 /* Enable breakpoints and delete when hit. Called with ARG == NULL
1113 deletes all breakpoints. */
1114 extern void delete_command (char *arg, int from_tty);
1116 /* Pull all H/W watchpoints from the target. Return non-zero if the
1118 extern int remove_hw_watchpoints (void);
1120 /* Manage a software single step breakpoint (or two). Insert may be
1121 called twice before remove is called. */
1122 extern void insert_single_step_breakpoint (struct gdbarch *,
1123 struct address_space *,
1125 extern int single_step_breakpoints_inserted (void);
1126 extern void remove_single_step_breakpoints (void);
1127 extern void cancel_single_step_breakpoints (void);
1129 /* Manage manual breakpoints, separate from the normal chain of
1130 breakpoints. These functions are used in murky target-specific
1131 ways. Please do not add more uses! */
1132 extern void *deprecated_insert_raw_breakpoint (struct gdbarch *,
1133 struct address_space *,
1135 extern int deprecated_remove_raw_breakpoint (struct gdbarch *, void *);
1137 /* Check if any hardware watchpoints have triggered, according to the
1139 int watchpoints_triggered (struct target_waitstatus *);
1141 /* Update BUF, which is LEN bytes read from the target address MEMADDR,
1142 by replacing any memory breakpoints with their shadowed contents. */
1143 void breakpoint_restore_shadows (gdb_byte *buf, ULONGEST memaddr,
1146 extern int breakpoints_always_inserted_mode (void);
1148 /* Called each time new event from target is processed.
1149 Retires previously deleted breakpoint locations that
1150 in our opinion won't ever trigger. */
1151 extern void breakpoint_retire_moribund (void);
1153 /* Set break condition of breakpoint B to EXP. */
1154 extern void set_breakpoint_condition (struct breakpoint *b, char *exp,
1157 /* Checks if we are catching syscalls or not.
1158 Returns 0 if not, greater than 0 if we are. */
1159 extern int catch_syscall_enabled (void);
1161 /* Checks if we are catching syscalls with the specific
1162 syscall_number. Used for "filtering" the catchpoints.
1163 Returns 0 if not, greater than 0 if we are. */
1164 extern int catching_syscall_number (int syscall_number);
1166 /* Return a tracepoint with the given number if found. */
1167 extern struct breakpoint *get_tracepoint (int num);
1169 extern struct breakpoint *get_tracepoint_by_number_on_target (int num);
1171 /* Find a tracepoint by parsing a number in the supplied string. */
1172 extern struct breakpoint *
1173 get_tracepoint_by_number (char **arg,
1174 struct get_number_or_range_state *state,
1177 /* Return a vector of all tracepoints currently defined. The vector
1178 is newly allocated; the caller should free when done with it. */
1179 extern VEC(breakpoint_p) *all_tracepoints (void);
1181 extern int is_tracepoint (const struct breakpoint *b);
1183 /* Return a vector of all static tracepoints defined at ADDR. The
1184 vector is newly allocated; the caller should free when done with
1186 extern VEC(breakpoint_p) *static_tracepoints_here (CORE_ADDR addr);
1188 /* Function that can be passed to read_command_line to validate
1189 that each command is suitable for tracepoint command list. */
1190 extern void check_tracepoint_command (char *line, void *closure);
1192 /* Call at the start and end of an "rbreak" command to register
1193 breakpoint numbers for a later "commands" command. */
1194 extern void start_rbreak_breakpoints (void);
1195 extern void end_rbreak_breakpoints (void);
1197 /* Breakpoint iterator function.
1199 Calls a callback function once for each breakpoint, so long as the
1200 callback function returns false. If the callback function returns
1201 true, the iteration will end and the current breakpoint will be
1202 returned. This can be useful for implementing a search for a
1203 breakpoint with arbitrary attributes, or for applying an operation
1204 to every breakpoint. */
1205 extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *,
1208 extern int user_breakpoint_p (struct breakpoint *);
1210 #endif /* !defined (BREAKPOINT_H) */