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;
34 /* This is the maximum number of bytes a breakpoint instruction can
35 take. Feel free to increase it. It's just used in a few places to
36 size arrays that should be independent of the target
39 #define BREAKPOINT_MAX 16
42 /* Type of breakpoint. */
43 /* FIXME In the future, we should fold all other breakpoint-like
44 things into here. This includes:
46 * single-step (for machines where we have to simulate single
47 stepping) (probably, though perhaps it is better for it to look as
48 much as possible like a single-step to wait_for_inferior). */
52 bp_none = 0, /* Eventpoint has been deleted */
53 bp_breakpoint, /* Normal breakpoint */
54 bp_hardware_breakpoint, /* Hardware assisted breakpoint */
55 bp_until, /* used by until command */
56 bp_finish, /* used by finish command */
57 bp_watchpoint, /* Watchpoint */
58 bp_hardware_watchpoint, /* Hardware assisted watchpoint */
59 bp_read_watchpoint, /* read watchpoint, (hardware assisted) */
60 bp_access_watchpoint, /* access watchpoint, (hardware assisted) */
61 bp_longjmp, /* secret breakpoint to find longjmp() */
62 bp_longjmp_resume, /* secret breakpoint to escape longjmp() */
64 /* An internal breakpoint that is installed on the unwinder's
67 /* An internal breakpoint that is set at the point where an
68 exception will land. */
71 /* Used by wait_for_inferior for stepping over subroutine calls,
72 and for skipping prologues. */
75 /* Used by wait_for_inferior for stepping over signal
79 /* Used to detect when a watchpoint expression has gone out of
80 scope. These breakpoints are usually not visible to the user.
82 This breakpoint has some interesting properties:
84 1) There's always a 1:1 mapping between watchpoints
85 on local variables and watchpoint_scope breakpoints.
87 2) It automatically deletes itself and the watchpoint it's
88 associated with when hit.
90 3) It can never be disabled. */
93 /* The breakpoint at the end of a call dummy. */
94 /* FIXME: What if the function we are calling longjmp()s out of
95 the call, or the user gets out with the "return" command? We
96 currently have no way of cleaning up the breakpoint in these
97 (obscure) situations. (Probably can solve this by noticing
98 longjmp, "return", etc., it's similar to noticing when a
99 watchpoint on a local variable goes out of scope (with hardware
100 support for watchpoints)). */
103 /* A breakpoint set on std::terminate, that is used to catch
104 otherwise uncaught exceptions thrown during an inferior call. */
107 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
108 code in the inferior to run when significant events occur in the
109 dynamic linker (for example a library is loaded or unloaded).
111 By placing a breakpoint in this magic code GDB will get control
112 when these significant events occur. GDB can then re-examine
113 the dynamic linker's data structures to discover any newly loaded
114 dynamic libraries. */
117 /* Some multi-threaded systems can arrange for a location in the
118 inferior to be executed when certain thread-related events occur
119 (such as thread creation or thread death).
121 By placing a breakpoint at one of these locations, GDB will get
122 control when these events occur. GDB can then update its thread
127 /* On the same principal, an overlay manager can arrange to call a
128 magic location in the inferior whenever there is an interesting
129 change in overlay status. GDB can update its overlay tables
130 and fiddle with breakpoints in overlays when this breakpoint
135 /* Master copies of longjmp breakpoints. These are always installed
136 as soon as an objfile containing longjmp is loaded, but they are
137 always disabled. While necessary, temporary clones of bp_longjmp
138 type will be created and enabled. */
142 /* Master copies of std::terminate breakpoints. */
143 bp_std_terminate_master,
145 /* Like bp_longjmp_master, but for exceptions. */
152 bp_static_tracepoint,
154 /* Event for JIT compiled code generation or deletion. */
157 /* Breakpoint is placed at the STT_GNU_IFUNC resolver. When hit GDB
158 inserts new bp_gnu_ifunc_resolver_return at the caller.
159 bp_gnu_ifunc_resolver is still being kept here as a different thread
160 may still hit it before bp_gnu_ifunc_resolver_return is hit by the
162 bp_gnu_ifunc_resolver,
164 /* On its hit GDB now know the resolved address of the target
165 STT_GNU_IFUNC function. Associated bp_gnu_ifunc_resolver can be
166 deleted now and the breakpoint moved to the target function entry
168 bp_gnu_ifunc_resolver_return,
171 /* States of enablement of breakpoint. */
175 bp_disabled, /* The eventpoint is inactive, and cannot
177 bp_enabled, /* The eventpoint is active, and can
179 bp_call_disabled, /* The eventpoint has been disabled while a
180 call into the inferior is "in flight",
181 because some eventpoints interfere with
182 the implementation of a call on some
183 targets. The eventpoint will be
184 automatically enabled and reset when the
185 call "lands" (either completes, or stops
186 at another eventpoint). */
187 bp_startup_disabled, /* The eventpoint has been disabled during
188 inferior startup. This is necessary on
189 some targets where the main executable
190 will get relocated during startup, making
191 breakpoint addresses invalid. The
192 eventpoint will be automatically enabled
193 and reset once inferior startup is
195 bp_permanent /* There is a breakpoint instruction
196 hard-wired into the target's code. Don't
197 try to write another breakpoint
198 instruction on top of it, or restore its
199 value. Step over it using the
200 architecture's SKIP_INSN macro. */
204 /* Disposition of breakpoint. Ie: what to do after hitting it. */
208 disp_del, /* Delete it */
209 disp_del_at_next_stop, /* Delete at next stop,
210 whether hit or not */
211 disp_disable, /* Disable it */
212 disp_donttouch /* Leave it alone */
215 enum target_hw_bp_type
217 hw_write = 0, /* Common HW watchpoint */
218 hw_read = 1, /* Read HW watchpoint */
219 hw_access = 2, /* Access HW watchpoint */
220 hw_execute = 3 /* Execute HW breakpoint */
224 /* Information used by targets to insert and remove breakpoints. */
226 struct bp_target_info
228 /* Address space at which the breakpoint was placed. */
229 struct address_space *placed_address_space;
231 /* Address at which the breakpoint was placed. This is normally the
232 same as ADDRESS from the bp_location, except when adjustment
233 happens in gdbarch_breakpoint_from_pc. The most common form of
234 adjustment is stripping an alternate ISA marker from the PC which
235 is used to determine the type of breakpoint to insert. */
236 CORE_ADDR placed_address;
238 /* If this is a ranged breakpoint, then this field contains the
239 length of the range that will be watched for execution. */
242 /* If the breakpoint lives in memory and reading that memory would
243 give back the breakpoint, instead of the original contents, then
244 the original contents are cached here. Only SHADOW_LEN bytes of
245 this buffer are valid, and only when the breakpoint is inserted. */
246 gdb_byte shadow_contents[BREAKPOINT_MAX];
248 /* The length of the data cached in SHADOW_CONTENTS. */
251 /* The size of the placed breakpoint, according to
252 gdbarch_breakpoint_from_pc, when the breakpoint was inserted.
253 This is generally the same as SHADOW_LEN, unless we did not need
254 to read from the target to implement the memory breakpoint
255 (e.g. if a remote stub handled the details). We may still need
256 the size to remove the breakpoint safely. */
260 /* GDB maintains two types of information about each breakpoint (or
261 watchpoint, or other related event). The first type corresponds
262 to struct breakpoint; this is a relatively high-level structure
263 which contains the source location(s), stopping conditions, user
264 commands to execute when the breakpoint is hit, and so forth.
266 The second type of information corresponds to struct bp_location.
267 Each breakpoint has one or (eventually) more locations associated
268 with it, which represent target-specific and machine-specific
269 mechanisms for stopping the program. For instance, a watchpoint
270 expression may require multiple hardware watchpoints in order to
271 catch all changes in the value of the expression being watched. */
275 bp_loc_software_breakpoint,
276 bp_loc_hardware_breakpoint,
277 bp_loc_hardware_watchpoint,
278 bp_loc_other /* Miscellaneous... */
283 /* Chain pointer to the next breakpoint location for
284 the same parent breakpoint. */
285 struct bp_location *next;
287 /* The reference count. */
290 /* Type of this breakpoint location. */
291 enum bp_loc_type loc_type;
293 /* Each breakpoint location must belong to exactly one higher-level
294 breakpoint. This pointer is NULL iff this bp_location is no
295 longer attached to a breakpoint. For example, when a breakpoint
296 is deleted, its locations may still be found in the
297 moribund_locations list, or if we had stopped for it, in
299 struct breakpoint *owner;
301 /* Conditional. Break only if this expression's value is nonzero.
302 Unlike string form of condition, which is associated with
303 breakpoint, this is associated with location, since if breakpoint
304 has several locations, the evaluation of expression can be
305 different for different locations. Only valid for real
306 breakpoints; a watchpoint's conditional expression is stored in
307 the owner breakpoint object. */
308 struct expression *cond;
310 /* This location's address is in an unloaded solib, and so this
311 location should not be inserted. It will be automatically
312 enabled when that solib is loaded. */
315 /* Is this particular location enabled. */
318 /* Nonzero if this breakpoint is now inserted. */
321 /* Nonzero if this is not the first breakpoint in the list
322 for the given address. */
325 /* If we someday support real thread-specific breakpoints, then
326 the breakpoint location will need a thread identifier. */
328 /* Data for specific breakpoint types. These could be a union, but
329 simplicity is more important than memory usage for breakpoints. */
331 /* Architecture associated with this location's address. May be
332 different from the breakpoint architecture. */
333 struct gdbarch *gdbarch;
335 /* The program space associated with this breakpoint location
336 address. Note that an address space may be represented in more
337 than one program space (e.g. each uClinux program will be given
338 its own program space, but there will only be one address space
339 for all of them), but we must not insert more than one location
340 at the same address in the same address space. */
341 struct program_space *pspace;
343 /* Note that zero is a perfectly valid code address on some platforms
344 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
345 is not a special value for this field. Valid for all types except
349 /* For hardware watchpoints, the size of the memory region being
350 watched. For hardware ranged breakpoints, the size of the
354 /* Type of hardware watchpoint. */
355 enum target_hw_bp_type watchpoint_type;
357 /* For any breakpoint type with an address, this is the section
358 associated with the address. Used primarily for overlay
360 struct obj_section *section;
362 /* Address at which breakpoint was requested, either by the user or
363 by GDB for internal breakpoints. This will usually be the same
364 as ``address'' (above) except for cases in which
365 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
366 which to place the breakpoint in order to comply with a
367 processor's architectual constraints. */
368 CORE_ADDR requested_address;
372 /* Details of the placed breakpoint, when inserted. */
373 struct bp_target_info target_info;
375 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
376 struct bp_target_info overlay_target_info;
378 /* In a non-stop mode, it's possible that we delete a breakpoint,
379 but as we do that, some still running thread hits that breakpoint.
380 For that reason, we need to keep locations belonging to deleted
381 breakpoints for a bit, so that don't report unexpected SIGTRAP.
382 We can't keep such locations forever, so we use a heuristic --
383 after we process certain number of inferior events since
384 breakpoint was deleted, we retire all locations of that breakpoint.
385 This variable keeps a number of events still to go, when
386 it becomes 0 this location is retired. */
387 int events_till_retirement;
390 /* This structure is a collection of function pointers that, if available,
391 will be called instead of the performing the default action for this
394 struct breakpoint_ops
396 /* Insert the breakpoint or watchpoint or activate the catchpoint.
397 Return 0 for success, 1 if the breakpoint, watchpoint or catchpoint
398 type is not supported, -1 for failure. */
399 int (*insert_location) (struct bp_location *);
401 /* Remove the breakpoint/catchpoint that was previously inserted
402 with the "insert" method above. Return 0 for success, 1 if the
403 breakpoint, watchpoint or catchpoint type is not supported,
405 int (*remove_location) (struct bp_location *);
407 /* Return non-zero if the debugger should tell the user that this
408 breakpoint was hit. */
409 int (*breakpoint_hit) (const struct bp_location *, struct address_space *,
412 /* Tell how many hardware resources (debug registers) are needed
413 for this breakpoint. If this function is not provided, then
414 the breakpoint or watchpoint needs one debug register. */
415 int (*resources_needed) (const struct bp_location *);
417 /* Tell whether we can downgrade from a hardware watchpoint to a software
418 one. If not, the user will not be able to enable the watchpoint when
419 there are not enough hardware resources available. */
420 int (*works_in_software_mode) (const struct breakpoint *);
422 /* The normal print routine for this breakpoint, called when we
424 enum print_stop_action (*print_it) (struct breakpoint *);
426 /* Display information about this breakpoint, for "info
428 void (*print_one) (struct breakpoint *, struct bp_location **);
430 /* Display extra information about this breakpoint, below the normal
431 breakpoint description in "info breakpoints".
433 In the example below, the "address range" line was printed
434 by print_one_detail_ranged_breakpoint.
436 (gdb) info breakpoints
437 Num Type Disp Enb Address What
438 2 hw breakpoint keep y in main at test-watch.c:70
439 address range: [0x10000458, 0x100004c7]
442 void (*print_one_detail) (const struct breakpoint *, struct ui_out *);
444 /* Display information about this breakpoint after setting it
445 (roughly speaking; this is called from "mention"). */
446 void (*print_mention) (struct breakpoint *);
448 /* Print to FP the CLI command that recreates this breakpoint. */
449 void (*print_recreate) (struct breakpoint *, struct ui_file *fp);
452 enum watchpoint_triggered
454 /* This watchpoint definitely did not trigger. */
455 watch_triggered_no = 0,
457 /* Some hardware watchpoint triggered, and it might have been this
458 one, but we do not know which it was. */
459 watch_triggered_unknown,
461 /* This hardware watchpoint definitely did trigger. */
465 /* This is used to declare the VEC syscalls_to_be_caught. */
468 typedef struct bp_location *bp_location_p;
469 DEF_VEC_P(bp_location_p);
471 /* A reference-counted struct command_line. This lets multiple
472 breakpoints share a single command list. This is an implementation
473 detail to the breakpoints module. */
474 struct counted_command_line;
476 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
477 a watchpoint over a memory region. If this flag is true, GDB will use
478 only one register per watchpoint, thus assuming that all acesses that
479 modify a memory location happen at its starting address. */
481 extern int target_exact_watchpoints;
483 /* Note that the ->silent field is not currently used by any commands
484 (though the code is in there if it was to be, and set_raw_breakpoint
485 does set it to 0). I implemented it because I thought it would be
486 useful for a hack I had to put in; I'm going to leave it in because
487 I can see how there might be times when it would indeed be useful */
489 /* This is for a breakpoint or a watchpoint. */
493 struct breakpoint *next;
494 /* Type of breakpoint. */
496 /* Zero means disabled; remember the info but don't break here. */
497 enum enable_state enable_state;
498 /* What to do with this breakpoint after we hit it. */
499 enum bpdisp disposition;
500 /* Number assigned to distinguish breakpoints. */
503 /* Location(s) associated with this high-level breakpoint. */
504 struct bp_location *loc;
506 /* Line number of this address. */
510 /* Source file name of this address. */
514 /* Non-zero means a silent breakpoint (don't print frame info
516 unsigned char silent;
517 /* Non-zero means display ADDR_STRING to the user verbatim. */
518 unsigned char display_canonical;
519 /* Number of stops at this breakpoint that should
520 be continued automatically before really stopping. */
522 /* Chain of command lines to execute when this breakpoint is
524 struct counted_command_line *commands;
525 /* Stack depth (address of frame). If nonzero, break only if fp
527 struct frame_id frame_id;
529 /* The program space used to set the breakpoint. */
530 struct program_space *pspace;
532 /* String we used to set the breakpoint (malloc'd). */
535 /* For a ranged breakpoint, the string we used to find
536 the end of the range (malloc'd). */
537 char *addr_string_range_end;
539 /* Architecture we used to set the breakpoint. */
540 struct gdbarch *gdbarch;
541 /* Language we used to set the breakpoint. */
542 enum language language;
543 /* Input radix we used to set the breakpoint. */
545 /* String form of the breakpoint condition (malloc'd), or NULL if
546 there is no condition. */
548 /* String form of exp to use for displaying to the user
549 (malloc'd), or NULL if none. */
551 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
552 char *exp_string_reparse;
554 /* The expression we are watching, or NULL if not a watchpoint. */
555 struct expression *exp;
556 /* The largest block within which it is valid, or NULL if it is
557 valid anywhere (e.g. consists just of global symbols). */
558 struct block *exp_valid_block;
559 /* The conditional expression if any. NULL if not a watchpoint. */
560 struct expression *cond_exp;
561 /* The largest block within which it is valid, or NULL if it is
562 valid anywhere (e.g. consists just of global symbols). */
563 struct block *cond_exp_valid_block;
564 /* Value of the watchpoint the last time we checked it, or NULL
565 when we do not know the value yet or the value was not
566 readable. VAL is never lazy. */
568 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
569 then an error occurred reading the value. */
572 /* Holds the address of the related watchpoint_scope breakpoint
573 when using watchpoints on local variables (might the concept of
574 a related breakpoint be useful elsewhere, if not just call it
575 the watchpoint_scope breakpoint or something like that.
577 struct breakpoint *related_breakpoint;
579 /* Holds the frame address which identifies the frame this
580 watchpoint should be evaluated in, or `null' if the watchpoint
581 should be evaluated on the outermost frame. */
582 struct frame_id watchpoint_frame;
584 /* Holds the thread which identifies the frame this watchpoint
585 should be considered in scope for, or `null_ptid' if the
586 watchpoint should be evaluated in all threads. */
587 ptid_t watchpoint_thread;
589 /* For hardware watchpoints, the triggered status according to the
591 enum watchpoint_triggered watchpoint_triggered;
593 /* Thread number for thread-specific breakpoint,
594 or -1 if don't care. */
597 /* Ada task number for task-specific breakpoint,
598 or 0 if don't care. */
601 /* Count of the number of times this breakpoint was taken, dumped
602 with the info, but not used for anything else. Useful for
603 seeing how many times you hit a break prior to the program
604 aborting, so you can back up to just before the abort. */
607 /* Process id of a child process whose forking triggered this
608 catchpoint. This field is only valid immediately after this
609 catchpoint has triggered. */
610 ptid_t forked_inferior_pid;
612 /* Filename of a program whose exec triggered this catchpoint.
613 This field is only valid immediately after this catchpoint has
617 /* Syscall numbers used for the 'catch syscall' feature. If no
618 syscall has been specified for filtering, its value is NULL.
619 Otherwise, it holds a list of all syscalls to be caught. The
620 list elements are allocated with xmalloc. */
621 VEC(int) *syscalls_to_be_caught;
623 /* Methods associated with this breakpoint. */
624 struct breakpoint_ops *ops;
626 /* Is breakpoint's condition not yet parsed because we found
627 no location initially so had no context to parse
629 int condition_not_parsed;
631 /* Number of times this tracepoint should single-step
632 and collect additional data. */
635 /* Number of times this tracepoint should be hit before
639 /* The number of the tracepoint on the target. */
640 int number_on_target;
642 /* The static tracepoint marker id, if known. */
643 char *static_trace_marker_id;
645 /* LTTng/UST allow more than one marker with the same ID string,
646 although it unadvised because it confuses tools. When setting
647 static tracepoints by marker ID, this will record the index in
648 the array of markers we found for the given marker ID for which
649 this static tracepoint corresponds. When resetting
650 breakpoints, we will use this index to try to find the same
652 int static_trace_marker_id_idx;
654 /* With a Python scripting enabled GDB, store a reference to the
655 Python object that has been associated with this breakpoint.
656 This is always NULL for a GDB that is not script enabled. It
657 can sometimes be NULL for enabled GDBs as not all breakpoint
658 types are tracked by the Python scripting API. */
659 struct breakpoint_object *py_bp_object;
661 /* Whether this watchpoint is exact (see target_exact_watchpoints). */
664 /* The mask address for a masked hardware watchpoint. */
665 CORE_ADDR hw_wp_mask;
668 typedef struct breakpoint *breakpoint_p;
669 DEF_VEC_P(breakpoint_p);
671 /* The following stuff is an abstract data type "bpstat" ("breakpoint
672 status"). This provides the ability to determine whether we have
673 stopped at a breakpoint, and what we should do about it. */
675 typedef struct bpstats *bpstat;
677 /* Clears a chain of bpstat, freeing storage
679 extern void bpstat_clear (bpstat *);
681 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
682 is part of the bpstat is copied as well. */
683 extern bpstat bpstat_copy (bpstat);
685 extern bpstat bpstat_stop_status (struct address_space *aspace,
686 CORE_ADDR pc, ptid_t ptid);
688 /* This bpstat_what stuff tells wait_for_inferior what to do with a
689 breakpoint (a challenging task).
691 The enum values order defines priority-like order of the actions.
692 Once you've decided that some action is appropriate, you'll never
693 go back and decide something of a lower priority is better. Each
694 of these actions is mutually exclusive with the others. That
695 means, that if you find yourself adding a new action class here and
696 wanting to tell GDB that you have two simultaneous actions to
697 handle, something is wrong, and you probably don't actually need a
700 Note that a step resume breakpoint overrides another breakpoint of
701 signal handling (see comment in wait_for_inferior at where we set
702 the step_resume breakpoint). */
704 enum bpstat_what_main_action
706 /* Perform various other tests; that is, this bpstat does not
707 say to perform any action (e.g. failed watchpoint and nothing
709 BPSTAT_WHAT_KEEP_CHECKING,
711 /* Remove breakpoints, single step once, then put them back in and
712 go back to what we were doing. It's possible that this should
713 be removed from the main_action and put into a separate field,
714 to more cleanly handle
715 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
718 /* Set longjmp_resume breakpoint, remove all other breakpoints,
719 and continue. The "remove all other breakpoints" part is
720 required if we are also stepping over another breakpoint as
721 well as doing the longjmp handling. */
722 BPSTAT_WHAT_SET_LONGJMP_RESUME,
724 /* Clear longjmp_resume breakpoint, then handle as
725 BPSTAT_WHAT_KEEP_CHECKING. */
726 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
728 /* Clear step resume breakpoint, and keep checking. */
729 BPSTAT_WHAT_STEP_RESUME,
731 /* Rather than distinguish between noisy and silent stops here, it
732 might be cleaner to have bpstat_print make that decision (also
733 taking into account stop_print_frame and source_only). But the
734 implications are a bit scary (interaction with auto-displays,
735 etc.), so I won't try it. */
738 BPSTAT_WHAT_STOP_SILENT,
740 /* Stop and print. */
741 BPSTAT_WHAT_STOP_NOISY,
743 /* Clear step resume breakpoint, and keep checking. High-priority
744 step-resume breakpoints are used when even if there's a user
745 breakpoint at the current PC when we set the step-resume
746 breakpoint, we don't want to re-handle any breakpoint other
747 than the step-resume when it's hit; instead we want to move
748 past the breakpoint. This is used in the case of skipping
750 BPSTAT_WHAT_HP_STEP_RESUME,
753 /* An enum indicating the kind of "stack dummy" stop. This is a bit
754 of a misnomer because only one kind of truly a stack dummy. */
757 /* We didn't stop at a stack dummy breakpoint. */
760 /* Stopped at a stack dummy. */
763 /* Stopped at std::terminate. */
769 enum bpstat_what_main_action main_action;
771 /* Did we hit a call dummy breakpoint? This only goes with a
772 main_action of BPSTAT_WHAT_STOP_SILENT or
773 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
774 dummy without popping the frame is not a useful one). */
775 enum stop_stack_kind call_dummy;
777 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
778 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
779 longjmp, false if we are handling an exception. */
783 /* The possible return values for print_bpstat, print_it_normal,
784 print_it_done, print_it_noop. */
785 enum print_stop_action
793 /* Tell what to do about this bpstat. */
794 struct bpstat_what bpstat_what (bpstat);
796 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
797 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
799 /* Nonzero if a signal that we got in wait() was due to circumstances
800 explained by the BS. */
801 /* Currently that is true if we have hit a breakpoint, or if there is
802 a watchpoint enabled. */
803 #define bpstat_explains_signal(bs) ((bs) != NULL)
805 /* Nonzero is this bpstat causes a stop. */
806 extern int bpstat_causes_stop (bpstat);
808 /* Nonzero if we should step constantly (e.g. watchpoints on machines
809 without hardware support). This isn't related to a specific bpstat,
810 just to things like whether watchpoints are set. */
811 extern int bpstat_should_step (void);
813 /* Print a message indicating what happened. Returns nonzero to
814 say that only the source line should be printed after this (zero
815 return means print the frame as well as the source line). */
816 extern enum print_stop_action bpstat_print (bpstat);
818 /* Put in *NUM the breakpoint number of the first breakpoint we are
819 stopped at. *BSP upon return is a bpstat which points to the
820 remaining breakpoints stopped at (but which is not guaranteed to be
821 good for anything but further calls to bpstat_num).
823 Return 0 if passed a bpstat which does not indicate any breakpoints.
824 Return -1 if stopped at a breakpoint that has been deleted since
826 Return 1 otherwise. */
827 extern int bpstat_num (bpstat *, int *);
829 /* Perform actions associated with the stopped inferior. Actually, we
830 just use this for breakpoint commands. Perhaps other actions will
831 go here later, but this is executed at a late time (from the
833 extern void bpstat_do_actions (void);
835 /* Modify BS so that the actions will not be performed. */
836 extern void bpstat_clear_actions (bpstat);
838 /* Implementation: */
840 /* Values used to tell the printing routine how to behave for this
844 /* This is used when we want to do a normal printing of the reason
845 for stopping. The output will depend on the type of eventpoint
846 we are dealing with. This is the default value, most commonly
849 /* This is used when nothing should be printed for this bpstat
852 /* This is used when everything which needs to be printed has
853 already been printed. But we still want to print the frame. */
859 /* Linked list because there can be more than one breakpoint at
860 the same place, and a bpstat reflects the fact that all have
864 /* Location that caused the stop. Locations are refcounted, so
865 this will never be NULL. Note that this location may end up
866 detached from a breakpoint, but that does not necessary mean
867 that the struct breakpoint is gone. E.g., consider a
868 watchpoint with a condition that involves an inferior function
869 call. Watchpoint locations are recreated often (on resumes,
870 hence on infcalls too). Between creating the bpstat and after
871 evaluating the watchpoint condition, this location may hence
872 end up detached from its original owner watchpoint, even though
873 the watchpoint is still listed. If it's condition evaluates as
874 true, we still want this location to cause a stop, and we will
875 still need to know which watchpoint it was originally attached.
876 What this means is that we should not (in most cases) follow
877 the `bpstat->bp_location->owner' link, but instead use the
878 `breakpoint_at' field below. */
879 struct bp_location *bp_location_at;
881 /* Breakpoint that caused the stop. This is nullified if the
882 breakpoint ends up being deleted. See comments on
883 `bp_location_at' above for why do we need this field instead of
884 following the location's owner. */
885 struct breakpoint *breakpoint_at;
887 /* The associated command list. */
888 struct counted_command_line *commands;
890 /* Commands left to be done. This points somewhere in
892 struct command_line *commands_left;
894 /* Old value associated with a watchpoint. */
895 struct value *old_val;
897 /* Nonzero if this breakpoint tells us to print the frame. */
900 /* Nonzero if this breakpoint tells us to stop. */
903 /* Tell bpstat_print and print_bp_stop_message how to print stuff
904 associated with this element of the bpstat chain. */
905 enum bp_print_how print_it;
916 /* The possible return values for breakpoint_here_p.
917 We guarantee that zero always means "no breakpoint here". */
920 no_breakpoint_here = 0,
921 ordinary_breakpoint_here,
922 permanent_breakpoint_here
926 /* Prototypes for breakpoint-related functions. */
928 extern enum breakpoint_here breakpoint_here_p (struct address_space *,
931 extern int moribund_breakpoint_here_p (struct address_space *, CORE_ADDR);
933 extern int breakpoint_inserted_here_p (struct address_space *, CORE_ADDR);
935 extern int regular_breakpoint_inserted_here_p (struct address_space *,
938 extern int software_breakpoint_inserted_here_p (struct address_space *,
941 /* Returns true if there's a hardware watchpoint or access watchpoint
942 inserted in the range defined by ADDR and LEN. */
943 extern int hardware_watchpoint_inserted_in_range (struct address_space *,
947 extern int breakpoint_thread_match (struct address_space *,
950 extern void until_break_command (char *, int, int);
952 extern void update_breakpoint_locations (struct breakpoint *b,
953 struct symtabs_and_lines sals,
954 struct symtabs_and_lines sals_end);
956 extern void breakpoint_re_set (void);
958 extern void breakpoint_re_set_thread (struct breakpoint *);
960 extern struct breakpoint *set_momentary_breakpoint
961 (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype);
963 extern struct breakpoint *set_momentary_breakpoint_at_pc
964 (struct gdbarch *, CORE_ADDR pc, enum bptype type);
966 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt);
968 extern void set_ignore_count (int, int, int);
970 extern void set_default_breakpoint (int, struct program_space *,
971 CORE_ADDR, struct symtab *, int);
973 extern void breakpoint_init_inferior (enum inf_context);
975 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
977 extern void delete_breakpoint (struct breakpoint *);
979 extern void breakpoint_auto_delete (bpstat);
981 /* Return the chain of command lines to execute when this breakpoint
983 extern struct command_line *breakpoint_commands (struct breakpoint *b);
985 /* Return a string image of DISP. The string is static, and thus should
986 NOT be deallocated after use. */
987 const char *bpdisp_text (enum bpdisp disp);
989 extern void break_command (char *, int);
991 extern void hbreak_command_wrapper (char *, int);
992 extern void thbreak_command_wrapper (char *, int);
993 extern void rbreak_command_wrapper (char *, int);
994 extern void watch_command_wrapper (char *, int, int);
995 extern void awatch_command_wrapper (char *, int, int);
996 extern void rwatch_command_wrapper (char *, int, int);
997 extern void tbreak_command (char *, int);
999 extern int create_breakpoint (struct gdbarch *gdbarch, char *arg,
1000 char *cond_string, int thread,
1001 int parse_condition_and_thread,
1002 int tempflag, enum bptype wanted_type,
1004 enum auto_boolean pending_break_support,
1005 struct breakpoint_ops *ops,
1010 extern void insert_breakpoints (void);
1012 extern int remove_breakpoints (void);
1014 extern int remove_breakpoints_pid (int pid);
1016 /* This function can be used to physically insert eventpoints from the
1017 specified traced inferior process, without modifying the breakpoint
1018 package's state. This can be useful for those targets which
1019 support following the processes of a fork() or vfork() system call,
1020 when both of the resulting two processes are to be followed. */
1021 extern int reattach_breakpoints (int);
1023 /* This function can be used to update the breakpoint package's state
1024 after an exec() system call has been executed.
1026 This function causes the following:
1028 - All eventpoints are marked "not inserted".
1029 - All eventpoints with a symbolic address are reset such that
1030 the symbolic address must be reevaluated before the eventpoints
1032 - The solib breakpoints are explicitly removed from the breakpoint
1034 - A step-resume breakpoint, if any, is explicitly removed from the
1036 - All eventpoints without a symbolic address are removed from the
1038 extern void update_breakpoints_after_exec (void);
1040 /* This function can be used to physically remove hardware breakpoints
1041 and watchpoints from the specified traced inferior process, without
1042 modifying the breakpoint package's state. This can be useful for
1043 those targets which support following the processes of a fork() or
1044 vfork() system call, when one of the resulting two processes is to
1045 be detached and allowed to run free.
1047 It is an error to use this function on the process whose id is
1049 extern int detach_breakpoints (int);
1051 /* This function is called when program space PSPACE is about to be
1052 deleted. It takes care of updating breakpoints to not reference
1053 this PSPACE anymore. */
1054 extern void breakpoint_program_space_exit (struct program_space *pspace);
1056 extern void set_longjmp_breakpoint (struct thread_info *tp,
1057 struct frame_id frame);
1058 extern void delete_longjmp_breakpoint (int thread);
1060 extern void enable_overlay_breakpoints (void);
1061 extern void disable_overlay_breakpoints (void);
1063 extern void set_std_terminate_breakpoint (void);
1064 extern void delete_std_terminate_breakpoint (void);
1066 /* These functions respectively disable or reenable all currently
1067 enabled watchpoints. When disabled, the watchpoints are marked
1068 call_disabled. When reenabled, they are marked enabled.
1070 The intended client of these functions is call_function_by_hand.
1072 The inferior must be stopped, and all breakpoints removed, when
1073 these functions are used.
1075 The need for these functions is that on some targets (e.g., HP-UX),
1076 gdb is unable to unwind through the dummy frame that is pushed as
1077 part of the implementation of a call command. Watchpoints can
1078 cause the inferior to stop in places where this frame is visible,
1079 and that can cause execution control to become very confused.
1081 Note that if a user sets breakpoints in an interactively called
1082 function, the call_disabled watchpoints will have been reenabled
1083 when the first such breakpoint is reached. However, on targets
1084 that are unable to unwind through the call dummy frame, watches
1085 of stack-based storage may then be deleted, because gdb will
1086 believe that their watched storage is out of scope. (Sigh.) */
1087 extern void disable_watchpoints_before_interactive_call_start (void);
1089 extern void enable_watchpoints_after_interactive_call_stop (void);
1091 /* These functions disable and re-enable all breakpoints during
1092 inferior startup. They are intended to be called from solib
1093 code where necessary. This is needed on platforms where the
1094 main executable is relocated at some point during startup
1095 processing, making breakpoint addresses invalid.
1097 If additional breakpoints are created after the routine
1098 disable_breakpoints_before_startup but before the routine
1099 enable_breakpoints_after_startup was called, they will also
1100 be marked as disabled. */
1101 extern void disable_breakpoints_before_startup (void);
1102 extern void enable_breakpoints_after_startup (void);
1104 /* For script interpreters that need to define breakpoint commands
1105 after they've already read the commands into a struct
1107 extern enum command_control_type commands_from_control_command
1108 (char *arg, struct command_line *cmd);
1110 extern void clear_breakpoint_hit_counts (void);
1112 extern struct breakpoint *get_breakpoint (int num);
1114 /* The following are for displays, which aren't really breakpoints,
1115 but here is as good a place as any for them. */
1117 extern void disable_current_display (void);
1119 extern void do_displays (void);
1121 extern void disable_display (int);
1123 extern void clear_displays (void);
1125 extern void disable_breakpoint (struct breakpoint *);
1127 extern void enable_breakpoint (struct breakpoint *);
1129 extern void breakpoint_set_commands (struct breakpoint *b,
1130 struct command_line *commands);
1132 extern void breakpoint_set_silent (struct breakpoint *b, int silent);
1134 extern void breakpoint_set_thread (struct breakpoint *b, int thread);
1136 extern void breakpoint_set_task (struct breakpoint *b, int task);
1138 /* Clear the "inserted" flag in all breakpoints. */
1139 extern void mark_breakpoints_out (void);
1141 extern void make_breakpoint_permanent (struct breakpoint *);
1143 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *,
1146 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *,
1149 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *,
1152 extern void remove_jit_event_breakpoints (void);
1154 extern void remove_solib_event_breakpoints (void);
1156 extern void remove_thread_event_breakpoints (void);
1158 extern void disable_breakpoints_in_shlibs (void);
1160 /* This function returns TRUE if ep is a catchpoint. */
1161 extern int ep_is_catchpoint (struct breakpoint *);
1163 /* Enable breakpoints and delete when hit. Called with ARG == NULL
1164 deletes all breakpoints. */
1165 extern void delete_command (char *arg, int from_tty);
1167 /* Manage a software single step breakpoint (or two). Insert may be
1168 called twice before remove is called. */
1169 extern void insert_single_step_breakpoint (struct gdbarch *,
1170 struct address_space *,
1172 extern int single_step_breakpoints_inserted (void);
1173 extern void remove_single_step_breakpoints (void);
1174 extern void cancel_single_step_breakpoints (void);
1176 /* Manage manual breakpoints, separate from the normal chain of
1177 breakpoints. These functions are used in murky target-specific
1178 ways. Please do not add more uses! */
1179 extern void *deprecated_insert_raw_breakpoint (struct gdbarch *,
1180 struct address_space *,
1182 extern int deprecated_remove_raw_breakpoint (struct gdbarch *, void *);
1184 /* Check if any hardware watchpoints have triggered, according to the
1186 int watchpoints_triggered (struct target_waitstatus *);
1188 /* Update BUF, which is LEN bytes read from the target address MEMADDR,
1189 by replacing any memory breakpoints with their shadowed contents. */
1190 void breakpoint_restore_shadows (gdb_byte *buf, ULONGEST memaddr,
1193 extern int breakpoints_always_inserted_mode (void);
1195 /* Called each time new event from target is processed.
1196 Retires previously deleted breakpoint locations that
1197 in our opinion won't ever trigger. */
1198 extern void breakpoint_retire_moribund (void);
1200 /* Set break condition of breakpoint B to EXP. */
1201 extern void set_breakpoint_condition (struct breakpoint *b, char *exp,
1204 /* Checks if we are catching syscalls or not.
1205 Returns 0 if not, greater than 0 if we are. */
1206 extern int catch_syscall_enabled (void);
1208 /* Checks if we are catching syscalls with the specific
1209 syscall_number. Used for "filtering" the catchpoints.
1210 Returns 0 if not, greater than 0 if we are. */
1211 extern int catching_syscall_number (int syscall_number);
1213 /* Return a tracepoint with the given number if found. */
1214 extern struct breakpoint *get_tracepoint (int num);
1216 extern struct breakpoint *get_tracepoint_by_number_on_target (int num);
1218 /* Find a tracepoint by parsing a number in the supplied string. */
1219 extern struct breakpoint *
1220 get_tracepoint_by_number (char **arg,
1221 struct get_number_or_range_state *state,
1224 /* Return a vector of all tracepoints currently defined. The vector
1225 is newly allocated; the caller should free when done with it. */
1226 extern VEC(breakpoint_p) *all_tracepoints (void);
1228 extern int is_tracepoint (const struct breakpoint *b);
1230 /* Return a vector of all static tracepoints defined at ADDR. The
1231 vector is newly allocated; the caller should free when done with
1233 extern VEC(breakpoint_p) *static_tracepoints_here (CORE_ADDR addr);
1235 /* Function that can be passed to read_command_line to validate
1236 that each command is suitable for tracepoint command list. */
1237 extern void check_tracepoint_command (char *line, void *closure);
1239 /* Call at the start and end of an "rbreak" command to register
1240 breakpoint numbers for a later "commands" command. */
1241 extern void start_rbreak_breakpoints (void);
1242 extern void end_rbreak_breakpoints (void);
1244 /* Breakpoint iterator function.
1246 Calls a callback function once for each breakpoint, so long as the
1247 callback function returns false. If the callback function returns
1248 true, the iteration will end and the current breakpoint will be
1249 returned. This can be useful for implementing a search for a
1250 breakpoint with arbitrary attributes, or for applying an operation
1251 to every breakpoint. */
1252 extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *,
1255 extern int user_breakpoint_p (struct breakpoint *);
1257 #endif /* !defined (BREAKPOINT_H) */