1 /* Data structures associated with breakpoints in GDB.
2 Copyright (C) 1992-2004, 2007-2012 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19 #if !defined (BREAKPOINT_H)
20 #define BREAKPOINT_H 1
29 struct breakpoint_object;
30 struct get_number_or_range_state;
34 struct linespec_result;
37 /* This is the maximum number of bytes a breakpoint instruction can
38 take. Feel free to increase it. It's just used in a few places to
39 size arrays that should be independent of the target
42 #define BREAKPOINT_MAX 16
45 /* Type of breakpoint. */
46 /* FIXME In the future, we should fold all other breakpoint-like
47 things into here. This includes:
49 * single-step (for machines where we have to simulate single
50 stepping) (probably, though perhaps it is better for it to look as
51 much as possible like a single-step to wait_for_inferior). */
55 bp_none = 0, /* Eventpoint has been deleted */
56 bp_breakpoint, /* Normal breakpoint */
57 bp_hardware_breakpoint, /* Hardware assisted breakpoint */
58 bp_until, /* used by until command */
59 bp_finish, /* used by finish command */
60 bp_watchpoint, /* Watchpoint */
61 bp_hardware_watchpoint, /* Hardware assisted watchpoint */
62 bp_read_watchpoint, /* read watchpoint, (hardware assisted) */
63 bp_access_watchpoint, /* access watchpoint, (hardware assisted) */
64 bp_longjmp, /* secret breakpoint to find longjmp() */
65 bp_longjmp_resume, /* secret breakpoint to escape longjmp() */
67 /* An internal breakpoint that is installed on the unwinder's
70 /* An internal breakpoint that is set at the point where an
71 exception will land. */
74 /* Used by wait_for_inferior for stepping over subroutine calls,
75 and for skipping prologues. */
78 /* Used by wait_for_inferior for stepping over signal
82 /* Used to detect when a watchpoint expression has gone out of
83 scope. These breakpoints are usually not visible to the user.
85 This breakpoint has some interesting properties:
87 1) There's always a 1:1 mapping between watchpoints
88 on local variables and watchpoint_scope breakpoints.
90 2) It automatically deletes itself and the watchpoint it's
91 associated with when hit.
93 3) It can never be disabled. */
96 /* The breakpoint at the end of a call dummy. */
97 /* FIXME: What if the function we are calling longjmp()s out of
98 the call, or the user gets out with the "return" command? We
99 currently have no way of cleaning up the breakpoint in these
100 (obscure) situations. (Probably can solve this by noticing
101 longjmp, "return", etc., it's similar to noticing when a
102 watchpoint on a local variable goes out of scope (with hardware
103 support for watchpoints)). */
106 /* A breakpoint set on std::terminate, that is used to catch
107 otherwise uncaught exceptions thrown during an inferior call. */
110 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
111 code in the inferior to run when significant events occur in the
112 dynamic linker (for example a library is loaded or unloaded).
114 By placing a breakpoint in this magic code GDB will get control
115 when these significant events occur. GDB can then re-examine
116 the dynamic linker's data structures to discover any newly loaded
117 dynamic libraries. */
120 /* Some multi-threaded systems can arrange for a location in the
121 inferior to be executed when certain thread-related events occur
122 (such as thread creation or thread death).
124 By placing a breakpoint at one of these locations, GDB will get
125 control when these events occur. GDB can then update its thread
130 /* On the same principal, an overlay manager can arrange to call a
131 magic location in the inferior whenever there is an interesting
132 change in overlay status. GDB can update its overlay tables
133 and fiddle with breakpoints in overlays when this breakpoint
138 /* Master copies of longjmp breakpoints. These are always installed
139 as soon as an objfile containing longjmp is loaded, but they are
140 always disabled. While necessary, temporary clones of bp_longjmp
141 type will be created and enabled. */
145 /* Master copies of std::terminate breakpoints. */
146 bp_std_terminate_master,
148 /* Like bp_longjmp_master, but for exceptions. */
155 bp_static_tracepoint,
157 /* Event for JIT compiled code generation or deletion. */
160 /* Breakpoint is placed at the STT_GNU_IFUNC resolver. When hit GDB
161 inserts new bp_gnu_ifunc_resolver_return at the caller.
162 bp_gnu_ifunc_resolver is still being kept here as a different thread
163 may still hit it before bp_gnu_ifunc_resolver_return is hit by the
165 bp_gnu_ifunc_resolver,
167 /* On its hit GDB now know the resolved address of the target
168 STT_GNU_IFUNC function. Associated bp_gnu_ifunc_resolver can be
169 deleted now and the breakpoint moved to the target function entry
171 bp_gnu_ifunc_resolver_return,
174 /* States of enablement of breakpoint. */
178 bp_disabled, /* The eventpoint is inactive, and cannot
180 bp_enabled, /* The eventpoint is active, and can
182 bp_call_disabled, /* The eventpoint has been disabled while a
183 call into the inferior is "in flight",
184 because some eventpoints interfere with
185 the implementation of a call on some
186 targets. The eventpoint will be
187 automatically enabled and reset when the
188 call "lands" (either completes, or stops
189 at another eventpoint). */
190 bp_permanent /* There is a breakpoint instruction
191 hard-wired into the target's code. Don't
192 try to write another breakpoint
193 instruction on top of it, or restore its
194 value. Step over it using the
195 architecture's SKIP_INSN macro. */
199 /* Disposition of breakpoint. Ie: what to do after hitting it. */
203 disp_del, /* Delete it */
204 disp_del_at_next_stop, /* Delete at next stop,
205 whether hit or not */
206 disp_disable, /* Disable it */
207 disp_donttouch /* Leave it alone */
210 enum target_hw_bp_type
212 hw_write = 0, /* Common HW watchpoint */
213 hw_read = 1, /* Read HW watchpoint */
214 hw_access = 2, /* Access HW watchpoint */
215 hw_execute = 3 /* Execute HW breakpoint */
219 /* Status of breakpoint conditions used when synchronizing
220 conditions with the target. */
222 enum condition_status
224 condition_unchanged = 0,
229 /* Information used by targets to insert and remove breakpoints. */
231 struct bp_target_info
233 /* Address space at which the breakpoint was placed. */
234 struct address_space *placed_address_space;
236 /* Address at which the breakpoint was placed. This is normally the
237 same as ADDRESS from the bp_location, except when adjustment
238 happens in gdbarch_breakpoint_from_pc. The most common form of
239 adjustment is stripping an alternate ISA marker from the PC which
240 is used to determine the type of breakpoint to insert. */
241 CORE_ADDR placed_address;
243 /* If this is a ranged breakpoint, then this field contains the
244 length of the range that will be watched for execution. */
247 /* If the breakpoint lives in memory and reading that memory would
248 give back the breakpoint, instead of the original contents, then
249 the original contents are cached here. Only SHADOW_LEN bytes of
250 this buffer are valid, and only when the breakpoint is inserted. */
251 gdb_byte shadow_contents[BREAKPOINT_MAX];
253 /* The length of the data cached in SHADOW_CONTENTS. */
256 /* The size of the placed breakpoint, according to
257 gdbarch_breakpoint_from_pc, when the breakpoint was inserted.
258 This is generally the same as SHADOW_LEN, unless we did not need
259 to read from the target to implement the memory breakpoint
260 (e.g. if a remote stub handled the details). We may still need
261 the size to remove the breakpoint safely. */
264 /* Vector of conditions the target should evaluate if it supports target-side
265 breakpoint conditions. */
266 VEC(agent_expr_p) *conditions;
269 /* GDB maintains two types of information about each breakpoint (or
270 watchpoint, or other related event). The first type corresponds
271 to struct breakpoint; this is a relatively high-level structure
272 which contains the source location(s), stopping conditions, user
273 commands to execute when the breakpoint is hit, and so forth.
275 The second type of information corresponds to struct bp_location.
276 Each breakpoint has one or (eventually) more locations associated
277 with it, which represent target-specific and machine-specific
278 mechanisms for stopping the program. For instance, a watchpoint
279 expression may require multiple hardware watchpoints in order to
280 catch all changes in the value of the expression being watched. */
284 bp_loc_software_breakpoint,
285 bp_loc_hardware_breakpoint,
286 bp_loc_hardware_watchpoint,
287 bp_loc_other /* Miscellaneous... */
290 /* This structure is a collection of function pointers that, if
291 available, will be called instead of performing the default action
292 for this bp_loc_type. */
294 struct bp_location_ops
296 /* Destructor. Releases everything from SELF (but not SELF
298 void (*dtor) (struct bp_location *self);
303 /* Chain pointer to the next breakpoint location for
304 the same parent breakpoint. */
305 struct bp_location *next;
307 /* Methods associated with this location. */
308 const struct bp_location_ops *ops;
310 /* The reference count. */
313 /* Type of this breakpoint location. */
314 enum bp_loc_type loc_type;
316 /* Each breakpoint location must belong to exactly one higher-level
317 breakpoint. This pointer is NULL iff this bp_location is no
318 longer attached to a breakpoint. For example, when a breakpoint
319 is deleted, its locations may still be found in the
320 moribund_locations list, or if we had stopped for it, in
322 struct breakpoint *owner;
324 /* Conditional. Break only if this expression's value is nonzero.
325 Unlike string form of condition, which is associated with
326 breakpoint, this is associated with location, since if breakpoint
327 has several locations, the evaluation of expression can be
328 different for different locations. Only valid for real
329 breakpoints; a watchpoint's conditional expression is stored in
330 the owner breakpoint object. */
331 struct expression *cond;
333 /* Conditional expression in agent expression
334 bytecode form. This is used for stub-side breakpoint
335 condition evaluation. */
336 struct agent_expr *cond_bytecode;
338 /* Signals that the condition has changed since the last time
339 we updated the global location list. This means the condition
340 needs to be sent to the target again. This is used together
341 with target-side breakpoint conditions.
343 condition_unchanged: It means there has been no condition changes.
345 condition_modified: It means this location had its condition modified.
347 condition_updated: It means we already marked all the locations that are
348 duplicates of this location and thus we don't need to call
349 force_breakpoint_reinsertion (...) for this location. */
351 enum condition_status condition_changed;
353 /* Signals that breakpoint conditions need to be re-synched with the
354 target. This has no use other than target-side breakpoints. */
357 /* This location's address is in an unloaded solib, and so this
358 location should not be inserted. It will be automatically
359 enabled when that solib is loaded. */
362 /* Is this particular location enabled. */
365 /* Nonzero if this breakpoint is now inserted. */
368 /* Nonzero if this is not the first breakpoint in the list
369 for the given address. location of tracepoint can _never_
370 be duplicated with other locations of tracepoints and other
371 kinds of breakpoints, because two locations at the same
372 address may have different actions, so both of these locations
373 should be downloaded and so that `tfind N' always works. */
376 /* If we someday support real thread-specific breakpoints, then
377 the breakpoint location will need a thread identifier. */
379 /* Data for specific breakpoint types. These could be a union, but
380 simplicity is more important than memory usage for breakpoints. */
382 /* Architecture associated with this location's address. May be
383 different from the breakpoint architecture. */
384 struct gdbarch *gdbarch;
386 /* The program space associated with this breakpoint location
387 address. Note that an address space may be represented in more
388 than one program space (e.g. each uClinux program will be given
389 its own program space, but there will only be one address space
390 for all of them), but we must not insert more than one location
391 at the same address in the same address space. */
392 struct program_space *pspace;
394 /* Note that zero is a perfectly valid code address on some platforms
395 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
396 is not a special value for this field. Valid for all types except
400 /* For hardware watchpoints, the size of the memory region being
401 watched. For hardware ranged breakpoints, the size of the
405 /* Type of hardware watchpoint. */
406 enum target_hw_bp_type watchpoint_type;
408 /* For any breakpoint type with an address, this is the section
409 associated with the address. Used primarily for overlay
411 struct obj_section *section;
413 /* Address at which breakpoint was requested, either by the user or
414 by GDB for internal breakpoints. This will usually be the same
415 as ``address'' (above) except for cases in which
416 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
417 which to place the breakpoint in order to comply with a
418 processor's architectual constraints. */
419 CORE_ADDR requested_address;
423 /* Details of the placed breakpoint, when inserted. */
424 struct bp_target_info target_info;
426 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
427 struct bp_target_info overlay_target_info;
429 /* In a non-stop mode, it's possible that we delete a breakpoint,
430 but as we do that, some still running thread hits that breakpoint.
431 For that reason, we need to keep locations belonging to deleted
432 breakpoints for a bit, so that don't report unexpected SIGTRAP.
433 We can't keep such locations forever, so we use a heuristic --
434 after we process certain number of inferior events since
435 breakpoint was deleted, we retire all locations of that breakpoint.
436 This variable keeps a number of events still to go, when
437 it becomes 0 this location is retired. */
438 int events_till_retirement;
440 /* Line number of this address. */
444 /* Source file name of this address. */
449 /* This structure is a collection of function pointers that, if available,
450 will be called instead of the performing the default action for this
453 struct breakpoint_ops
455 /* Destructor. Releases everything from SELF (but not SELF
457 void (*dtor) (struct breakpoint *self);
459 /* Allocate a location for this breakpoint. */
460 struct bp_location * (*allocate_location) (struct breakpoint *);
462 /* Reevaluate a breakpoint. This is necessary after symbols change
463 (e.g., an executable or DSO was loaded, or the inferior just
465 void (*re_set) (struct breakpoint *self);
467 /* Insert the breakpoint or watchpoint or activate the catchpoint.
468 Return 0 for success, 1 if the breakpoint, watchpoint or
469 catchpoint type is not supported, -1 for failure. */
470 int (*insert_location) (struct bp_location *);
472 /* Remove the breakpoint/catchpoint that was previously inserted
473 with the "insert" method above. Return 0 for success, 1 if the
474 breakpoint, watchpoint or catchpoint type is not supported,
476 int (*remove_location) (struct bp_location *);
478 /* Return true if it the target has stopped due to hitting
479 breakpoint location BL. This function does not check if we
480 should stop, only if BL explains the stop. ASPACE is the address
481 space in which the event occurred, BP_ADDR is the address at
482 which the inferior stopped, and WS is the target_waitstatus
483 describing the event. */
484 int (*breakpoint_hit) (const struct bp_location *bl,
485 struct address_space *aspace,
487 const struct target_waitstatus *ws);
489 /* Check internal conditions of the breakpoint referred to by BS.
490 If we should not stop for this breakpoint, set BS->stop to 0. */
491 void (*check_status) (struct bpstats *bs);
493 /* Tell how many hardware resources (debug registers) are needed
494 for this breakpoint. If this function is not provided, then
495 the breakpoint or watchpoint needs one debug register. */
496 int (*resources_needed) (const struct bp_location *);
498 /* Tell whether we can downgrade from a hardware watchpoint to a software
499 one. If not, the user will not be able to enable the watchpoint when
500 there are not enough hardware resources available. */
501 int (*works_in_software_mode) (const struct breakpoint *);
503 /* The normal print routine for this breakpoint, called when we
505 enum print_stop_action (*print_it) (struct bpstats *bs);
507 /* Display information about this breakpoint, for "info
509 void (*print_one) (struct breakpoint *, struct bp_location **);
511 /* Display extra information about this breakpoint, below the normal
512 breakpoint description in "info breakpoints".
514 In the example below, the "address range" line was printed
515 by print_one_detail_ranged_breakpoint.
517 (gdb) info breakpoints
518 Num Type Disp Enb Address What
519 2 hw breakpoint keep y in main at test-watch.c:70
520 address range: [0x10000458, 0x100004c7]
523 void (*print_one_detail) (const struct breakpoint *, struct ui_out *);
525 /* Display information about this breakpoint after setting it
526 (roughly speaking; this is called from "mention"). */
527 void (*print_mention) (struct breakpoint *);
529 /* Print to FP the CLI command that recreates this breakpoint. */
530 void (*print_recreate) (struct breakpoint *, struct ui_file *fp);
532 /* Create SALs from address string, storing the result in linespec_result.
534 For an explanation about the arguments, see the function
535 `create_sals_from_address_default'.
537 This function is called inside `create_breakpoint'. */
538 void (*create_sals_from_address) (char **, struct linespec_result *,
539 enum bptype, char *, char **);
541 /* This method will be responsible for creating a breakpoint given its SALs.
542 Usually, it just calls `create_breakpoints_sal' (for ordinary
543 breakpoints). However, there may be some special cases where we might
544 need to do some tweaks, e.g., see
545 `strace_marker_create_breakpoints_sal'.
547 This function is called inside `create_breakpoint'. */
548 void (*create_breakpoints_sal) (struct gdbarch *,
549 struct linespec_result *,
550 struct linespec_sals *, char *,
551 enum bptype, enum bpdisp, int, int,
552 int, const struct breakpoint_ops *,
555 /* Given the address string (second parameter), this method decodes it
556 and provides the SAL locations related to it. For ordinary breakpoints,
557 it calls `decode_line_full'.
559 This function is called inside `addr_string_to_sals'. */
560 void (*decode_linespec) (struct breakpoint *, char **,
561 struct symtabs_and_lines *);
564 /* Helper for breakpoint_ops->print_recreate implementations. Prints
565 the "thread" or "task" condition of B, and then a newline.
567 Necessary because most breakpoint implementations accept
568 thread/task conditions at the end of the spec line, like "break foo
569 thread 1", which needs outputting before any breakpoint-type
570 specific extra command necessary for B's recreation. */
571 extern void print_recreate_thread (struct breakpoint *b, struct ui_file *fp);
573 enum watchpoint_triggered
575 /* This watchpoint definitely did not trigger. */
576 watch_triggered_no = 0,
578 /* Some hardware watchpoint triggered, and it might have been this
579 one, but we do not know which it was. */
580 watch_triggered_unknown,
582 /* This hardware watchpoint definitely did trigger. */
586 /* This is used to declare the VEC syscalls_to_be_caught. */
589 typedef struct bp_location *bp_location_p;
590 DEF_VEC_P(bp_location_p);
592 /* A reference-counted struct command_line. This lets multiple
593 breakpoints share a single command list. This is an implementation
594 detail to the breakpoints module. */
595 struct counted_command_line;
597 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
598 a watchpoint over a memory region. If this flag is true, GDB will use
599 only one register per watchpoint, thus assuming that all acesses that
600 modify a memory location happen at its starting address. */
602 extern int target_exact_watchpoints;
604 /* Note that the ->silent field is not currently used by any commands
605 (though the code is in there if it was to be, and set_raw_breakpoint
606 does set it to 0). I implemented it because I thought it would be
607 useful for a hack I had to put in; I'm going to leave it in because
608 I can see how there might be times when it would indeed be useful */
610 /* This is for all kinds of breakpoints. */
614 /* Methods associated with this breakpoint. */
615 const struct breakpoint_ops *ops;
617 struct breakpoint *next;
618 /* Type of breakpoint. */
620 /* Zero means disabled; remember the info but don't break here. */
621 enum enable_state enable_state;
622 /* What to do with this breakpoint after we hit it. */
623 enum bpdisp disposition;
624 /* Number assigned to distinguish breakpoints. */
627 /* Location(s) associated with this high-level breakpoint. */
628 struct bp_location *loc;
630 /* Non-zero means a silent breakpoint (don't print frame info
632 unsigned char silent;
633 /* Non-zero means display ADDR_STRING to the user verbatim. */
634 unsigned char display_canonical;
635 /* Number of stops at this breakpoint that should
636 be continued automatically before really stopping. */
639 /* Number of stops at this breakpoint before it will be
643 /* Chain of command lines to execute when this breakpoint is
645 struct counted_command_line *commands;
646 /* Stack depth (address of frame). If nonzero, break only if fp
648 struct frame_id frame_id;
650 /* The program space used to set the breakpoint. This is only set
651 for breakpoints which are specific to a program space; for
652 non-thread-specific ordinary breakpoints this is NULL. */
653 struct program_space *pspace;
655 /* String we used to set the breakpoint (malloc'd). */
658 /* The filter that should be passed to decode_line_full when
659 re-setting this breakpoint. This may be NULL, but otherwise is
660 allocated with xmalloc. */
663 /* For a ranged breakpoint, the string we used to find
664 the end of the range (malloc'd). */
665 char *addr_string_range_end;
667 /* Architecture we used to set the breakpoint. */
668 struct gdbarch *gdbarch;
669 /* Language we used to set the breakpoint. */
670 enum language language;
671 /* Input radix we used to set the breakpoint. */
673 /* String form of the breakpoint condition (malloc'd), or NULL if
674 there is no condition. */
676 /* String form of exp to use for displaying to the user
677 (malloc'd), or NULL if none. */
679 /* Holds the address of the related watchpoint_scope breakpoint
680 when using watchpoints on local variables (might the concept of
681 a related breakpoint be useful elsewhere, if not just call it
682 the watchpoint_scope breakpoint or something like that.
684 struct breakpoint *related_breakpoint;
686 /* Thread number for thread-specific breakpoint,
687 or -1 if don't care. */
690 /* Ada task number for task-specific breakpoint,
691 or 0 if don't care. */
694 /* Count of the number of times this breakpoint was taken, dumped
695 with the info, but not used for anything else. Useful for
696 seeing how many times you hit a break prior to the program
697 aborting, so you can back up to just before the abort. */
700 /* Is breakpoint's condition not yet parsed because we found
701 no location initially so had no context to parse
703 int condition_not_parsed;
705 /* With a Python scripting enabled GDB, store a reference to the
706 Python object that has been associated with this breakpoint.
707 This is always NULL for a GDB that is not script enabled. It
708 can sometimes be NULL for enabled GDBs as not all breakpoint
709 types are tracked by the Python scripting API. */
710 struct breakpoint_object *py_bp_object;
713 /* An instance of this type is used to represent a watchpoint. It
714 includes a "struct breakpoint" as a kind of base class; users
715 downcast to "struct breakpoint *" when needed. */
719 /* The base class. */
720 struct breakpoint base;
722 /* String form of exp to use for displaying to the user (malloc'd),
725 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
726 char *exp_string_reparse;
728 /* The expression we are watching, or NULL if not a watchpoint. */
729 struct expression *exp;
730 /* The largest block within which it is valid, or NULL if it is
731 valid anywhere (e.g. consists just of global symbols). */
732 struct block *exp_valid_block;
733 /* The conditional expression if any. */
734 struct expression *cond_exp;
735 /* The largest block within which it is valid, or NULL if it is
736 valid anywhere (e.g. consists just of global symbols). */
737 struct block *cond_exp_valid_block;
738 /* Value of the watchpoint the last time we checked it, or NULL when
739 we do not know the value yet or the value was not readable. VAL
742 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
743 then an error occurred reading the value. */
746 /* Holds the frame address which identifies the frame this
747 watchpoint should be evaluated in, or `null' if the watchpoint
748 should be evaluated on the outermost frame. */
749 struct frame_id watchpoint_frame;
751 /* Holds the thread which identifies the frame this watchpoint
752 should be considered in scope for, or `null_ptid' if the
753 watchpoint should be evaluated in all threads. */
754 ptid_t watchpoint_thread;
756 /* For hardware watchpoints, the triggered status according to the
758 enum watchpoint_triggered watchpoint_triggered;
760 /* Whether this watchpoint is exact (see
761 target_exact_watchpoints). */
764 /* The mask address for a masked hardware watchpoint. */
765 CORE_ADDR hw_wp_mask;
768 /* Return true if BPT is either a software breakpoint or a hardware
771 extern int is_breakpoint (const struct breakpoint *bpt);
773 /* Returns true if BPT is really a watchpoint. */
775 extern int is_watchpoint (const struct breakpoint *bpt);
777 /* An instance of this type is used to represent all kinds of
778 tracepoints. It includes a "struct breakpoint" as a kind of base
779 class; users downcast to "struct breakpoint *" when needed. */
783 /* The base class. */
784 struct breakpoint base;
786 /* Number of times this tracepoint should single-step and collect
790 /* Number of times this tracepoint should be hit before
794 /* The number of the tracepoint on the target. */
795 int number_on_target;
797 /* The total space taken by all the trace frames for this
799 ULONGEST traceframe_usage;
801 /* The static tracepoint marker id, if known. */
802 char *static_trace_marker_id;
804 /* LTTng/UST allow more than one marker with the same ID string,
805 although it unadvised because it confuses tools. When setting
806 static tracepoints by marker ID, this will record the index in
807 the array of markers we found for the given marker ID for which
808 this static tracepoint corresponds. When resetting breakpoints,
809 we will use this index to try to find the same marker again. */
810 int static_trace_marker_id_idx;
813 typedef struct breakpoint *breakpoint_p;
814 DEF_VEC_P(breakpoint_p);
816 /* The following stuff is an abstract data type "bpstat" ("breakpoint
817 status"). This provides the ability to determine whether we have
818 stopped at a breakpoint, and what we should do about it. */
820 typedef struct bpstats *bpstat;
822 /* Clears a chain of bpstat, freeing storage
824 extern void bpstat_clear (bpstat *);
826 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
827 is part of the bpstat is copied as well. */
828 extern bpstat bpstat_copy (bpstat);
830 extern bpstat bpstat_stop_status (struct address_space *aspace,
831 CORE_ADDR pc, ptid_t ptid,
832 const struct target_waitstatus *ws);
834 /* This bpstat_what stuff tells wait_for_inferior what to do with a
835 breakpoint (a challenging task).
837 The enum values order defines priority-like order of the actions.
838 Once you've decided that some action is appropriate, you'll never
839 go back and decide something of a lower priority is better. Each
840 of these actions is mutually exclusive with the others. That
841 means, that if you find yourself adding a new action class here and
842 wanting to tell GDB that you have two simultaneous actions to
843 handle, something is wrong, and you probably don't actually need a
846 Note that a step resume breakpoint overrides another breakpoint of
847 signal handling (see comment in wait_for_inferior at where we set
848 the step_resume breakpoint). */
850 enum bpstat_what_main_action
852 /* Perform various other tests; that is, this bpstat does not
853 say to perform any action (e.g. failed watchpoint and nothing
855 BPSTAT_WHAT_KEEP_CHECKING,
857 /* Remove breakpoints, single step once, then put them back in and
858 go back to what we were doing. It's possible that this should
859 be removed from the main_action and put into a separate field,
860 to more cleanly handle
861 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
864 /* Set longjmp_resume breakpoint, remove all other breakpoints,
865 and continue. The "remove all other breakpoints" part is
866 required if we are also stepping over another breakpoint as
867 well as doing the longjmp handling. */
868 BPSTAT_WHAT_SET_LONGJMP_RESUME,
870 /* Clear longjmp_resume breakpoint, then handle as
871 BPSTAT_WHAT_KEEP_CHECKING. */
872 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
874 /* Clear step resume breakpoint, and keep checking. */
875 BPSTAT_WHAT_STEP_RESUME,
877 /* Rather than distinguish between noisy and silent stops here, it
878 might be cleaner to have bpstat_print make that decision (also
879 taking into account stop_print_frame and source_only). But the
880 implications are a bit scary (interaction with auto-displays,
881 etc.), so I won't try it. */
884 BPSTAT_WHAT_STOP_SILENT,
886 /* Stop and print. */
887 BPSTAT_WHAT_STOP_NOISY,
889 /* Clear step resume breakpoint, and keep checking. High-priority
890 step-resume breakpoints are used when even if there's a user
891 breakpoint at the current PC when we set the step-resume
892 breakpoint, we don't want to re-handle any breakpoint other
893 than the step-resume when it's hit; instead we want to move
894 past the breakpoint. This is used in the case of skipping
896 BPSTAT_WHAT_HP_STEP_RESUME,
899 /* An enum indicating the kind of "stack dummy" stop. This is a bit
900 of a misnomer because only one kind of truly a stack dummy. */
903 /* We didn't stop at a stack dummy breakpoint. */
906 /* Stopped at a stack dummy. */
909 /* Stopped at std::terminate. */
915 enum bpstat_what_main_action main_action;
917 /* Did we hit a call dummy breakpoint? This only goes with a
918 main_action of BPSTAT_WHAT_STOP_SILENT or
919 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
920 dummy without popping the frame is not a useful one). */
921 enum stop_stack_kind call_dummy;
923 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
924 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
925 longjmp, false if we are handling an exception. */
929 /* The possible return values for print_bpstat, print_it_normal,
930 print_it_done, print_it_noop. */
931 enum print_stop_action
933 /* We printed nothing or we need to do some more analysis. */
936 /* We printed something, and we *do* desire that something to be
937 followed by a location. */
940 /* We printed something, and we do *not* desire that something to
941 be followed by a location. */
944 /* We already printed all we needed to print, don't print anything
949 /* Tell what to do about this bpstat. */
950 struct bpstat_what bpstat_what (bpstat);
952 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
953 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
955 /* Nonzero if a signal that we got in wait() was due to circumstances
956 explained by the BS. */
957 /* Currently that is true if we have hit a breakpoint, or if there is
958 a watchpoint enabled. */
959 #define bpstat_explains_signal(bs) ((bs) != NULL)
961 /* Nonzero is this bpstat causes a stop. */
962 extern int bpstat_causes_stop (bpstat);
964 /* Nonzero if we should step constantly (e.g. watchpoints on machines
965 without hardware support). This isn't related to a specific bpstat,
966 just to things like whether watchpoints are set. */
967 extern int bpstat_should_step (void);
969 /* Print a message indicating what happened. Returns nonzero to
970 say that only the source line should be printed after this (zero
971 return means print the frame as well as the source line). */
972 extern enum print_stop_action bpstat_print (bpstat, int);
974 /* Put in *NUM the breakpoint number of the first breakpoint we are
975 stopped at. *BSP upon return is a bpstat which points to the
976 remaining breakpoints stopped at (but which is not guaranteed to be
977 good for anything but further calls to bpstat_num).
979 Return 0 if passed a bpstat which does not indicate any breakpoints.
980 Return -1 if stopped at a breakpoint that has been deleted since
982 Return 1 otherwise. */
983 extern int bpstat_num (bpstat *, int *);
985 /* Perform actions associated with the stopped inferior. Actually, we
986 just use this for breakpoint commands. Perhaps other actions will
987 go here later, but this is executed at a late time (from the
989 extern void bpstat_do_actions (void);
991 /* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will
993 extern void bpstat_clear_actions (void);
995 /* Implementation: */
997 /* Values used to tell the printing routine how to behave for this
1001 /* This is used when we want to do a normal printing of the reason
1002 for stopping. The output will depend on the type of eventpoint
1003 we are dealing with. This is the default value, most commonly
1006 /* This is used when nothing should be printed for this bpstat
1009 /* This is used when everything which needs to be printed has
1010 already been printed. But we still want to print the frame. */
1016 /* Linked list because there can be more than one breakpoint at
1017 the same place, and a bpstat reflects the fact that all have
1021 /* Location that caused the stop. Locations are refcounted, so
1022 this will never be NULL. Note that this location may end up
1023 detached from a breakpoint, but that does not necessary mean
1024 that the struct breakpoint is gone. E.g., consider a
1025 watchpoint with a condition that involves an inferior function
1026 call. Watchpoint locations are recreated often (on resumes,
1027 hence on infcalls too). Between creating the bpstat and after
1028 evaluating the watchpoint condition, this location may hence
1029 end up detached from its original owner watchpoint, even though
1030 the watchpoint is still listed. If it's condition evaluates as
1031 true, we still want this location to cause a stop, and we will
1032 still need to know which watchpoint it was originally attached.
1033 What this means is that we should not (in most cases) follow
1034 the `bpstat->bp_location->owner' link, but instead use the
1035 `breakpoint_at' field below. */
1036 struct bp_location *bp_location_at;
1038 /* Breakpoint that caused the stop. This is nullified if the
1039 breakpoint ends up being deleted. See comments on
1040 `bp_location_at' above for why do we need this field instead of
1041 following the location's owner. */
1042 struct breakpoint *breakpoint_at;
1044 /* The associated command list. */
1045 struct counted_command_line *commands;
1047 /* Old value associated with a watchpoint. */
1048 struct value *old_val;
1050 /* Nonzero if this breakpoint tells us to print the frame. */
1053 /* Nonzero if this breakpoint tells us to stop. */
1056 /* Tell bpstat_print and print_bp_stop_message how to print stuff
1057 associated with this element of the bpstat chain. */
1058 enum bp_print_how print_it;
1069 /* The possible return values for breakpoint_here_p.
1070 We guarantee that zero always means "no breakpoint here". */
1071 enum breakpoint_here
1073 no_breakpoint_here = 0,
1074 ordinary_breakpoint_here,
1075 permanent_breakpoint_here
1079 /* Prototypes for breakpoint-related functions. */
1081 extern enum breakpoint_here breakpoint_here_p (struct address_space *,
1084 extern int moribund_breakpoint_here_p (struct address_space *, CORE_ADDR);
1086 extern int breakpoint_inserted_here_p (struct address_space *, CORE_ADDR);
1088 extern int regular_breakpoint_inserted_here_p (struct address_space *,
1091 extern int software_breakpoint_inserted_here_p (struct address_space *,
1094 /* Returns true if there's a hardware watchpoint or access watchpoint
1095 inserted in the range defined by ADDR and LEN. */
1096 extern int hardware_watchpoint_inserted_in_range (struct address_space *,
1100 extern int breakpoint_thread_match (struct address_space *,
1103 extern void until_break_command (char *, int, int);
1105 /* Initialize a struct bp_location. */
1107 extern void init_bp_location (struct bp_location *loc,
1108 const struct bp_location_ops *ops,
1109 struct breakpoint *owner);
1111 extern void update_breakpoint_locations (struct breakpoint *b,
1112 struct symtabs_and_lines sals,
1113 struct symtabs_and_lines sals_end);
1115 extern void breakpoint_re_set (void);
1117 extern void breakpoint_re_set_thread (struct breakpoint *);
1119 extern struct breakpoint *set_momentary_breakpoint
1120 (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype);
1122 extern struct breakpoint *set_momentary_breakpoint_at_pc
1123 (struct gdbarch *, CORE_ADDR pc, enum bptype type);
1125 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt);
1127 extern void set_ignore_count (int, int, int);
1129 extern void breakpoint_init_inferior (enum inf_context);
1131 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
1133 extern void delete_breakpoint (struct breakpoint *);
1135 extern void breakpoint_auto_delete (bpstat);
1137 /* Return the chain of command lines to execute when this breakpoint
1139 extern struct command_line *breakpoint_commands (struct breakpoint *b);
1141 /* Return a string image of DISP. The string is static, and thus should
1142 NOT be deallocated after use. */
1143 const char *bpdisp_text (enum bpdisp disp);
1145 extern void break_command (char *, int);
1147 extern void hbreak_command_wrapper (char *, int);
1148 extern void thbreak_command_wrapper (char *, int);
1149 extern void rbreak_command_wrapper (char *, int);
1150 extern void watch_command_wrapper (char *, int, int);
1151 extern void awatch_command_wrapper (char *, int, int);
1152 extern void rwatch_command_wrapper (char *, int, int);
1153 extern void tbreak_command (char *, int);
1155 extern struct breakpoint_ops bkpt_breakpoint_ops;
1157 extern void initialize_breakpoint_ops (void);
1159 /* Arguments to pass as context to some catch command handlers. */
1160 #define CATCH_PERMANENT ((void *) (uintptr_t) 0)
1161 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
1163 /* Like add_cmd, but add the command to both the "catch" and "tcatch"
1164 lists, and pass some additional user data to the command
1168 add_catch_command (char *name, char *docstring,
1169 void (*sfunc) (char *args, int from_tty,
1170 struct cmd_list_element *command),
1171 char **(*completer) (struct cmd_list_element *cmd,
1172 char *text, char *word),
1173 void *user_data_catch,
1174 void *user_data_tcatch);
1176 /* Initialize a breakpoint struct for Ada exception catchpoints. */
1179 init_ada_exception_breakpoint (struct breakpoint *b,
1180 struct gdbarch *gdbarch,
1181 struct symtab_and_line sal,
1183 const struct breakpoint_ops *ops,
1187 /* Add breakpoint B on the breakpoint list, and notify the user, the
1188 target and breakpoint_created observers of its existence. If
1189 INTERNAL is non-zero, the breakpoint number will be allocated from
1190 the internal breakpoint count. If UPDATE_GLL is non-zero,
1191 update_global_location_list will be called. */
1193 extern void install_breakpoint (int internal, struct breakpoint *b,
1196 extern int create_breakpoint (struct gdbarch *gdbarch, char *arg,
1197 char *cond_string, int thread,
1198 int parse_condition_and_thread,
1199 int tempflag, enum bptype wanted_type,
1201 enum auto_boolean pending_break_support,
1202 const struct breakpoint_ops *ops,
1207 extern void insert_breakpoints (void);
1209 extern int remove_breakpoints (void);
1211 extern int remove_breakpoints_pid (int pid);
1213 /* This function can be used to physically insert eventpoints from the
1214 specified traced inferior process, without modifying the breakpoint
1215 package's state. This can be useful for those targets which
1216 support following the processes of a fork() or vfork() system call,
1217 when both of the resulting two processes are to be followed. */
1218 extern int reattach_breakpoints (int);
1220 /* This function can be used to update the breakpoint package's state
1221 after an exec() system call has been executed.
1223 This function causes the following:
1225 - All eventpoints are marked "not inserted".
1226 - All eventpoints with a symbolic address are reset such that
1227 the symbolic address must be reevaluated before the eventpoints
1229 - The solib breakpoints are explicitly removed from the breakpoint
1231 - A step-resume breakpoint, if any, is explicitly removed from the
1233 - All eventpoints without a symbolic address are removed from the
1235 extern void update_breakpoints_after_exec (void);
1237 /* This function can be used to physically remove hardware breakpoints
1238 and watchpoints from the specified traced inferior process, without
1239 modifying the breakpoint package's state. This can be useful for
1240 those targets which support following the processes of a fork() or
1241 vfork() system call, when one of the resulting two processes is to
1242 be detached and allowed to run free.
1244 It is an error to use this function on the process whose id is
1246 extern int detach_breakpoints (int);
1248 /* This function is called when program space PSPACE is about to be
1249 deleted. It takes care of updating breakpoints to not reference
1250 this PSPACE anymore. */
1251 extern void breakpoint_program_space_exit (struct program_space *pspace);
1253 extern void set_longjmp_breakpoint (struct thread_info *tp,
1254 struct frame_id frame);
1255 extern void delete_longjmp_breakpoint (int thread);
1257 extern void enable_overlay_breakpoints (void);
1258 extern void disable_overlay_breakpoints (void);
1260 extern void set_std_terminate_breakpoint (void);
1261 extern void delete_std_terminate_breakpoint (void);
1263 /* These functions respectively disable or reenable all currently
1264 enabled watchpoints. When disabled, the watchpoints are marked
1265 call_disabled. When re-enabled, they are marked enabled.
1267 The intended client of these functions is call_function_by_hand.
1269 The inferior must be stopped, and all breakpoints removed, when
1270 these functions are used.
1272 The need for these functions is that on some targets (e.g., HP-UX),
1273 gdb is unable to unwind through the dummy frame that is pushed as
1274 part of the implementation of a call command. Watchpoints can
1275 cause the inferior to stop in places where this frame is visible,
1276 and that can cause execution control to become very confused.
1278 Note that if a user sets breakpoints in an interactively called
1279 function, the call_disabled watchpoints will have been re-enabled
1280 when the first such breakpoint is reached. However, on targets
1281 that are unable to unwind through the call dummy frame, watches
1282 of stack-based storage may then be deleted, because gdb will
1283 believe that their watched storage is out of scope. (Sigh.) */
1284 extern void disable_watchpoints_before_interactive_call_start (void);
1286 extern void enable_watchpoints_after_interactive_call_stop (void);
1288 /* These functions disable and re-enable all breakpoints during
1289 inferior startup. They are intended to be called from solib
1290 code where necessary. This is needed on platforms where the
1291 main executable is relocated at some point during startup
1292 processing, making breakpoint addresses invalid.
1294 If additional breakpoints are created after the routine
1295 disable_breakpoints_before_startup but before the routine
1296 enable_breakpoints_after_startup was called, they will also
1297 be marked as disabled. */
1298 extern void disable_breakpoints_before_startup (void);
1299 extern void enable_breakpoints_after_startup (void);
1301 /* For script interpreters that need to define breakpoint commands
1302 after they've already read the commands into a struct
1304 extern enum command_control_type commands_from_control_command
1305 (char *arg, struct command_line *cmd);
1307 extern void clear_breakpoint_hit_counts (void);
1309 extern struct breakpoint *get_breakpoint (int num);
1311 /* The following are for displays, which aren't really breakpoints,
1312 but here is as good a place as any for them. */
1314 extern void disable_current_display (void);
1316 extern void do_displays (void);
1318 extern void disable_display (int);
1320 extern void clear_displays (void);
1322 extern void disable_breakpoint (struct breakpoint *);
1324 extern void enable_breakpoint (struct breakpoint *);
1326 extern void breakpoint_set_commands (struct breakpoint *b,
1327 struct command_line *commands);
1329 extern void breakpoint_set_silent (struct breakpoint *b, int silent);
1331 extern void breakpoint_set_thread (struct breakpoint *b, int thread);
1333 extern void breakpoint_set_task (struct breakpoint *b, int task);
1335 /* Clear the "inserted" flag in all breakpoints. */
1336 extern void mark_breakpoints_out (void);
1338 extern void make_breakpoint_permanent (struct breakpoint *);
1340 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *,
1343 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *,
1346 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *,
1349 extern void remove_jit_event_breakpoints (void);
1351 extern void remove_solib_event_breakpoints (void);
1353 extern void remove_thread_event_breakpoints (void);
1355 extern void disable_breakpoints_in_shlibs (void);
1357 /* This function returns TRUE if ep is a catchpoint. */
1358 extern int ep_is_catchpoint (struct breakpoint *);
1360 /* Enable breakpoints and delete when hit. Called with ARG == NULL
1361 deletes all breakpoints. */
1362 extern void delete_command (char *arg, int from_tty);
1364 /* Manage a software single step breakpoint (or two). Insert may be
1365 called twice before remove is called. */
1366 extern void insert_single_step_breakpoint (struct gdbarch *,
1367 struct address_space *,
1369 extern int single_step_breakpoints_inserted (void);
1370 extern void remove_single_step_breakpoints (void);
1371 extern void cancel_single_step_breakpoints (void);
1373 /* Manage manual breakpoints, separate from the normal chain of
1374 breakpoints. These functions are used in murky target-specific
1375 ways. Please do not add more uses! */
1376 extern void *deprecated_insert_raw_breakpoint (struct gdbarch *,
1377 struct address_space *,
1379 extern int deprecated_remove_raw_breakpoint (struct gdbarch *, void *);
1381 /* Check if any hardware watchpoints have triggered, according to the
1383 int watchpoints_triggered (struct target_waitstatus *);
1385 /* Helper for transparent breakpoint hiding for memory read and write
1388 Update one of READBUF or WRITEBUF with either the shadows
1389 (READBUF), or the breakpoint instructions (WRITEBUF) of inserted
1390 breakpoints at the memory range defined by MEMADDR and extending
1391 for LEN bytes. If writing, then WRITEBUF is a copy of WRITEBUF_ORG
1393 extern void breakpoint_xfer_memory (gdb_byte *readbuf, gdb_byte *writebuf,
1394 const gdb_byte *writebuf_org,
1395 ULONGEST memaddr, LONGEST len);
1397 extern int breakpoints_always_inserted_mode (void);
1399 /* Called each time new event from target is processed.
1400 Retires previously deleted breakpoint locations that
1401 in our opinion won't ever trigger. */
1402 extern void breakpoint_retire_moribund (void);
1404 /* Set break condition of breakpoint B to EXP. */
1405 extern void set_breakpoint_condition (struct breakpoint *b, char *exp,
1408 /* Checks if we are catching syscalls or not.
1409 Returns 0 if not, greater than 0 if we are. */
1410 extern int catch_syscall_enabled (void);
1412 /* Checks if we are catching syscalls with the specific
1413 syscall_number. Used for "filtering" the catchpoints.
1414 Returns 0 if not, greater than 0 if we are. */
1415 extern int catching_syscall_number (int syscall_number);
1417 /* Return a tracepoint with the given number if found. */
1418 extern struct tracepoint *get_tracepoint (int num);
1420 extern struct tracepoint *get_tracepoint_by_number_on_target (int num);
1422 /* Find a tracepoint by parsing a number in the supplied string. */
1423 extern struct tracepoint *
1424 get_tracepoint_by_number (char **arg,
1425 struct get_number_or_range_state *state,
1428 /* Return a vector of all tracepoints currently defined. The vector
1429 is newly allocated; the caller should free when done with it. */
1430 extern VEC(breakpoint_p) *all_tracepoints (void);
1432 extern int is_tracepoint (const struct breakpoint *b);
1434 /* Return a vector of all static tracepoints defined at ADDR. The
1435 vector is newly allocated; the caller should free when done with
1437 extern VEC(breakpoint_p) *static_tracepoints_here (CORE_ADDR addr);
1439 /* Function that can be passed to read_command_line to validate
1440 that each command is suitable for tracepoint command list. */
1441 extern void check_tracepoint_command (char *line, void *closure);
1443 /* Call at the start and end of an "rbreak" command to register
1444 breakpoint numbers for a later "commands" command. */
1445 extern void start_rbreak_breakpoints (void);
1446 extern void end_rbreak_breakpoints (void);
1448 /* Breakpoint iterator function.
1450 Calls a callback function once for each breakpoint, so long as the
1451 callback function returns false. If the callback function returns
1452 true, the iteration will end and the current breakpoint will be
1453 returned. This can be useful for implementing a search for a
1454 breakpoint with arbitrary attributes, or for applying an operation
1455 to every breakpoint. */
1456 extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *,
1459 /* Nonzero if the specified PC cannot be a location where functions
1460 have been inlined. */
1462 extern int pc_at_non_inline_function (struct address_space *aspace,
1464 const struct target_waitstatus *ws);
1466 extern int user_breakpoint_p (struct breakpoint *);
1468 /* Attempt to determine architecture of location identified by SAL. */
1469 extern struct gdbarch *get_sal_arch (struct symtab_and_line sal);
1471 extern void handle_solib_event (void);
1473 #endif /* !defined (BREAKPOINT_H) */