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 and for skipping prologues. */
74 /* Used by wait_for_inferior for stepping over signal
78 /* Used to detect when a watchpoint expression has gone out of
79 scope. These breakpoints are usually not visible to the user.
81 This breakpoint has some interesting properties:
83 1) There's always a 1:1 mapping between watchpoints
84 on local variables and watchpoint_scope breakpoints.
86 2) It automatically deletes itself and the watchpoint it's
87 associated with when hit.
89 3) It can never be disabled. */
92 /* The breakpoint at the end of a call dummy. */
93 /* FIXME: What if the function we are calling longjmp()s out of
94 the call, or the user gets out with the "return" command? We
95 currently have no way of cleaning up the breakpoint in these
96 (obscure) situations. (Probably can solve this by noticing
97 longjmp, "return", etc., it's similar to noticing when a
98 watchpoint on a local variable goes out of scope (with hardware
99 support for watchpoints)). */
102 /* A breakpoint set on std::terminate, that is used to catch
103 otherwise uncaught exceptions thrown during an inferior call. */
106 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
107 code in the inferior to run when significant events occur in the
108 dynamic linker (for example a library is loaded or unloaded).
110 By placing a breakpoint in this magic code GDB will get control
111 when these significant events occur. GDB can then re-examine
112 the dynamic linker's data structures to discover any newly loaded
113 dynamic libraries. */
116 /* Some multi-threaded systems can arrange for a location in the
117 inferior to be executed when certain thread-related events occur
118 (such as thread creation or thread death).
120 By placing a breakpoint at one of these locations, GDB will get
121 control when these events occur. GDB can then update its thread
126 /* On the same principal, an overlay manager can arrange to call a
127 magic location in the inferior whenever there is an interesting
128 change in overlay status. GDB can update its overlay tables
129 and fiddle with breakpoints in overlays when this breakpoint
134 /* Master copies of longjmp breakpoints. These are always installed
135 as soon as an objfile containing longjmp is loaded, but they are
136 always disabled. While necessary, temporary clones of bp_longjmp
137 type will be created and enabled. */
141 /* Master copies of std::terminate breakpoints. */
142 bp_std_terminate_master,
144 /* Like bp_longjmp_master, but for exceptions. */
151 bp_static_tracepoint,
153 /* Event for JIT compiled code generation or deletion. */
156 /* Breakpoint is placed at the STT_GNU_IFUNC resolver. When hit GDB
157 inserts new bp_gnu_ifunc_resolver_return at the caller.
158 bp_gnu_ifunc_resolver is still being kept here as a different thread
159 may still hit it before bp_gnu_ifunc_resolver_return is hit by the
161 bp_gnu_ifunc_resolver,
163 /* On its hit GDB now know the resolved address of the target
164 STT_GNU_IFUNC function. Associated bp_gnu_ifunc_resolver can be
165 deleted now and the breakpoint moved to the target function entry
167 bp_gnu_ifunc_resolver_return,
170 /* States of enablement of breakpoint. */
174 bp_disabled, /* The eventpoint is inactive, and cannot
176 bp_enabled, /* The eventpoint is active, and can
178 bp_call_disabled, /* The eventpoint has been disabled while a
179 call into the inferior is "in flight",
180 because some eventpoints interfere with
181 the implementation of a call on some
182 targets. The eventpoint will be
183 automatically enabled and reset when the
184 call "lands" (either completes, or stops
185 at another eventpoint). */
186 bp_startup_disabled, /* The eventpoint has been disabled during
187 inferior startup. This is necessary on
188 some targets where the main executable
189 will get relocated during startup, making
190 breakpoint addresses invalid. The
191 eventpoint will be automatically enabled
192 and reset once inferior startup is
194 bp_permanent /* There is a breakpoint instruction
195 hard-wired into the target's code. Don't
196 try to write another breakpoint
197 instruction on top of it, or restore its
198 value. Step over it using the
199 architecture's SKIP_INSN macro. */
203 /* Disposition of breakpoint. Ie: what to do after hitting it. */
207 disp_del, /* Delete it */
208 disp_del_at_next_stop, /* Delete at next stop,
209 whether hit or not */
210 disp_disable, /* Disable it */
211 disp_donttouch /* Leave it alone */
214 enum target_hw_bp_type
216 hw_write = 0, /* Common HW watchpoint */
217 hw_read = 1, /* Read HW watchpoint */
218 hw_access = 2, /* Access HW watchpoint */
219 hw_execute = 3 /* Execute HW breakpoint */
223 /* Information used by targets to insert and remove breakpoints. */
225 struct bp_target_info
227 /* Address space at which the breakpoint was placed. */
228 struct address_space *placed_address_space;
230 /* Address at which the breakpoint was placed. This is normally the
231 same as ADDRESS from the bp_location, except when adjustment
232 happens in gdbarch_breakpoint_from_pc. The most common form of
233 adjustment is stripping an alternate ISA marker from the PC which
234 is used to determine the type of breakpoint to insert. */
235 CORE_ADDR placed_address;
237 /* If this is a ranged breakpoint, then this field contains the
238 length of the range that will be watched for execution. */
241 /* If the breakpoint lives in memory and reading that memory would
242 give back the breakpoint, instead of the original contents, then
243 the original contents are cached here. Only SHADOW_LEN bytes of
244 this buffer are valid, and only when the breakpoint is inserted. */
245 gdb_byte shadow_contents[BREAKPOINT_MAX];
247 /* The length of the data cached in SHADOW_CONTENTS. */
250 /* The size of the placed breakpoint, according to
251 gdbarch_breakpoint_from_pc, when the breakpoint was inserted.
252 This is generally the same as SHADOW_LEN, unless we did not need
253 to read from the target to implement the memory breakpoint
254 (e.g. if a remote stub handled the details). We may still need
255 the size to remove the breakpoint safely. */
259 /* GDB maintains two types of information about each breakpoint (or
260 watchpoint, or other related event). The first type corresponds
261 to struct breakpoint; this is a relatively high-level structure
262 which contains the source location(s), stopping conditions, user
263 commands to execute when the breakpoint is hit, and so forth.
265 The second type of information corresponds to struct bp_location.
266 Each breakpoint has one or (eventually) more locations associated
267 with it, which represent target-specific and machine-specific
268 mechanisms for stopping the program. For instance, a watchpoint
269 expression may require multiple hardware watchpoints in order to
270 catch all changes in the value of the expression being watched. */
274 bp_loc_software_breakpoint,
275 bp_loc_hardware_breakpoint,
276 bp_loc_hardware_watchpoint,
277 bp_loc_other /* Miscellaneous... */
282 /* Chain pointer to the next breakpoint location for
283 the same parent breakpoint. */
284 struct bp_location *next;
286 /* The reference count. */
289 /* Type of this breakpoint location. */
290 enum bp_loc_type loc_type;
292 /* Each breakpoint location must belong to exactly one higher-level
293 breakpoint. This pointer is NULL iff this bp_location is no
294 longer attached to a breakpoint. For example, when a breakpoint
295 is deleted, its locations may still be found in the
296 moribund_locations list, or if we had stopped for it, in
298 struct breakpoint *owner;
300 /* Conditional. Break only if this expression's value is nonzero.
301 Unlike string form of condition, which is associated with
302 breakpoint, this is associated with location, since if breakpoint
303 has several locations, the evaluation of expression can be
304 different for different locations. Only valid for real
305 breakpoints; a watchpoint's conditional expression is stored in
306 the owner breakpoint object. */
307 struct expression *cond;
309 /* This location's address is in an unloaded solib, and so this
310 location should not be inserted. It will be automatically
311 enabled when that solib is loaded. */
314 /* Is this particular location enabled. */
317 /* Nonzero if this breakpoint is now inserted. */
320 /* Nonzero if this is not the first breakpoint in the list
321 for the given address. */
324 /* If we someday support real thread-specific breakpoints, then
325 the breakpoint location will need a thread identifier. */
327 /* Data for specific breakpoint types. These could be a union, but
328 simplicity is more important than memory usage for breakpoints. */
330 /* Architecture associated with this location's address. May be
331 different from the breakpoint architecture. */
332 struct gdbarch *gdbarch;
334 /* The program space associated with this breakpoint location
335 address. Note that an address space may be represented in more
336 than one program space (e.g. each uClinux program will be given
337 its own program space, but there will only be one address space
338 for all of them), but we must not insert more than one location
339 at the same address in the same address space. */
340 struct program_space *pspace;
342 /* Note that zero is a perfectly valid code address on some platforms
343 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
344 is not a special value for this field. Valid for all types except
348 /* For hardware watchpoints, the size of the memory region being
349 watched. For hardware ranged breakpoints, the size of the
353 /* Type of hardware watchpoint. */
354 enum target_hw_bp_type watchpoint_type;
356 /* For any breakpoint type with an address, this is the section
357 associated with the address. Used primarily for overlay
359 struct obj_section *section;
361 /* Address at which breakpoint was requested, either by the user or
362 by GDB for internal breakpoints. This will usually be the same
363 as ``address'' (above) except for cases in which
364 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
365 which to place the breakpoint in order to comply with a
366 processor's architectual constraints. */
367 CORE_ADDR requested_address;
371 /* Details of the placed breakpoint, when inserted. */
372 struct bp_target_info target_info;
374 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
375 struct bp_target_info overlay_target_info;
377 /* In a non-stop mode, it's possible that we delete a breakpoint,
378 but as we do that, some still running thread hits that breakpoint.
379 For that reason, we need to keep locations belonging to deleted
380 breakpoints for a bit, so that don't report unexpected SIGTRAP.
381 We can't keep such locations forever, so we use a heuristic --
382 after we process certain number of inferior events since
383 breakpoint was deleted, we retire all locations of that breakpoint.
384 This variable keeps a number of events still to go, when
385 it becomes 0 this location is retired. */
386 int events_till_retirement;
389 /* This structure is a collection of function pointers that, if available,
390 will be called instead of the performing the default action for this
393 struct breakpoint_ops
395 /* Insert the breakpoint or watchpoint or activate the catchpoint.
396 Return 0 for success, 1 if the breakpoint, watchpoint or catchpoint
397 type is not supported, -1 for failure. */
398 int (*insert_location) (struct bp_location *);
400 /* Remove the breakpoint/catchpoint that was previously inserted
401 with the "insert" method above. Return 0 for success, 1 if the
402 breakpoint, watchpoint or catchpoint type is not supported,
404 int (*remove_location) (struct bp_location *);
406 /* Return non-zero if the debugger should tell the user that this
407 breakpoint was hit. */
408 int (*breakpoint_hit) (const struct bp_location *, struct address_space *,
411 /* Tell how many hardware resources (debug registers) are needed
412 for this breakpoint. If this function is not provided, then
413 the breakpoint or watchpoint needs one debug register. */
414 int (*resources_needed) (const struct bp_location *);
416 /* Tell whether we can downgrade from a hardware watchpoint to a software
417 one. If not, the user will not be able to enable the watchpoint when
418 there are not enough hardware resources available. */
419 int (*works_in_software_mode) (const struct breakpoint *);
421 /* The normal print routine for this breakpoint, called when we
423 enum print_stop_action (*print_it) (struct breakpoint *);
425 /* Display information about this breakpoint, for "info
427 void (*print_one) (struct breakpoint *, struct bp_location **);
429 /* Display extra information about this breakpoint, below the normal
430 breakpoint description in "info breakpoints".
432 In the example below, the "address range" line was printed
433 by print_one_detail_ranged_breakpoint.
435 (gdb) info breakpoints
436 Num Type Disp Enb Address What
437 2 hw breakpoint keep y in main at test-watch.c:70
438 address range: [0x10000458, 0x100004c7]
441 void (*print_one_detail) (const struct breakpoint *, struct ui_out *);
443 /* Display information about this breakpoint after setting it
444 (roughly speaking; this is called from "mention"). */
445 void (*print_mention) (struct breakpoint *);
447 /* Print to FP the CLI command that recreates this breakpoint. */
448 void (*print_recreate) (struct breakpoint *, struct ui_file *fp);
451 enum watchpoint_triggered
453 /* This watchpoint definitely did not trigger. */
454 watch_triggered_no = 0,
456 /* Some hardware watchpoint triggered, and it might have been this
457 one, but we do not know which it was. */
458 watch_triggered_unknown,
460 /* This hardware watchpoint definitely did trigger. */
464 /* This is used to declare the VEC syscalls_to_be_caught. */
467 typedef struct bp_location *bp_location_p;
468 DEF_VEC_P(bp_location_p);
470 /* A reference-counted struct command_line. This lets multiple
471 breakpoints share a single command list. This is an implementation
472 detail to the breakpoints module. */
473 struct counted_command_line;
475 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
476 a watchpoint over a memory region. If this flag is true, GDB will use
477 only one register per watchpoint, thus assuming that all acesses that
478 modify a memory location happen at its starting address. */
480 extern int target_exact_watchpoints;
482 /* Note that the ->silent field is not currently used by any commands
483 (though the code is in there if it was to be, and set_raw_breakpoint
484 does set it to 0). I implemented it because I thought it would be
485 useful for a hack I had to put in; I'm going to leave it in because
486 I can see how there might be times when it would indeed be useful */
488 /* This is for a breakpoint or a watchpoint. */
492 struct breakpoint *next;
493 /* Type of breakpoint. */
495 /* Zero means disabled; remember the info but don't break here. */
496 enum enable_state enable_state;
497 /* What to do with this breakpoint after we hit it. */
498 enum bpdisp disposition;
499 /* Number assigned to distinguish breakpoints. */
502 /* Location(s) associated with this high-level breakpoint. */
503 struct bp_location *loc;
505 /* Line number of this address. */
509 /* Source file name of this address. */
513 /* Non-zero means a silent breakpoint (don't print frame info
515 unsigned char silent;
516 /* Non-zero means display ADDR_STRING to the user verbatim. */
517 unsigned char display_canonical;
518 /* Number of stops at this breakpoint that should
519 be continued automatically before really stopping. */
521 /* Chain of command lines to execute when this breakpoint is
523 struct counted_command_line *commands;
524 /* Stack depth (address of frame). If nonzero, break only if fp
526 struct frame_id frame_id;
528 /* The program space used to set the breakpoint. */
529 struct program_space *pspace;
531 /* String we used to set the breakpoint (malloc'd). */
534 /* For a ranged breakpoint, the string we used to find
535 the end of the range (malloc'd). */
536 char *addr_string_range_end;
538 /* Architecture we used to set the breakpoint. */
539 struct gdbarch *gdbarch;
540 /* Language we used to set the breakpoint. */
541 enum language language;
542 /* Input radix we used to set the breakpoint. */
544 /* String form of the breakpoint condition (malloc'd), or NULL if
545 there is no condition. */
547 /* String form of exp to use for displaying to the user
548 (malloc'd), or NULL if none. */
550 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
551 char *exp_string_reparse;
553 /* The expression we are watching, or NULL if not a watchpoint. */
554 struct expression *exp;
555 /* The largest block within which it is valid, or NULL if it is
556 valid anywhere (e.g. consists just of global symbols). */
557 struct block *exp_valid_block;
558 /* The conditional expression if any. NULL if not a watchpoint. */
559 struct expression *cond_exp;
560 /* The largest block within which it is valid, or NULL if it is
561 valid anywhere (e.g. consists just of global symbols). */
562 struct block *cond_exp_valid_block;
563 /* Value of the watchpoint the last time we checked it, or NULL
564 when we do not know the value yet or the value was not
565 readable. VAL is never lazy. */
567 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
568 then an error occurred reading the value. */
571 /* Holds the address of the related watchpoint_scope breakpoint
572 when using watchpoints on local variables (might the concept of
573 a related breakpoint be useful elsewhere, if not just call it
574 the watchpoint_scope breakpoint or something like that.
576 struct breakpoint *related_breakpoint;
578 /* Holds the frame address which identifies the frame this
579 watchpoint should be evaluated in, or `null' if the watchpoint
580 should be evaluated on the outermost frame. */
581 struct frame_id watchpoint_frame;
583 /* Holds the thread which identifies the frame this watchpoint
584 should be considered in scope for, or `null_ptid' if the
585 watchpoint should be evaluated in all threads. */
586 ptid_t watchpoint_thread;
588 /* For hardware watchpoints, the triggered status according to the
590 enum watchpoint_triggered watchpoint_triggered;
592 /* Thread number for thread-specific breakpoint,
593 or -1 if don't care. */
596 /* Ada task number for task-specific breakpoint,
597 or 0 if don't care. */
600 /* Count of the number of times this breakpoint was taken, dumped
601 with the info, but not used for anything else. Useful for
602 seeing how many times you hit a break prior to the program
603 aborting, so you can back up to just before the abort. */
606 /* Process id of a child process whose forking triggered this
607 catchpoint. This field is only valid immediately after this
608 catchpoint has triggered. */
609 ptid_t forked_inferior_pid;
611 /* Filename of a program whose exec triggered this catchpoint.
612 This field is only valid immediately after this catchpoint has
616 /* Syscall numbers used for the 'catch syscall' feature. If no
617 syscall has been specified for filtering, its value is NULL.
618 Otherwise, it holds a list of all syscalls to be caught. The
619 list elements are allocated with xmalloc. */
620 VEC(int) *syscalls_to_be_caught;
622 /* Methods associated with this breakpoint. */
623 struct breakpoint_ops *ops;
625 /* Is breakpoint's condition not yet parsed because we found
626 no location initially so had no context to parse
628 int condition_not_parsed;
630 /* Number of times this tracepoint should single-step
631 and collect additional data. */
634 /* Number of times this tracepoint should be hit before
638 /* The number of the tracepoint on the target. */
639 int number_on_target;
641 /* The static tracepoint marker id, if known. */
642 char *static_trace_marker_id;
644 /* LTTng/UST allow more than one marker with the same ID string,
645 although it unadvised because it confuses tools. When setting
646 static tracepoints by marker ID, this will record the index in
647 the array of markers we found for the given marker ID for which
648 this static tracepoint corresponds. When resetting
649 breakpoints, we will use this index to try to find the same
651 int static_trace_marker_id_idx;
653 /* With a Python scripting enabled GDB, store a reference to the
654 Python object that has been associated with this breakpoint.
655 This is always NULL for a GDB that is not script enabled. It
656 can sometimes be NULL for enabled GDBs as not all breakpoint
657 types are tracked by the Python scripting API. */
658 struct breakpoint_object *py_bp_object;
660 /* Whether this watchpoint is exact (see target_exact_watchpoints). */
663 /* The mask address for a masked hardware watchpoint. */
664 CORE_ADDR hw_wp_mask;
667 typedef struct breakpoint *breakpoint_p;
668 DEF_VEC_P(breakpoint_p);
670 /* The following stuff is an abstract data type "bpstat" ("breakpoint
671 status"). This provides the ability to determine whether we have
672 stopped at a breakpoint, and what we should do about it. */
674 typedef struct bpstats *bpstat;
676 /* Clears a chain of bpstat, freeing storage
678 extern void bpstat_clear (bpstat *);
680 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
681 is part of the bpstat is copied as well. */
682 extern bpstat bpstat_copy (bpstat);
684 extern bpstat bpstat_stop_status (struct address_space *aspace,
685 CORE_ADDR pc, ptid_t ptid);
687 /* This bpstat_what stuff tells wait_for_inferior what to do with a
688 breakpoint (a challenging task).
690 The enum values order defines priority-like order of the actions.
691 Once you've decided that some action is appropriate, you'll never
692 go back and decide something of a lower priority is better. Each
693 of these actions is mutually exclusive with the others. That
694 means, that if you find yourself adding a new action class here and
695 wanting to tell GDB that you have two simultaneous actions to
696 handle, something is wrong, and you probably don't actually need a
699 Note that a step resume breakpoint overrides another breakpoint of
700 signal handling (see comment in wait_for_inferior at where we set
701 the step_resume breakpoint). */
703 enum bpstat_what_main_action
705 /* Perform various other tests; that is, this bpstat does not
706 say to perform any action (e.g. failed watchpoint and nothing
708 BPSTAT_WHAT_KEEP_CHECKING,
710 /* Remove breakpoints, single step once, then put them back in and
711 go back to what we were doing. It's possible that this should
712 be removed from the main_action and put into a separate field,
713 to more cleanly handle
714 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
717 /* Set longjmp_resume breakpoint, remove all other breakpoints,
718 and continue. The "remove all other breakpoints" part is
719 required if we are also stepping over another breakpoint as
720 well as doing the longjmp handling. */
721 BPSTAT_WHAT_SET_LONGJMP_RESUME,
723 /* Clear longjmp_resume breakpoint, then handle as
724 BPSTAT_WHAT_KEEP_CHECKING. */
725 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
727 /* Clear step resume breakpoint, and keep checking. */
728 BPSTAT_WHAT_STEP_RESUME,
730 /* Rather than distinguish between noisy and silent stops here, it
731 might be cleaner to have bpstat_print make that decision (also
732 taking into account stop_print_frame and source_only). But the
733 implications are a bit scary (interaction with auto-displays,
734 etc.), so I won't try it. */
737 BPSTAT_WHAT_STOP_SILENT,
739 /* Stop and print. */
740 BPSTAT_WHAT_STOP_NOISY,
742 /* Clear step resume breakpoint, and keep checking. High-priority
743 step-resume breakpoints are used when even if there's a user
744 breakpoint at the current PC when we set the step-resume
745 breakpoint, we don't want to re-handle any breakpoint other
746 than the step-resume when it's hit; instead we want to move
747 past the breakpoint. This is used in the case of skipping
749 BPSTAT_WHAT_HP_STEP_RESUME,
752 /* An enum indicating the kind of "stack dummy" stop. This is a bit
753 of a misnomer because only one kind of truly a stack dummy. */
756 /* We didn't stop at a stack dummy breakpoint. */
759 /* Stopped at a stack dummy. */
762 /* Stopped at std::terminate. */
768 enum bpstat_what_main_action main_action;
770 /* Did we hit a call dummy breakpoint? This only goes with a
771 main_action of BPSTAT_WHAT_STOP_SILENT or
772 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
773 dummy without popping the frame is not a useful one). */
774 enum stop_stack_kind call_dummy;
776 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
777 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
778 longjmp, false if we are handling an exception. */
782 /* The possible return values for print_bpstat, print_it_normal,
783 print_it_done, print_it_noop. */
784 enum print_stop_action
792 /* Tell what to do about this bpstat. */
793 struct bpstat_what bpstat_what (bpstat);
795 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
796 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
798 /* Nonzero if a signal that we got in wait() was due to circumstances
799 explained by the BS. */
800 /* Currently that is true if we have hit a breakpoint, or if there is
801 a watchpoint enabled. */
802 #define bpstat_explains_signal(bs) ((bs) != NULL)
804 /* Nonzero is this bpstat causes a stop. */
805 extern int bpstat_causes_stop (bpstat);
807 /* Nonzero if we should step constantly (e.g. watchpoints on machines
808 without hardware support). This isn't related to a specific bpstat,
809 just to things like whether watchpoints are set. */
810 extern int bpstat_should_step (void);
812 /* Print a message indicating what happened. Returns nonzero to
813 say that only the source line should be printed after this (zero
814 return means print the frame as well as the source line). */
815 extern enum print_stop_action bpstat_print (bpstat);
817 /* Put in *NUM the breakpoint number of the first breakpoint we are
818 stopped at. *BSP upon return is a bpstat which points to the
819 remaining breakpoints stopped at (but which is not guaranteed to be
820 good for anything but further calls to bpstat_num).
822 Return 0 if passed a bpstat which does not indicate any breakpoints.
823 Return -1 if stopped at a breakpoint that has been deleted since
825 Return 1 otherwise. */
826 extern int bpstat_num (bpstat *, int *);
828 /* Perform actions associated with the stopped inferior. Actually, we
829 just use this for breakpoint commands. Perhaps other actions will
830 go here later, but this is executed at a late time (from the
832 extern void bpstat_do_actions (void);
834 /* Modify BS so that the actions will not be performed. */
835 extern void bpstat_clear_actions (bpstat);
837 /* Implementation: */
839 /* Values used to tell the printing routine how to behave for this
843 /* This is used when we want to do a normal printing of the reason
844 for stopping. The output will depend on the type of eventpoint
845 we are dealing with. This is the default value, most commonly
848 /* This is used when nothing should be printed for this bpstat
851 /* This is used when everything which needs to be printed has
852 already been printed. But we still want to print the frame. */
858 /* Linked list because there can be more than one breakpoint at
859 the same place, and a bpstat reflects the fact that all have
863 /* Location that caused the stop. Locations are refcounted, so
864 this will never be NULL. Note that this location may end up
865 detached from a breakpoint, but that does not necessary mean
866 that the struct breakpoint is gone. E.g., consider a
867 watchpoint with a condition that involves an inferior function
868 call. Watchpoint locations are recreated often (on resumes,
869 hence on infcalls too). Between creating the bpstat and after
870 evaluating the watchpoint condition, this location may hence
871 end up detached from its original owner watchpoint, even though
872 the watchpoint is still listed. If it's condition evaluates as
873 true, we still want this location to cause a stop, and we will
874 still need to know which watchpoint it was originally attached.
875 What this means is that we should not (in most cases) follow
876 the `bpstat->bp_location->owner' link, but instead use the
877 `breakpoint_at' field below. */
878 struct bp_location *bp_location_at;
880 /* Breakpoint that caused the stop. This is nullified if the
881 breakpoint ends up being deleted. See comments on
882 `bp_location_at' above for why do we need this field instead of
883 following the location's owner. */
884 struct breakpoint *breakpoint_at;
886 /* The associated command list. */
887 struct counted_command_line *commands;
889 /* Commands left to be done. This points somewhere in
891 struct command_line *commands_left;
893 /* Old value associated with a watchpoint. */
894 struct value *old_val;
896 /* Nonzero if this breakpoint tells us to print the frame. */
899 /* Nonzero if this breakpoint tells us to stop. */
902 /* Tell bpstat_print and print_bp_stop_message how to print stuff
903 associated with this element of the bpstat chain. */
904 enum bp_print_how print_it;
915 /* The possible return values for breakpoint_here_p.
916 We guarantee that zero always means "no breakpoint here". */
919 no_breakpoint_here = 0,
920 ordinary_breakpoint_here,
921 permanent_breakpoint_here
925 /* Prototypes for breakpoint-related functions. */
927 extern enum breakpoint_here breakpoint_here_p (struct address_space *,
930 extern int moribund_breakpoint_here_p (struct address_space *, CORE_ADDR);
932 extern int breakpoint_inserted_here_p (struct address_space *, CORE_ADDR);
934 extern int regular_breakpoint_inserted_here_p (struct address_space *,
937 extern int software_breakpoint_inserted_here_p (struct address_space *,
940 /* Returns true if there's a hardware watchpoint or access watchpoint
941 inserted in the range defined by ADDR and LEN. */
942 extern int hardware_watchpoint_inserted_in_range (struct address_space *,
946 extern int breakpoint_thread_match (struct address_space *,
949 extern void until_break_command (char *, int, int);
951 extern void update_breakpoint_locations (struct breakpoint *b,
952 struct symtabs_and_lines sals,
953 struct symtabs_and_lines sals_end);
955 extern void breakpoint_re_set (void);
957 extern void breakpoint_re_set_thread (struct breakpoint *);
959 extern struct breakpoint *set_momentary_breakpoint
960 (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype);
962 extern struct breakpoint *set_momentary_breakpoint_at_pc
963 (struct gdbarch *, CORE_ADDR pc, enum bptype type);
965 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt);
967 extern void set_ignore_count (int, int, int);
969 extern void set_default_breakpoint (int, struct program_space *,
970 CORE_ADDR, struct symtab *, int);
972 extern void breakpoint_init_inferior (enum inf_context);
974 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
976 extern void delete_breakpoint (struct breakpoint *);
978 extern void breakpoint_auto_delete (bpstat);
980 /* Return the chain of command lines to execute when this breakpoint
982 extern struct command_line *breakpoint_commands (struct breakpoint *b);
984 /* Return a string image of DISP. The string is static, and thus should
985 NOT be deallocated after use. */
986 const char *bpdisp_text (enum bpdisp disp);
988 extern void break_command (char *, int);
990 extern void hbreak_command_wrapper (char *, int);
991 extern void thbreak_command_wrapper (char *, int);
992 extern void rbreak_command_wrapper (char *, int);
993 extern void watch_command_wrapper (char *, int, int);
994 extern void awatch_command_wrapper (char *, int, int);
995 extern void rwatch_command_wrapper (char *, int, int);
996 extern void tbreak_command (char *, int);
998 extern int create_breakpoint (struct gdbarch *gdbarch, char *arg,
999 char *cond_string, int thread,
1000 int parse_condition_and_thread,
1001 int tempflag, enum bptype wanted_type,
1003 enum auto_boolean pending_break_support,
1004 struct breakpoint_ops *ops,
1009 extern void insert_breakpoints (void);
1011 extern int remove_breakpoints (void);
1013 extern int remove_breakpoints_pid (int pid);
1015 /* This function can be used to physically insert eventpoints from the
1016 specified traced inferior process, without modifying the breakpoint
1017 package's state. This can be useful for those targets which
1018 support following the processes of a fork() or vfork() system call,
1019 when both of the resulting two processes are to be followed. */
1020 extern int reattach_breakpoints (int);
1022 /* This function can be used to update the breakpoint package's state
1023 after an exec() system call has been executed.
1025 This function causes the following:
1027 - All eventpoints are marked "not inserted".
1028 - All eventpoints with a symbolic address are reset such that
1029 the symbolic address must be reevaluated before the eventpoints
1031 - The solib breakpoints are explicitly removed from the breakpoint
1033 - A step-resume breakpoint, if any, is explicitly removed from the
1035 - All eventpoints without a symbolic address are removed from the
1037 extern void update_breakpoints_after_exec (void);
1039 /* This function can be used to physically remove hardware breakpoints
1040 and watchpoints from the specified traced inferior process, without
1041 modifying the breakpoint package's state. This can be useful for
1042 those targets which support following the processes of a fork() or
1043 vfork() system call, when one of the resulting two processes is to
1044 be detached and allowed to run free.
1046 It is an error to use this function on the process whose id is
1048 extern int detach_breakpoints (int);
1050 /* This function is called when program space PSPACE is about to be
1051 deleted. It takes care of updating breakpoints to not reference
1052 this PSPACE anymore. */
1053 extern void breakpoint_program_space_exit (struct program_space *pspace);
1055 extern void set_longjmp_breakpoint (struct thread_info *tp,
1056 struct frame_id frame);
1057 extern void delete_longjmp_breakpoint (int thread);
1059 extern void enable_overlay_breakpoints (void);
1060 extern void disable_overlay_breakpoints (void);
1062 extern void set_std_terminate_breakpoint (void);
1063 extern void delete_std_terminate_breakpoint (void);
1065 /* These functions respectively disable or reenable all currently
1066 enabled watchpoints. When disabled, the watchpoints are marked
1067 call_disabled. When reenabled, they are marked enabled.
1069 The intended client of these functions is call_function_by_hand.
1071 The inferior must be stopped, and all breakpoints removed, when
1072 these functions are used.
1074 The need for these functions is that on some targets (e.g., HP-UX),
1075 gdb is unable to unwind through the dummy frame that is pushed as
1076 part of the implementation of a call command. Watchpoints can
1077 cause the inferior to stop in places where this frame is visible,
1078 and that can cause execution control to become very confused.
1080 Note that if a user sets breakpoints in an interactively called
1081 function, the call_disabled watchpoints will have been reenabled
1082 when the first such breakpoint is reached. However, on targets
1083 that are unable to unwind through the call dummy frame, watches
1084 of stack-based storage may then be deleted, because gdb will
1085 believe that their watched storage is out of scope. (Sigh.) */
1086 extern void disable_watchpoints_before_interactive_call_start (void);
1088 extern void enable_watchpoints_after_interactive_call_stop (void);
1090 /* These functions disable and re-enable all breakpoints during
1091 inferior startup. They are intended to be called from solib
1092 code where necessary. This is needed on platforms where the
1093 main executable is relocated at some point during startup
1094 processing, making breakpoint addresses invalid.
1096 If additional breakpoints are created after the routine
1097 disable_breakpoints_before_startup but before the routine
1098 enable_breakpoints_after_startup was called, they will also
1099 be marked as disabled. */
1100 extern void disable_breakpoints_before_startup (void);
1101 extern void enable_breakpoints_after_startup (void);
1103 /* For script interpreters that need to define breakpoint commands
1104 after they've already read the commands into a struct
1106 extern enum command_control_type commands_from_control_command
1107 (char *arg, struct command_line *cmd);
1109 extern void clear_breakpoint_hit_counts (void);
1111 extern struct breakpoint *get_breakpoint (int num);
1113 /* The following are for displays, which aren't really breakpoints,
1114 but here is as good a place as any for them. */
1116 extern void disable_current_display (void);
1118 extern void do_displays (void);
1120 extern void disable_display (int);
1122 extern void clear_displays (void);
1124 extern void disable_breakpoint (struct breakpoint *);
1126 extern void enable_breakpoint (struct breakpoint *);
1128 extern void breakpoint_set_commands (struct breakpoint *b,
1129 struct command_line *commands);
1131 extern void breakpoint_set_silent (struct breakpoint *b, int silent);
1133 extern void breakpoint_set_thread (struct breakpoint *b, int thread);
1135 extern void breakpoint_set_task (struct breakpoint *b, int task);
1137 /* Clear the "inserted" flag in all breakpoints. */
1138 extern void mark_breakpoints_out (void);
1140 extern void make_breakpoint_permanent (struct breakpoint *);
1142 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *,
1145 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *,
1148 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *,
1151 extern void remove_jit_event_breakpoints (void);
1153 extern void remove_solib_event_breakpoints (void);
1155 extern void remove_thread_event_breakpoints (void);
1157 extern void disable_breakpoints_in_shlibs (void);
1159 /* This function returns TRUE if ep is a catchpoint. */
1160 extern int ep_is_catchpoint (struct breakpoint *);
1162 /* Enable breakpoints and delete when hit. Called with ARG == NULL
1163 deletes all breakpoints. */
1164 extern void delete_command (char *arg, int from_tty);
1166 /* Manage a software single step breakpoint (or two). Insert may be
1167 called twice before remove is called. */
1168 extern void insert_single_step_breakpoint (struct gdbarch *,
1169 struct address_space *,
1171 extern int single_step_breakpoints_inserted (void);
1172 extern void remove_single_step_breakpoints (void);
1173 extern void cancel_single_step_breakpoints (void);
1175 /* Manage manual breakpoints, separate from the normal chain of
1176 breakpoints. These functions are used in murky target-specific
1177 ways. Please do not add more uses! */
1178 extern void *deprecated_insert_raw_breakpoint (struct gdbarch *,
1179 struct address_space *,
1181 extern int deprecated_remove_raw_breakpoint (struct gdbarch *, void *);
1183 /* Check if any hardware watchpoints have triggered, according to the
1185 int watchpoints_triggered (struct target_waitstatus *);
1187 /* Update BUF, which is LEN bytes read from the target address MEMADDR,
1188 by replacing any memory breakpoints with their shadowed contents. */
1189 void breakpoint_restore_shadows (gdb_byte *buf, ULONGEST memaddr,
1192 extern int breakpoints_always_inserted_mode (void);
1194 /* Called each time new event from target is processed.
1195 Retires previously deleted breakpoint locations that
1196 in our opinion won't ever trigger. */
1197 extern void breakpoint_retire_moribund (void);
1199 /* Set break condition of breakpoint B to EXP. */
1200 extern void set_breakpoint_condition (struct breakpoint *b, char *exp,
1203 /* Checks if we are catching syscalls or not.
1204 Returns 0 if not, greater than 0 if we are. */
1205 extern int catch_syscall_enabled (void);
1207 /* Checks if we are catching syscalls with the specific
1208 syscall_number. Used for "filtering" the catchpoints.
1209 Returns 0 if not, greater than 0 if we are. */
1210 extern int catching_syscall_number (int syscall_number);
1212 /* Return a tracepoint with the given number if found. */
1213 extern struct breakpoint *get_tracepoint (int num);
1215 extern struct breakpoint *get_tracepoint_by_number_on_target (int num);
1217 /* Find a tracepoint by parsing a number in the supplied string. */
1218 extern struct breakpoint *
1219 get_tracepoint_by_number (char **arg,
1220 struct get_number_or_range_state *state,
1223 /* Return a vector of all tracepoints currently defined. The vector
1224 is newly allocated; the caller should free when done with it. */
1225 extern VEC(breakpoint_p) *all_tracepoints (void);
1227 extern int is_tracepoint (const struct breakpoint *b);
1229 /* Return a vector of all static tracepoints defined at ADDR. The
1230 vector is newly allocated; the caller should free when done with
1232 extern VEC(breakpoint_p) *static_tracepoints_here (CORE_ADDR addr);
1234 /* Function that can be passed to read_command_line to validate
1235 that each command is suitable for tracepoint command list. */
1236 extern void check_tracepoint_command (char *line, void *closure);
1238 /* Call at the start and end of an "rbreak" command to register
1239 breakpoint numbers for a later "commands" command. */
1240 extern void start_rbreak_breakpoints (void);
1241 extern void end_rbreak_breakpoints (void);
1243 /* Breakpoint iterator function.
1245 Calls a callback function once for each breakpoint, so long as the
1246 callback function returns false. If the callback function returns
1247 true, the iteration will end and the current breakpoint will be
1248 returned. This can be useful for implementing a search for a
1249 breakpoint with arbitrary attributes, or for applying an operation
1250 to every breakpoint. */
1251 extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *,
1254 extern int user_breakpoint_p (struct breakpoint *);
1256 #endif /* !defined (BREAKPOINT_H) */