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. */
154 /* States of enablement of breakpoint. */
158 bp_disabled, /* The eventpoint is inactive, and cannot
160 bp_enabled, /* The eventpoint is active, and can
162 bp_call_disabled, /* The eventpoint has been disabled while a
163 call into the inferior is "in flight",
164 because some eventpoints interfere with
165 the implementation of a call on some
166 targets. The eventpoint will be
167 automatically enabled and reset when the
168 call "lands" (either completes, or stops
169 at another eventpoint). */
170 bp_startup_disabled, /* The eventpoint has been disabled during
171 inferior startup. This is necessary on
172 some targets where the main executable
173 will get relocated during startup, making
174 breakpoint addresses invalid. The
175 eventpoint will be automatically enabled
176 and reset once inferior startup is
178 bp_permanent /* There is a breakpoint instruction
179 hard-wired into the target's code. Don't
180 try to write another breakpoint
181 instruction on top of it, or restore its
182 value. Step over it using the
183 architecture's SKIP_INSN macro. */
187 /* Disposition of breakpoint. Ie: what to do after hitting it. */
191 disp_del, /* Delete it */
192 disp_del_at_next_stop, /* Delete at next stop,
193 whether hit or not */
194 disp_disable, /* Disable it */
195 disp_donttouch /* Leave it alone */
198 enum target_hw_bp_type
200 hw_write = 0, /* Common HW watchpoint */
201 hw_read = 1, /* Read HW watchpoint */
202 hw_access = 2, /* Access HW watchpoint */
203 hw_execute = 3 /* Execute HW breakpoint */
207 /* Information used by targets to insert and remove breakpoints. */
209 struct bp_target_info
211 /* Address space at which the breakpoint was placed. */
212 struct address_space *placed_address_space;
214 /* Address at which the breakpoint was placed. This is normally the
215 same as ADDRESS from the bp_location, except when adjustment
216 happens in gdbarch_breakpoint_from_pc. The most common form of
217 adjustment is stripping an alternate ISA marker from the PC which
218 is used to determine the type of breakpoint to insert. */
219 CORE_ADDR placed_address;
221 /* If the breakpoint lives in memory and reading that memory would
222 give back the breakpoint, instead of the original contents, then
223 the original contents are cached here. Only SHADOW_LEN bytes of
224 this buffer are valid, and only when the breakpoint is inserted. */
225 gdb_byte shadow_contents[BREAKPOINT_MAX];
227 /* The length of the data cached in SHADOW_CONTENTS. */
230 /* The size of the placed breakpoint, according to
231 gdbarch_breakpoint_from_pc, when the breakpoint was inserted.
232 This is generally the same as SHADOW_LEN, unless we did not need
233 to read from the target to implement the memory breakpoint
234 (e.g. if a remote stub handled the details). We may still need
235 the size to remove the breakpoint safely. */
239 /* GDB maintains two types of information about each breakpoint (or
240 watchpoint, or other related event). The first type corresponds
241 to struct breakpoint; this is a relatively high-level structure
242 which contains the source location(s), stopping conditions, user
243 commands to execute when the breakpoint is hit, and so forth.
245 The second type of information corresponds to struct bp_location.
246 Each breakpoint has one or (eventually) more locations associated
247 with it, which represent target-specific and machine-specific
248 mechanisms for stopping the program. For instance, a watchpoint
249 expression may require multiple hardware watchpoints in order to
250 catch all changes in the value of the expression being watched. */
254 bp_loc_software_breakpoint,
255 bp_loc_hardware_breakpoint,
256 bp_loc_hardware_watchpoint,
257 bp_loc_other /* Miscellaneous... */
262 /* Chain pointer to the next breakpoint location for
263 the same parent breakpoint. */
264 struct bp_location *next;
266 /* The reference count. */
269 /* Type of this breakpoint location. */
270 enum bp_loc_type loc_type;
272 /* Each breakpoint location must belong to exactly one higher-level
273 breakpoint. This pointer is NULL iff this bp_location is no
274 longer attached to a breakpoint. For example, when a breakpoint
275 is deleted, its locations may still be found in the
276 moribund_locations list, or if we had stopped for it, in
278 struct breakpoint *owner;
280 /* Conditional. Break only if this expression's value is nonzero.
281 Unlike string form of condition, which is associated with
282 breakpoint, this is associated with location, since if breakpoint
283 has several locations, the evaluation of expression can be
284 different for different locations. Only valid for real
285 breakpoints; a watchpoint's conditional expression is stored in
286 the owner breakpoint object. */
287 struct expression *cond;
289 /* This location's address is in an unloaded solib, and so this
290 location should not be inserted. It will be automatically
291 enabled when that solib is loaded. */
294 /* Is this particular location enabled. */
297 /* Nonzero if this breakpoint is now inserted. */
300 /* Nonzero if this is not the first breakpoint in the list
301 for the given address. */
304 /* If we someday support real thread-specific breakpoints, then
305 the breakpoint location will need a thread identifier. */
307 /* Data for specific breakpoint types. These could be a union, but
308 simplicity is more important than memory usage for breakpoints. */
310 /* Architecture associated with this location's address. May be
311 different from the breakpoint architecture. */
312 struct gdbarch *gdbarch;
314 /* The program space associated with this breakpoint location
315 address. Note that an address space may be represented in more
316 than one program space (e.g. each uClinux program will be given
317 its own program space, but there will only be one address space
318 for all of them), but we must not insert more than one location
319 at the same address in the same address space. */
320 struct program_space *pspace;
322 /* Note that zero is a perfectly valid code address on some platforms
323 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
324 is not a special value for this field. Valid for all types except
328 /* For hardware watchpoints, the size of the memory region being
332 /* Type of hardware watchpoint. */
333 enum target_hw_bp_type watchpoint_type;
335 /* For any breakpoint type with an address, this is the section
336 associated with the address. Used primarily for overlay
338 struct obj_section *section;
340 /* Address at which breakpoint was requested, either by the user or
341 by GDB for internal breakpoints. This will usually be the same
342 as ``address'' (above) except for cases in which
343 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
344 which to place the breakpoint in order to comply with a
345 processor's architectual constraints. */
346 CORE_ADDR requested_address;
350 /* Details of the placed breakpoint, when inserted. */
351 struct bp_target_info target_info;
353 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
354 struct bp_target_info overlay_target_info;
356 /* In a non-stop mode, it's possible that we delete a breakpoint,
357 but as we do that, some still running thread hits that breakpoint.
358 For that reason, we need to keep locations belonging to deleted
359 breakpoints for a bit, so that don't report unexpected SIGTRAP.
360 We can't keep such locations forever, so we use a heuristic --
361 after we process certain number of inferior events since
362 breakpoint was deleted, we retire all locations of that breakpoint.
363 This variable keeps a number of events still to go, when
364 it becomes 0 this location is retired. */
365 int events_till_retirement;
368 /* This structure is a collection of function pointers that, if available,
369 will be called instead of the performing the default action for this
372 struct breakpoint_ops
374 /* Insert the breakpoint or watchpoint or activate the catchpoint.
375 Return 0 for success, 1 if the breakpoint, watchpoint or catchpoint
376 type is not supported, -1 for failure. */
377 int (*insert_location) (struct bp_location *);
379 /* Remove the breakpoint/catchpoint that was previously inserted
380 with the "insert" method above. Return 0 for success, 1 if the
381 breakpoint, watchpoint or catchpoint type is not supported,
383 int (*remove_location) (struct bp_location *);
385 /* Return non-zero if the debugger should tell the user that this
386 breakpoint was hit. */
387 int (*breakpoint_hit) (struct breakpoint *);
389 /* Tell how many hardware resources (debug registers) are needed
390 for this breakpoint. If this function is not provided, then
391 the breakpoint or watchpoint needs one debug register. */
392 int (*resources_needed) (const struct bp_location *);
394 /* The normal print routine for this breakpoint, called when we
396 enum print_stop_action (*print_it) (struct breakpoint *);
398 /* Display information about this breakpoint, for "info
400 void (*print_one) (struct breakpoint *, struct bp_location **);
402 /* Display information about this breakpoint after setting it
403 (roughly speaking; this is called from "mention"). */
404 void (*print_mention) (struct breakpoint *);
406 /* Print to FP the CLI command that recreates this breakpoint. */
407 void (*print_recreate) (struct breakpoint *, struct ui_file *fp);
410 enum watchpoint_triggered
412 /* This watchpoint definitely did not trigger. */
413 watch_triggered_no = 0,
415 /* Some hardware watchpoint triggered, and it might have been this
416 one, but we do not know which it was. */
417 watch_triggered_unknown,
419 /* This hardware watchpoint definitely did trigger. */
423 /* This is used to declare the VEC syscalls_to_be_caught. */
426 typedef struct bp_location *bp_location_p;
427 DEF_VEC_P(bp_location_p);
429 /* A reference-counted struct command_line. This lets multiple
430 breakpoints share a single command list. This is an implementation
431 detail to the breakpoints module. */
432 struct counted_command_line;
434 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
435 a watchpoint over a memory region. If this flag is true, GDB will use
436 only one register per watchpoint, thus assuming that all acesses that
437 modify a memory location happen at its starting address. */
439 extern int target_exact_watchpoints;
441 /* Note that the ->silent field is not currently used by any commands
442 (though the code is in there if it was to be, and set_raw_breakpoint
443 does set it to 0). I implemented it because I thought it would be
444 useful for a hack I had to put in; I'm going to leave it in because
445 I can see how there might be times when it would indeed be useful */
447 /* This is for a breakpoint or a watchpoint. */
451 struct breakpoint *next;
452 /* Type of breakpoint. */
454 /* Zero means disabled; remember the info but don't break here. */
455 enum enable_state enable_state;
456 /* What to do with this breakpoint after we hit it. */
457 enum bpdisp disposition;
458 /* Number assigned to distinguish breakpoints. */
461 /* Location(s) associated with this high-level breakpoint. */
462 struct bp_location *loc;
464 /* Line number of this address. */
468 /* Source file name of this address. */
472 /* Non-zero means a silent breakpoint (don't print frame info
474 unsigned char silent;
475 /* Number of stops at this breakpoint that should
476 be continued automatically before really stopping. */
478 /* Chain of command lines to execute when this breakpoint is
480 struct counted_command_line *commands;
481 /* Stack depth (address of frame). If nonzero, break only if fp
483 struct frame_id frame_id;
485 /* The program space used to set the breakpoint. */
486 struct program_space *pspace;
488 /* String we used to set the breakpoint (malloc'd). */
490 /* Architecture we used to set the breakpoint. */
491 struct gdbarch *gdbarch;
492 /* Language we used to set the breakpoint. */
493 enum language language;
494 /* Input radix we used to set the breakpoint. */
496 /* String form of the breakpoint condition (malloc'd), or NULL if
497 there is no condition. */
499 /* String form of exp to use for displaying to the user
500 (malloc'd), or NULL if none. */
502 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
503 char *exp_string_reparse;
505 /* The expression we are watching, or NULL if not a watchpoint. */
506 struct expression *exp;
507 /* The largest block within which it is valid, or NULL if it is
508 valid anywhere (e.g. consists just of global symbols). */
509 struct block *exp_valid_block;
510 /* The conditional expression if any. NULL if not a watchpoint. */
511 struct expression *cond_exp;
512 /* The largest block within which it is valid, or NULL if it is
513 valid anywhere (e.g. consists just of global symbols). */
514 struct block *cond_exp_valid_block;
515 /* Value of the watchpoint the last time we checked it, or NULL
516 when we do not know the value yet or the value was not
517 readable. VAL is never lazy. */
519 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
520 then an error occurred reading the value. */
523 /* Holds the address of the related watchpoint_scope breakpoint
524 when using watchpoints on local variables (might the concept of
525 a related breakpoint be useful elsewhere, if not just call it
526 the watchpoint_scope breakpoint or something like that.
528 struct breakpoint *related_breakpoint;
530 /* Holds the frame address which identifies the frame this
531 watchpoint should be evaluated in, or `null' if the watchpoint
532 should be evaluated on the outermost frame. */
533 struct frame_id watchpoint_frame;
535 /* Holds the thread which identifies the frame this watchpoint
536 should be considered in scope for, or `null_ptid' if the
537 watchpoint should be evaluated in all threads. */
538 ptid_t watchpoint_thread;
540 /* For hardware watchpoints, the triggered status according to the
542 enum watchpoint_triggered watchpoint_triggered;
544 /* Thread number for thread-specific breakpoint,
545 or -1 if don't care. */
548 /* Ada task number for task-specific breakpoint,
549 or 0 if don't care. */
552 /* Count of the number of times this breakpoint was taken, dumped
553 with the info, but not used for anything else. Useful for
554 seeing how many times you hit a break prior to the program
555 aborting, so you can back up to just before the abort. */
558 /* Process id of a child process whose forking triggered this
559 catchpoint. This field is only valid immediately after this
560 catchpoint has triggered. */
561 ptid_t forked_inferior_pid;
563 /* Filename of a program whose exec triggered this catchpoint.
564 This field is only valid immediately after this catchpoint has
568 /* Syscall numbers used for the 'catch syscall' feature. If no
569 syscall has been specified for filtering, its value is NULL.
570 Otherwise, it holds a list of all syscalls to be caught. The
571 list elements are allocated with xmalloc. */
572 VEC(int) *syscalls_to_be_caught;
574 /* Methods associated with this breakpoint. */
575 struct breakpoint_ops *ops;
577 /* Is breakpoint's condition not yet parsed because we found
578 no location initially so had no context to parse
580 int condition_not_parsed;
582 /* Number of times this tracepoint should single-step
583 and collect additional data. */
586 /* Number of times this tracepoint should be hit before
590 /* The number of the tracepoint on the target. */
591 int number_on_target;
593 /* The static tracepoint marker id, if known. */
594 char *static_trace_marker_id;
596 /* LTTng/UST allow more than one marker with the same ID string,
597 although it unadvised because it confuses tools. When setting
598 static tracepoints by marker ID, this will record the index in
599 the array of markers we found for the given marker ID for which
600 this static tracepoint corresponds. When resetting
601 breakpoints, we will use this index to try to find the same
603 int static_trace_marker_id_idx;
605 /* With a Python scripting enabled GDB, store a reference to the
606 Python object that has been associated with this breakpoint.
607 This is always NULL for a GDB that is not script enabled. It
608 can sometimes be NULL for enabled GDBs as not all breakpoint
609 types are tracked by the Python scripting API. */
610 struct breakpoint_object *py_bp_object;
612 /* Whether this watchpoint is exact (see target_exact_watchpoints). */
616 typedef struct breakpoint *breakpoint_p;
617 DEF_VEC_P(breakpoint_p);
619 /* The following stuff is an abstract data type "bpstat" ("breakpoint
620 status"). This provides the ability to determine whether we have
621 stopped at a breakpoint, and what we should do about it. */
623 typedef struct bpstats *bpstat;
625 /* Clears a chain of bpstat, freeing storage
627 extern void bpstat_clear (bpstat *);
629 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
630 is part of the bpstat is copied as well. */
631 extern bpstat bpstat_copy (bpstat);
633 extern bpstat bpstat_stop_status (struct address_space *aspace,
634 CORE_ADDR pc, ptid_t ptid);
636 /* This bpstat_what stuff tells wait_for_inferior what to do with a
637 breakpoint (a challenging task).
639 The enum values order defines priority-like order of the actions.
640 Once you've decided that some action is appropriate, you'll never
641 go back and decide something of a lower priority is better. Each
642 of these actions is mutually exclusive with the others. That
643 means, that if you find yourself adding a new action class here and
644 wanting to tell GDB that you have two simultaneous actions to
645 handle, something is wrong, and you probably don't actually need a
648 Note that a step resume breakpoint overrides another breakpoint of
649 signal handling (see comment in wait_for_inferior at where we set
650 the step_resume breakpoint). */
652 enum bpstat_what_main_action
654 /* Perform various other tests; that is, this bpstat does not
655 say to perform any action (e.g. failed watchpoint and nothing
657 BPSTAT_WHAT_KEEP_CHECKING,
659 /* Remove breakpoints, single step once, then put them back in and
660 go back to what we were doing. It's possible that this should
661 be removed from the main_action and put into a separate field,
662 to more cleanly handle
663 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
666 /* Set longjmp_resume breakpoint, remove all other breakpoints,
667 and continue. The "remove all other breakpoints" part is
668 required if we are also stepping over another breakpoint as
669 well as doing the longjmp handling. */
670 BPSTAT_WHAT_SET_LONGJMP_RESUME,
672 /* Clear longjmp_resume breakpoint, then handle as
673 BPSTAT_WHAT_KEEP_CHECKING. */
674 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
676 /* Rather than distinguish between noisy and silent stops here, it
677 might be cleaner to have bpstat_print make that decision (also
678 taking into account stop_print_frame and source_only). But the
679 implications are a bit scary (interaction with auto-displays,
680 etc.), so I won't try it. */
683 BPSTAT_WHAT_STOP_SILENT,
685 /* Stop and print. */
686 BPSTAT_WHAT_STOP_NOISY,
688 /* Clear step resume breakpoint, and keep checking. */
689 BPSTAT_WHAT_STEP_RESUME,
692 /* An enum indicating the kind of "stack dummy" stop. This is a bit
693 of a misnomer because only one kind of truly a stack dummy. */
696 /* We didn't stop at a stack dummy breakpoint. */
699 /* Stopped at a stack dummy. */
702 /* Stopped at std::terminate. */
708 enum bpstat_what_main_action main_action;
710 /* Did we hit a call dummy breakpoint? This only goes with a
711 main_action of BPSTAT_WHAT_STOP_SILENT or
712 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
713 dummy without popping the frame is not a useful one). */
714 enum stop_stack_kind call_dummy;
716 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
717 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
718 longjmp, false if we are handling an exception. */
722 /* The possible return values for print_bpstat, print_it_normal,
723 print_it_done, print_it_noop. */
724 enum print_stop_action
732 /* Tell what to do about this bpstat. */
733 struct bpstat_what bpstat_what (bpstat);
735 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
736 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
738 /* Nonzero if a signal that we got in wait() was due to circumstances
739 explained by the BS. */
740 /* Currently that is true if we have hit a breakpoint, or if there is
741 a watchpoint enabled. */
742 #define bpstat_explains_signal(bs) ((bs) != NULL)
744 /* Nonzero is this bpstat causes a stop. */
745 extern int bpstat_causes_stop (bpstat);
747 /* Nonzero if we should step constantly (e.g. watchpoints on machines
748 without hardware support). This isn't related to a specific bpstat,
749 just to things like whether watchpoints are set. */
750 extern int bpstat_should_step (void);
752 /* Print a message indicating what happened. Returns nonzero to
753 say that only the source line should be printed after this (zero
754 return means print the frame as well as the source line). */
755 extern enum print_stop_action bpstat_print (bpstat);
757 /* Put in *NUM the breakpoint number of the first breakpoint we are
758 stopped at. *BSP upon return is a bpstat which points to the
759 remaining breakpoints stopped at (but which is not guaranteed to be
760 good for anything but further calls to bpstat_num).
762 Return 0 if passed a bpstat which does not indicate any breakpoints.
763 Return -1 if stopped at a breakpoint that has been deleted since
765 Return 1 otherwise. */
766 extern int bpstat_num (bpstat *, int *);
768 /* Perform actions associated with the stopped inferior. Actually, we
769 just use this for breakpoint commands. Perhaps other actions will
770 go here later, but this is executed at a late time (from the
772 extern void bpstat_do_actions (void);
774 /* Modify BS so that the actions will not be performed. */
775 extern void bpstat_clear_actions (bpstat);
777 /* Implementation: */
779 /* Values used to tell the printing routine how to behave for this
783 /* This is used when we want to do a normal printing of the reason
784 for stopping. The output will depend on the type of eventpoint
785 we are dealing with. This is the default value, most commonly
788 /* This is used when nothing should be printed for this bpstat
791 /* This is used when everything which needs to be printed has
792 already been printed. But we still want to print the frame. */
798 /* Linked list because there can be more than one breakpoint at
799 the same place, and a bpstat reflects the fact that all have
803 /* Location that caused the stop. Locations are refcounted, so
804 this will never be NULL. Note that this location may end up
805 detached from a breakpoint, but that does not necessary mean
806 that the struct breakpoint is gone. E.g., consider a
807 watchpoint with a condition that involves an inferior function
808 call. Watchpoint locations are recreated often (on resumes,
809 hence on infcalls too). Between creating the bpstat and after
810 evaluating the watchpoint condition, this location may hence
811 end up detached from its original owner watchpoint, even though
812 the watchpoint is still listed. If it's condition evaluates as
813 true, we still want this location to cause a stop, and we will
814 still need to know which watchpoint it was originally attached.
815 What this means is that we should not (in most cases) follow
816 the `bpstat->bp_location->owner' link, but instead use the
817 `breakpoint_at' field below. */
818 struct bp_location *bp_location_at;
820 /* Breakpoint that caused the stop. This is nullified if the
821 breakpoint ends up being deleted. See comments on
822 `bp_location_at' above for why do we need this field instead of
823 following the location's owner. */
824 struct breakpoint *breakpoint_at;
826 /* The associated command list. */
827 struct counted_command_line *commands;
829 /* Commands left to be done. This points somewhere in
831 struct command_line *commands_left;
833 /* Old value associated with a watchpoint. */
834 struct value *old_val;
836 /* Nonzero if this breakpoint tells us to print the frame. */
839 /* Nonzero if this breakpoint tells us to stop. */
842 /* Tell bpstat_print and print_bp_stop_message how to print stuff
843 associated with this element of the bpstat chain. */
844 enum bp_print_how print_it;
855 /* The possible return values for breakpoint_here_p.
856 We guarantee that zero always means "no breakpoint here". */
859 no_breakpoint_here = 0,
860 ordinary_breakpoint_here,
861 permanent_breakpoint_here
865 /* Prototypes for breakpoint-related functions. */
867 extern enum breakpoint_here breakpoint_here_p (struct address_space *,
870 extern int moribund_breakpoint_here_p (struct address_space *, CORE_ADDR);
872 extern int breakpoint_inserted_here_p (struct address_space *, CORE_ADDR);
874 extern int regular_breakpoint_inserted_here_p (struct address_space *,
877 extern int software_breakpoint_inserted_here_p (struct address_space *,
880 /* Returns true if there's a hardware watchpoint or access watchpoint
881 inserted in the range defined by ADDR and LEN. */
882 extern int hardware_watchpoint_inserted_in_range (struct address_space *,
886 extern int breakpoint_thread_match (struct address_space *,
889 extern void until_break_command (char *, int, int);
891 extern void breakpoint_re_set (void);
893 extern void breakpoint_re_set_thread (struct breakpoint *);
895 extern struct breakpoint *set_momentary_breakpoint
896 (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype);
898 extern struct breakpoint *set_momentary_breakpoint_at_pc
899 (struct gdbarch *, CORE_ADDR pc, enum bptype type);
901 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt);
903 extern void set_ignore_count (int, int, int);
905 extern void set_default_breakpoint (int, struct program_space *,
906 CORE_ADDR, struct symtab *, int);
908 extern void breakpoint_init_inferior (enum inf_context);
910 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
912 extern void delete_breakpoint (struct breakpoint *);
914 extern void breakpoint_auto_delete (bpstat);
916 /* Return the chain of command lines to execute when this breakpoint
918 extern struct command_line *breakpoint_commands (struct breakpoint *b);
920 extern void break_command (char *, int);
922 extern void hbreak_command_wrapper (char *, int);
923 extern void thbreak_command_wrapper (char *, int);
924 extern void rbreak_command_wrapper (char *, int);
925 extern void watch_command_wrapper (char *, int, int);
926 extern void awatch_command_wrapper (char *, int, int);
927 extern void rwatch_command_wrapper (char *, int, int);
928 extern void tbreak_command (char *, int);
930 extern int create_breakpoint (struct gdbarch *gdbarch, char *arg,
931 char *cond_string, int thread,
932 int parse_condition_and_thread,
933 int tempflag, enum bptype wanted_type,
935 enum auto_boolean pending_break_support,
936 struct breakpoint_ops *ops,
941 extern void insert_breakpoints (void);
943 extern int remove_breakpoints (void);
945 extern int remove_breakpoints_pid (int pid);
947 /* This function can be used to physically insert eventpoints from the
948 specified traced inferior process, without modifying the breakpoint
949 package's state. This can be useful for those targets which
950 support following the processes of a fork() or vfork() system call,
951 when both of the resulting two processes are to be followed. */
952 extern int reattach_breakpoints (int);
954 /* This function can be used to update the breakpoint package's state
955 after an exec() system call has been executed.
957 This function causes the following:
959 - All eventpoints are marked "not inserted".
960 - All eventpoints with a symbolic address are reset such that
961 the symbolic address must be reevaluated before the eventpoints
963 - The solib breakpoints are explicitly removed from the breakpoint
965 - A step-resume breakpoint, if any, is explicitly removed from the
967 - All eventpoints without a symbolic address are removed from the
969 extern void update_breakpoints_after_exec (void);
971 /* This function can be used to physically remove hardware breakpoints
972 and watchpoints from the specified traced inferior process, without
973 modifying the breakpoint package's state. This can be useful for
974 those targets which support following the processes of a fork() or
975 vfork() system call, when one of the resulting two processes is to
976 be detached and allowed to run free.
978 It is an error to use this function on the process whose id is
980 extern int detach_breakpoints (int);
982 /* This function is called when program space PSPACE is about to be
983 deleted. It takes care of updating breakpoints to not reference
984 this PSPACE anymore. */
985 extern void breakpoint_program_space_exit (struct program_space *pspace);
987 extern void set_longjmp_breakpoint (struct thread_info *tp,
988 struct frame_id frame);
989 extern void delete_longjmp_breakpoint (int thread);
991 extern void enable_overlay_breakpoints (void);
992 extern void disable_overlay_breakpoints (void);
994 extern void set_std_terminate_breakpoint (void);
995 extern void delete_std_terminate_breakpoint (void);
997 /* These functions respectively disable or reenable all currently
998 enabled watchpoints. When disabled, the watchpoints are marked
999 call_disabled. When reenabled, they are marked enabled.
1001 The intended client of these functions is call_function_by_hand.
1003 The inferior must be stopped, and all breakpoints removed, when
1004 these functions are used.
1006 The need for these functions is that on some targets (e.g., HP-UX),
1007 gdb is unable to unwind through the dummy frame that is pushed as
1008 part of the implementation of a call command. Watchpoints can
1009 cause the inferior to stop in places where this frame is visible,
1010 and that can cause execution control to become very confused.
1012 Note that if a user sets breakpoints in an interactively called
1013 function, the call_disabled watchpoints will have been reenabled
1014 when the first such breakpoint is reached. However, on targets
1015 that are unable to unwind through the call dummy frame, watches
1016 of stack-based storage may then be deleted, because gdb will
1017 believe that their watched storage is out of scope. (Sigh.) */
1018 extern void disable_watchpoints_before_interactive_call_start (void);
1020 extern void enable_watchpoints_after_interactive_call_stop (void);
1022 /* These functions disable and re-enable all breakpoints during
1023 inferior startup. They are intended to be called from solib
1024 code where necessary. This is needed on platforms where the
1025 main executable is relocated at some point during startup
1026 processing, making breakpoint addresses invalid.
1028 If additional breakpoints are created after the routine
1029 disable_breakpoints_before_startup but before the routine
1030 enable_breakpoints_after_startup was called, they will also
1031 be marked as disabled. */
1032 extern void disable_breakpoints_before_startup (void);
1033 extern void enable_breakpoints_after_startup (void);
1035 /* For script interpreters that need to define breakpoint commands
1036 after they've already read the commands into a struct
1038 extern enum command_control_type commands_from_control_command
1039 (char *arg, struct command_line *cmd);
1041 extern void clear_breakpoint_hit_counts (void);
1043 extern struct breakpoint *get_breakpoint (int num);
1045 /* The following are for displays, which aren't really breakpoints,
1046 but here is as good a place as any for them. */
1048 extern void disable_current_display (void);
1050 extern void do_displays (void);
1052 extern void disable_display (int);
1054 extern void clear_displays (void);
1056 extern void disable_breakpoint (struct breakpoint *);
1058 extern void enable_breakpoint (struct breakpoint *);
1060 extern void breakpoint_set_commands (struct breakpoint *b,
1061 struct command_line *commands);
1063 extern void breakpoint_set_silent (struct breakpoint *b, int silent);
1065 extern void breakpoint_set_thread (struct breakpoint *b, int thread);
1067 extern void breakpoint_set_task (struct breakpoint *b, int task);
1069 /* Clear the "inserted" flag in all breakpoints. */
1070 extern void mark_breakpoints_out (void);
1072 extern void make_breakpoint_permanent (struct breakpoint *);
1074 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *,
1077 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *,
1080 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *,
1083 extern void remove_jit_event_breakpoints (void);
1085 extern void remove_solib_event_breakpoints (void);
1087 extern void remove_thread_event_breakpoints (void);
1089 extern void disable_breakpoints_in_shlibs (void);
1091 /* This function returns TRUE if ep is a catchpoint. */
1092 extern int ep_is_catchpoint (struct breakpoint *);
1094 /* Enable breakpoints and delete when hit. Called with ARG == NULL
1095 deletes all breakpoints. */
1096 extern void delete_command (char *arg, int from_tty);
1098 /* Pull all H/W watchpoints from the target. Return non-zero if the
1100 extern int remove_hw_watchpoints (void);
1102 /* Manage a software single step breakpoint (or two). Insert may be
1103 called twice before remove is called. */
1104 extern void insert_single_step_breakpoint (struct gdbarch *,
1105 struct address_space *,
1107 extern int single_step_breakpoints_inserted (void);
1108 extern void remove_single_step_breakpoints (void);
1109 extern void cancel_single_step_breakpoints (void);
1111 /* Manage manual breakpoints, separate from the normal chain of
1112 breakpoints. These functions are used in murky target-specific
1113 ways. Please do not add more uses! */
1114 extern void *deprecated_insert_raw_breakpoint (struct gdbarch *,
1115 struct address_space *,
1117 extern int deprecated_remove_raw_breakpoint (struct gdbarch *, void *);
1119 /* Check if any hardware watchpoints have triggered, according to the
1121 int watchpoints_triggered (struct target_waitstatus *);
1123 /* Update BUF, which is LEN bytes read from the target address MEMADDR,
1124 by replacing any memory breakpoints with their shadowed contents. */
1125 void breakpoint_restore_shadows (gdb_byte *buf, ULONGEST memaddr,
1128 extern int breakpoints_always_inserted_mode (void);
1130 /* Called each time new event from target is processed.
1131 Retires previously deleted breakpoint locations that
1132 in our opinion won't ever trigger. */
1133 extern void breakpoint_retire_moribund (void);
1135 /* Set break condition of breakpoint B to EXP. */
1136 extern void set_breakpoint_condition (struct breakpoint *b, char *exp,
1139 /* Checks if we are catching syscalls or not.
1140 Returns 0 if not, greater than 0 if we are. */
1141 extern int catch_syscall_enabled (void);
1143 /* Checks if we are catching syscalls with the specific
1144 syscall_number. Used for "filtering" the catchpoints.
1145 Returns 0 if not, greater than 0 if we are. */
1146 extern int catching_syscall_number (int syscall_number);
1148 /* Return a tracepoint with the given number if found. */
1149 extern struct breakpoint *get_tracepoint (int num);
1151 extern struct breakpoint *get_tracepoint_by_number_on_target (int num);
1153 /* Find a tracepoint by parsing a number in the supplied string. */
1154 extern struct breakpoint *
1155 get_tracepoint_by_number (char **arg,
1156 struct get_number_or_range_state *state,
1159 /* Return a vector of all tracepoints currently defined. The vector
1160 is newly allocated; the caller should free when done with it. */
1161 extern VEC(breakpoint_p) *all_tracepoints (void);
1163 extern int is_tracepoint (const struct breakpoint *b);
1165 /* Return a vector of all static tracepoints defined at ADDR. The
1166 vector is newly allocated; the caller should free when done with
1168 extern VEC(breakpoint_p) *static_tracepoints_here (CORE_ADDR addr);
1170 /* Function that can be passed to read_command_line to validate
1171 that each command is suitable for tracepoint command list. */
1172 extern void check_tracepoint_command (char *line, void *closure);
1174 /* Call at the start and end of an "rbreak" command to register
1175 breakpoint numbers for a later "commands" command. */
1176 extern void start_rbreak_breakpoints (void);
1177 extern void end_rbreak_breakpoints (void);
1179 /* Breakpoint iterator function.
1181 Calls a callback function once for each breakpoint, so long as the
1182 callback function returns false. If the callback function returns
1183 true, the iteration will end and the current breakpoint will be
1184 returned. This can be useful for implementing a search for a
1185 breakpoint with arbitrary attributes, or for applying an operation
1186 to every breakpoint. */
1187 extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *,
1190 extern int user_breakpoint_p (struct breakpoint *);
1192 #endif /* !defined (BREAKPOINT_H) */
OSDN Git Service
