/* Data structures associated with breakpoints in GDB.
- Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
- 2002, 2003, 2004, 2007, 2008, 2009, 2010, 2011
- Free Software Foundation, Inc.
+ Copyright (C) 1992-2004, 2007-2012 Free Software Foundation, Inc.
This file is part of GDB.
struct breakpoint_object;
struct get_number_or_range_state;
struct thread_info;
+struct bpstats;
+struct bp_location;
+struct linespec_result;
+struct linespec_sals;
/* This is the maximum number of bytes a breakpoint instruction can
take. Feel free to increase it. It's just used in a few places to
automatically enabled and reset when the
call "lands" (either completes, or stops
at another eventpoint). */
- bp_startup_disabled, /* The eventpoint has been disabled during
- inferior startup. This is necessary on
- some targets where the main executable
- will get relocated during startup, making
- breakpoint addresses invalid. The
- eventpoint will be automatically enabled
- and reset once inferior startup is
- complete. */
bp_permanent /* There is a breakpoint instruction
hard-wired into the target's code. Don't
try to write another breakpoint
bp_loc_other /* Miscellaneous... */
};
+/* This structure is a collection of function pointers that, if
+ available, will be called instead of performing the default action
+ for this bp_loc_type. */
+
+struct bp_location_ops
+{
+ /* Destructor. Releases everything from SELF (but not SELF
+ itself). */
+ void (*dtor) (struct bp_location *self);
+};
+
struct bp_location
{
/* Chain pointer to the next breakpoint location for
the same parent breakpoint. */
struct bp_location *next;
+ /* Methods associated with this location. */
+ const struct bp_location_ops *ops;
+
/* The reference count. */
int refc;
char inserted;
/* Nonzero if this is not the first breakpoint in the list
- for the given address. */
+ for the given address. location of tracepoint can _never_
+ be duplicated with other locations of tracepoints and other
+ kinds of breakpoints, because two locations at the same
+ address may have different actions, so both of these locations
+ should be downloaded and so that `tfind N' always works. */
char duplicate;
/* If we someday support real thread-specific breakpoints, then
This variable keeps a number of events still to go, when
it becomes 0 this location is retired. */
int events_till_retirement;
+
+ /* Line number of this address. */
+
+ int line_number;
+
+ /* Source file name of this address. */
+
+ char *source_file;
};
/* This structure is a collection of function pointers that, if available,
struct breakpoint_ops
{
+ /* Destructor. Releases everything from SELF (but not SELF
+ itself). */
+ void (*dtor) (struct breakpoint *self);
+
+ /* Allocate a location for this breakpoint. */
+ struct bp_location * (*allocate_location) (struct breakpoint *);
+
+ /* Reevaluate a breakpoint. This is necessary after symbols change
+ (e.g., an executable or DSO was loaded, or the inferior just
+ started). */
+ void (*re_set) (struct breakpoint *self);
+
/* Insert the breakpoint or watchpoint or activate the catchpoint.
- Return 0 for success, 1 if the breakpoint, watchpoint or catchpoint
- type is not supported, -1 for failure. */
+ Return 0 for success, 1 if the breakpoint, watchpoint or
+ catchpoint type is not supported, -1 for failure. */
int (*insert_location) (struct bp_location *);
/* Remove the breakpoint/catchpoint that was previously inserted
-1 for failure. */
int (*remove_location) (struct bp_location *);
- /* Return non-zero if the debugger should tell the user that this
- breakpoint was hit. */
- int (*breakpoint_hit) (const struct bp_location *, struct address_space *,
- CORE_ADDR);
+ /* Return true if it the target has stopped due to hitting
+ breakpoint location BL. This function does not check if we
+ should stop, only if BL explains the stop. ASPACE is the address
+ space in which the event occurred, BP_ADDR is the address at
+ which the inferior stopped, and WS is the target_waitstatus
+ describing the event. */
+ int (*breakpoint_hit) (const struct bp_location *bl,
+ struct address_space *aspace,
+ CORE_ADDR bp_addr,
+ const struct target_waitstatus *ws);
+
+ /* Check internal conditions of the breakpoint referred to by BS.
+ If we should not stop for this breakpoint, set BS->stop to 0. */
+ void (*check_status) (struct bpstats *bs);
/* Tell how many hardware resources (debug registers) are needed
for this breakpoint. If this function is not provided, then
/* The normal print routine for this breakpoint, called when we
hit it. */
- enum print_stop_action (*print_it) (struct breakpoint *);
+ enum print_stop_action (*print_it) (struct bpstats *bs);
/* Display information about this breakpoint, for "info
breakpoints". */
/* Print to FP the CLI command that recreates this breakpoint. */
void (*print_recreate) (struct breakpoint *, struct ui_file *fp);
+
+ /* Create SALs from address string, storing the result in linespec_result.
+
+ For an explanation about the arguments, see the function
+ `create_sals_from_address_default'.
+
+ This function is called inside `create_breakpoint'. */
+ void (*create_sals_from_address) (char **, struct linespec_result *,
+ enum bptype, char *, char **);
+
+ /* This method will be responsible for creating a breakpoint given its SALs.
+ Usually, it just calls `create_breakpoints_sal' (for ordinary
+ breakpoints). However, there may be some special cases where we might
+ need to do some tweaks, e.g., see
+ `strace_marker_create_breakpoints_sal'.
+
+ This function is called inside `create_breakpoint'. */
+ void (*create_breakpoints_sal) (struct gdbarch *,
+ struct linespec_result *,
+ struct linespec_sals *, char *,
+ enum bptype, enum bpdisp, int, int,
+ int, const struct breakpoint_ops *,
+ int, int, int);
+
+ /* Given the address string (second parameter), this method decodes it
+ and provides the SAL locations related to it. For ordinary breakpoints,
+ it calls `decode_line_full'.
+
+ This function is called inside `addr_string_to_sals'. */
+ void (*decode_linespec) (struct breakpoint *, char **,
+ struct symtabs_and_lines *);
};
+/* Helper for breakpoint_ops->print_recreate implementations. Prints
+ the "thread" or "task" condition of B, and then a newline.
+
+ Necessary because most breakpoint implementations accept
+ thread/task conditions at the end of the spec line, like "break foo
+ thread 1", which needs outputting before any breakpoint-type
+ specific extra command necessary for B's recreation. */
+extern void print_recreate_thread (struct breakpoint *b, struct ui_file *fp);
+
enum watchpoint_triggered
{
/* This watchpoint definitely did not trigger. */
useful for a hack I had to put in; I'm going to leave it in because
I can see how there might be times when it would indeed be useful */
-/* This is for a breakpoint or a watchpoint. */
+/* This is for all kinds of breakpoints. */
struct breakpoint
{
+ /* Methods associated with this breakpoint. */
+ const struct breakpoint_ops *ops;
+
struct breakpoint *next;
/* Type of breakpoint. */
enum bptype type;
/* Location(s) associated with this high-level breakpoint. */
struct bp_location *loc;
- /* Line number of this address. */
-
- int line_number;
-
- /* Source file name of this address. */
-
- char *source_file;
-
/* Non-zero means a silent breakpoint (don't print frame info
if we stop here). */
unsigned char silent;
equals this. */
struct frame_id frame_id;
- /* The program space used to set the breakpoint. */
+ /* The program space used to set the breakpoint. This is only set
+ for breakpoints which are specific to a program space; for
+ non-thread-specific ordinary breakpoints this is NULL. */
struct program_space *pspace;
/* String we used to set the breakpoint (malloc'd). */
char *addr_string;
+ /* The filter that should be passed to decode_line_full when
+ re-setting this breakpoint. This may be NULL, but otherwise is
+ allocated with xmalloc. */
+ char *filter;
+
/* For a ranged breakpoint, the string we used to find
the end of the range (malloc'd). */
char *addr_string_range_end;
char *cond_string;
/* String form of exp to use for displaying to the user
(malloc'd), or NULL if none. */
- char *exp_string;
- /* String form to use for reparsing of EXP (malloc'd) or NULL. */
- char *exp_string_reparse;
-
- /* The expression we are watching, or NULL if not a watchpoint. */
- struct expression *exp;
- /* The largest block within which it is valid, or NULL if it is
- valid anywhere (e.g. consists just of global symbols). */
- struct block *exp_valid_block;
- /* The conditional expression if any. NULL if not a watchpoint. */
- struct expression *cond_exp;
- /* The largest block within which it is valid, or NULL if it is
- valid anywhere (e.g. consists just of global symbols). */
- struct block *cond_exp_valid_block;
- /* Value of the watchpoint the last time we checked it, or NULL
- when we do not know the value yet or the value was not
- readable. VAL is never lazy. */
- struct value *val;
- /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
- then an error occurred reading the value. */
- int val_valid;
/* Holds the address of the related watchpoint_scope breakpoint
when using watchpoints on local variables (might the concept of
FIXME). */
struct breakpoint *related_breakpoint;
- /* Holds the frame address which identifies the frame this
- watchpoint should be evaluated in, or `null' if the watchpoint
- should be evaluated on the outermost frame. */
- struct frame_id watchpoint_frame;
-
- /* Holds the thread which identifies the frame this watchpoint
- should be considered in scope for, or `null_ptid' if the
- watchpoint should be evaluated in all threads. */
- ptid_t watchpoint_thread;
-
- /* For hardware watchpoints, the triggered status according to the
- hardware. */
- enum watchpoint_triggered watchpoint_triggered;
-
/* Thread number for thread-specific breakpoint,
or -1 if don't care. */
int thread;
aborting, so you can back up to just before the abort. */
int hit_count;
- /* Filename of a program whose exec triggered this catchpoint.
- This field is only valid immediately after this catchpoint has
- triggered. */
- char *exec_pathname;
-
- /* Syscall numbers used for the 'catch syscall' feature. If no
- syscall has been specified for filtering, its value is NULL.
- Otherwise, it holds a list of all syscalls to be caught. The
- list elements are allocated with xmalloc. */
- VEC(int) *syscalls_to_be_caught;
-
- /* Methods associated with this breakpoint. */
- struct breakpoint_ops *ops;
-
/* Is breakpoint's condition not yet parsed because we found
no location initially so had no context to parse
the condition in. */
int condition_not_parsed;
- /* Number of times this tracepoint should single-step
- and collect additional data. */
- long step_count;
-
- /* Number of times this tracepoint should be hit before
- disabling/ending. */
- int pass_count;
-
- /* The number of the tracepoint on the target. */
- int number_on_target;
-
- /* The static tracepoint marker id, if known. */
- char *static_trace_marker_id;
-
- /* LTTng/UST allow more than one marker with the same ID string,
- although it unadvised because it confuses tools. When setting
- static tracepoints by marker ID, this will record the index in
- the array of markers we found for the given marker ID for which
- this static tracepoint corresponds. When resetting
- breakpoints, we will use this index to try to find the same
- marker again. */
- int static_trace_marker_id_idx;
-
/* With a Python scripting enabled GDB, store a reference to the
Python object that has been associated with this breakpoint.
This is always NULL for a GDB that is not script enabled. It
can sometimes be NULL for enabled GDBs as not all breakpoint
types are tracked by the Python scripting API. */
struct breakpoint_object *py_bp_object;
+ };
- /* Whether this watchpoint is exact (see target_exact_watchpoints). */
- int exact;
+/* An instance of this type is used to represent a watchpoint. It
+ includes a "struct breakpoint" as a kind of base class; users
+ downcast to "struct breakpoint *" when needed. */
- /* The mask address for a masked hardware watchpoint. */
- CORE_ADDR hw_wp_mask;
- };
+struct watchpoint
+{
+ /* The base class. */
+ struct breakpoint base;
+
+ /* String form of exp to use for displaying to the user (malloc'd),
+ or NULL if none. */
+ char *exp_string;
+ /* String form to use for reparsing of EXP (malloc'd) or NULL. */
+ char *exp_string_reparse;
+
+ /* The expression we are watching, or NULL if not a watchpoint. */
+ struct expression *exp;
+ /* The largest block within which it is valid, or NULL if it is
+ valid anywhere (e.g. consists just of global symbols). */
+ struct block *exp_valid_block;
+ /* The conditional expression if any. */
+ struct expression *cond_exp;
+ /* The largest block within which it is valid, or NULL if it is
+ valid anywhere (e.g. consists just of global symbols). */
+ struct block *cond_exp_valid_block;
+ /* Value of the watchpoint the last time we checked it, or NULL when
+ we do not know the value yet or the value was not readable. VAL
+ is never lazy. */
+ struct value *val;
+ /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
+ then an error occurred reading the value. */
+ int val_valid;
+
+ /* Holds the frame address which identifies the frame this
+ watchpoint should be evaluated in, or `null' if the watchpoint
+ should be evaluated on the outermost frame. */
+ struct frame_id watchpoint_frame;
+
+ /* Holds the thread which identifies the frame this watchpoint
+ should be considered in scope for, or `null_ptid' if the
+ watchpoint should be evaluated in all threads. */
+ ptid_t watchpoint_thread;
+
+ /* For hardware watchpoints, the triggered status according to the
+ hardware. */
+ enum watchpoint_triggered watchpoint_triggered;
+
+ /* Whether this watchpoint is exact (see
+ target_exact_watchpoints). */
+ int exact;
+
+ /* The mask address for a masked hardware watchpoint. */
+ CORE_ADDR hw_wp_mask;
+};
+
+/* Returns true if BPT is really a watchpoint. */
+
+extern int is_watchpoint (const struct breakpoint *bpt);
+
+/* An instance of this type is used to represent all kinds of
+ tracepoints. It includes a "struct breakpoint" as a kind of base
+ class; users downcast to "struct breakpoint *" when needed. */
+
+struct tracepoint
+{
+ /* The base class. */
+ struct breakpoint base;
+
+ /* Number of times this tracepoint should single-step and collect
+ additional data. */
+ long step_count;
+
+ /* Number of times this tracepoint should be hit before
+ disabling/ending. */
+ int pass_count;
+
+ /* The number of the tracepoint on the target. */
+ int number_on_target;
+
+ /* The total space taken by all the trace frames for this
+ tracepoint. */
+ ULONGEST traceframe_usage;
+
+ /* The static tracepoint marker id, if known. */
+ char *static_trace_marker_id;
+
+ /* LTTng/UST allow more than one marker with the same ID string,
+ although it unadvised because it confuses tools. When setting
+ static tracepoints by marker ID, this will record the index in
+ the array of markers we found for the given marker ID for which
+ this static tracepoint corresponds. When resetting breakpoints,
+ we will use this index to try to find the same marker again. */
+ int static_trace_marker_id_idx;
+};
typedef struct breakpoint *breakpoint_p;
DEF_VEC_P(breakpoint_p);
extern bpstat bpstat_copy (bpstat);
extern bpstat bpstat_stop_status (struct address_space *aspace,
- CORE_ADDR pc, ptid_t ptid);
+ CORE_ADDR pc, ptid_t ptid,
+ const struct target_waitstatus *ws);
\f
/* This bpstat_what stuff tells wait_for_inferior what to do with a
breakpoint (a challenging task).
print_it_done, print_it_noop. */
enum print_stop_action
{
+ /* We printed nothing or we need to do some more analysis. */
PRINT_UNKNOWN = -1,
+
+ /* We printed something, and we *do* desire that something to be
+ followed by a location. */
PRINT_SRC_AND_LOC,
+
+ /* We printed something, and we do *not* desire that something to
+ be followed by a location. */
PRINT_SRC_ONLY,
+
+ /* We already printed all we needed to print, don't print anything
+ else. */
PRINT_NOTHING
};
/* Print a message indicating what happened. Returns nonzero to
say that only the source line should be printed after this (zero
return means print the frame as well as the source line). */
-extern enum print_stop_action bpstat_print (bpstat);
+extern enum print_stop_action bpstat_print (bpstat, int);
/* Put in *NUM the breakpoint number of the first breakpoint we are
stopped at. *BSP upon return is a bpstat which points to the
command loop). */
extern void bpstat_do_actions (void);
-/* Modify BS so that the actions will not be performed. */
-extern void bpstat_clear_actions (bpstat);
+/* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will
+ not be performed. */
+extern void bpstat_clear_actions (void);
/* Implementation: */
/* The associated command list. */
struct counted_command_line *commands;
- /* Commands left to be done. This points somewhere in
- base_command. */
- struct command_line *commands_left;
-
/* Old value associated with a watchpoint. */
struct value *old_val;
extern void until_break_command (char *, int, int);
+/* Initialize a struct bp_location. */
+
+extern void init_bp_location (struct bp_location *loc,
+ const struct bp_location_ops *ops,
+ struct breakpoint *owner);
+
extern void update_breakpoint_locations (struct breakpoint *b,
struct symtabs_and_lines sals,
struct symtabs_and_lines sals_end);
extern void set_ignore_count (int, int, int);
-extern void set_default_breakpoint (int, struct program_space *,
- CORE_ADDR, struct symtab *, int);
-
extern void breakpoint_init_inferior (enum inf_context);
extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
extern void rwatch_command_wrapper (char *, int, int);
extern void tbreak_command (char *, int);
+extern struct breakpoint_ops bkpt_breakpoint_ops;
+
+extern void initialize_breakpoint_ops (void);
+
+/* Arguments to pass as context to some catch command handlers. */
+#define CATCH_PERMANENT ((void *) (uintptr_t) 0)
+#define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
+
+/* Like add_cmd, but add the command to both the "catch" and "tcatch"
+ lists, and pass some additional user data to the command
+ function. */
+
+extern void
+ add_catch_command (char *name, char *docstring,
+ void (*sfunc) (char *args, int from_tty,
+ struct cmd_list_element *command),
+ char **(*completer) (struct cmd_list_element *cmd,
+ char *text, char *word),
+ void *user_data_catch,
+ void *user_data_tcatch);
+
+/* Initialize a breakpoint struct for Ada exception catchpoints. */
+
+extern void
+ init_ada_exception_breakpoint (struct breakpoint *b,
+ struct gdbarch *gdbarch,
+ struct symtab_and_line sal,
+ char *addr_string,
+ const struct breakpoint_ops *ops,
+ int tempflag,
+ int from_tty);
+
+/* Add breakpoint B on the breakpoint list, and notify the user, the
+ target and breakpoint_created observers of its existence. If
+ INTERNAL is non-zero, the breakpoint number will be allocated from
+ the internal breakpoint count. If UPDATE_GLL is non-zero,
+ update_global_location_list will be called. */
+
+extern void install_breakpoint (int internal, struct breakpoint *b,
+ int update_gll);
+
extern int create_breakpoint (struct gdbarch *gdbarch, char *arg,
char *cond_string, int thread,
int parse_condition_and_thread,
int tempflag, enum bptype wanted_type,
int ignore_count,
enum auto_boolean pending_break_support,
- struct breakpoint_ops *ops,
+ const struct breakpoint_ops *ops,
int from_tty,
int enabled,
int internal);
target. */
int watchpoints_triggered (struct target_waitstatus *);
-/* Update BUF, which is LEN bytes read from the target address MEMADDR,
- by replacing any memory breakpoints with their shadowed contents. */
-void breakpoint_restore_shadows (gdb_byte *buf, ULONGEST memaddr,
- LONGEST len);
+/* Helper for transparent breakpoint hiding for memory read and write
+ routines.
+
+ Update one of READBUF or WRITEBUF with either the shadows
+ (READBUF), or the breakpoint instructions (WRITEBUF) of inserted
+ breakpoints at the memory range defined by MEMADDR and extending
+ for LEN bytes. If writing, then WRITEBUF is a copy of WRITEBUF_ORG
+ on entry.*/
+extern void breakpoint_xfer_memory (gdb_byte *readbuf, gdb_byte *writebuf,
+ const gdb_byte *writebuf_org,
+ ULONGEST memaddr, LONGEST len);
extern int breakpoints_always_inserted_mode (void);
extern int catching_syscall_number (int syscall_number);
/* Return a tracepoint with the given number if found. */
-extern struct breakpoint *get_tracepoint (int num);
+extern struct tracepoint *get_tracepoint (int num);
-extern struct breakpoint *get_tracepoint_by_number_on_target (int num);
+extern struct tracepoint *get_tracepoint_by_number_on_target (int num);
/* Find a tracepoint by parsing a number in the supplied string. */
-extern struct breakpoint *
+extern struct tracepoint *
get_tracepoint_by_number (char **arg,
struct get_number_or_range_state *state,
int optional_p);
extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *,
void *), void *);
+/* Nonzero if the specified PC cannot be a location where functions
+ have been inlined. */
+
+extern int pc_at_non_inline_function (struct address_space *aspace,
+ CORE_ADDR pc,
+ const struct target_waitstatus *ws);
+
extern int user_breakpoint_p (struct breakpoint *);
+/* Attempt to determine architecture of location identified by SAL. */
+extern struct gdbarch *get_sal_arch (struct symtab_and_line sal);
+
+extern void handle_solib_event (void);
+
#endif /* !defined (BREAKPOINT_H) */