f00aae0f7b
This patch converts the code base to use the new struct event_location API being introduced. This patch preserves the current functionality and adds no new features. The "big picture" API usage introduced by this patch may be illustrated with a simple exmaple. Where previously developers would write: void my_command (char *arg, int from_tty) { create_breakpoint (..., arg, ...); ... } one now uses: void my_command (char *arg, int from_tty) { struct event_locaiton *location; struct cleanup *back_to; location = string_to_event_locaiton (&arg, ...); back_to = make_cleanup_delete_event_location (location); create_breakpoint (..., location, ...); do_cleanups (back_to); } Linespec-decoding functions (now called location-decoding) such as decode_line_full no longer skip argument pointers over processed input. That functionality has been moved into string_to_event_location as demonstrated above. gdb/ChangeLog * ax-gdb.c: Include location.h. (agent_command_1) Use linespec location instead of address string. * break-catch-throw.c: Include location.h. (re_set_exception_catchpoint): Use linespec locations instead of address strings. * breakpoint.c: Include location.h. (create_overlay_event_breakpoint, create_longjmp_master_breakpoint) (create_std_terminate_master_breakpoint) (create_exception_master_breakpoint, update_breakpoints_after_exec): Use linespec location instead of address string. (print_breakpoint_location): Use locations and event_location_to_string. Print extra_string for pending locations for non-MI streams. (print_one_breakpoint_location): Use locations and event_location_to_string. (init_raw_breakpoint_without_location): Initialize b->location. (create_thread_event_breakpoint): Use linespec location instead of address string. (init_breakpoint_sal): Likewise. Only save extra_string if it is non-NULL and not the empty string. Use event_location_to_string instead of `addr_string'. Constify `p' and `endp'. Use skip_spaces_const/skip_space_const instead of non-const versions. Copy the location into the breakpoint. If LOCATION is NULL, save the breakpoint address as a linespec location instead of an address string. (create_breakpoint_sal): Change `addr_string' parameter to a struct event_location. All uses updated. (create_breakpoints_sal): Likewise for local variable `addr_string'. (parse_breakpoint_sals): Use locations instead of address strings. Remove check for empty linespec with conditional. Refactor. (decode_static_tracepoint_spec): Make argument const and update function. (create_breakpoint): Change `arg' to a struct event_location and rename. Remove `copy_arg' and `addr_start'. If EXTRA_STRING is empty, set it to NULL. Don't populate `canonical' for pending breakpoints. Pass `extra_string' to find_condition_and_thread. Clear `extra_string' if `rest' was NULL. Do not error with "garbage after location" if setting a dprintf breakpoint. Copy the location into the breakpoint instead of an address string. (break_command_1): Use string_to_event_location and pass this to create_breakpoint instead of an address string. Check against `arg_cp' for a probe linespec. (dprintf_command): Use string_to_event_location and pass this to create_breakpoint instead of an address string. Throw an exception if no format string was specified. (print_recreate_ranged_breakpoint): Use event_location_to_string instead of address strings. (break_range_command, until_break_command) (init_ada_exception_breakpoint): Use locations instead of address strings. (say_where): Print out extra_string for pending locations. (base_breakpoint_dtor): Delete `location' and `location_range_end' of the breakpoint. (base_breakpoint_create_sals_from_location): Use struct event_location instead of address string. Remove `addr_start' and `copy_arg' parameters. (base_breakpoint_decode_location): Use struct event_location instead of address string. (bkpt_re_set): Use locations instead of address strings. Use event_location_empty_p to check for unset location. (bkpt_print_recreate): Use event_location_to_string instead of an address string. Print out extra_string for pending locations. (bkpt_create_sals_from_location, bkpt_decode_location) (bkpt_probe_create_sals_from_location): Use struct event_location instead of address string. (bkpt_probe_decode_location): Use struct event_location instead of address string. (tracepoint_print_recreate): Use event_location_to_string to recreate the tracepoint. (tracepoint_create_sals_from_location, tracepoint_decode_location) (tracepoint_probe_create_sals_from_location) (tracepoint_probe_decode_location): Use struct event_location instead of address string. (dprintf_print_recreate): Use event_location_to_string to recreate the dprintf. (dprintf_re_set): Remove check for valid/missing format string. (strace_marker_create_sals_from_location) (strace_marker_create_breakpoints_sal, strace_marker_decode_location) (update_static_tracepoint): Use struct event_location instead of address string. (location_to_sals): Likewise. Pass `extra_string' to find_condition_and_thread. For newly resolved pending breakpoint locations, clear the location's string representation. Assert that the breakpoint's condition string is NULL when condition_not_parsed. (breakpoint_re_set_default, create_sals_from_location_default) (decode_location_default, trace_command, ftrace_command) (strace_command, create_tracepoint_from_upload): Use locations instead of address strings. * breakpoint.h (struct breakpoint_ops) <create_sals_from_location>: Use struct event_location instead of address string. Update all uses. <decode_location>: Likewise. (struct breakpoint) <addr_string>: Change to struct event_location and rename `location'. <addr_string_range_end>: Change to struct event_location and rename `location_range_end'. (create_breakpoint): Use struct event_location instead of address string. * cli/cli-cmds.c: Include location.h. (edit_command, list_command): Use locations instead of address strings. * elfread.c: Include location.h. (elf_gnu_ifunc_resolver_return_stop): Use event_location_to_string. * guile/scm-breakpoint.c: Include location.h. (bpscm_print_breakpoint_smob): Use event_location_to_string. (gdbscm_register_breakpoint): Use locations instead of address strings. * linespec.c: Include location.h. (struct ls_parser) <stream>: Change to const char *. (PARSER_STREAM): Update. (lionespec_lexer_lex_keyword): According to find_condition_and_thread, keywords must be followed by whitespace. (canonicalize_linespec): Save a linespec location into `canonical'. Save a canonical linespec into `canonical'. (parse_linespec): Change `argptr' to const char * and rename `arg'. All uses updated. Update function description. (linespec_parser_new): Initialize `parser'. Update initialization of parsing stream. (event_location_to_sals): New function. (decode_line_full): Change `argptr' to a struct event_location and rename it `location'. Use locations instead of address strings. Call event_location_to_sals instead of parse_linespec. (decode_line_1): Likewise. (decode_line_with_current_source, decode_line_with_last_displayed) Use locations instead of address strings. (decode_objc): Likewise. Change `argptr' to const char * and rename `arg'. (destroy_linespec_result): Delete the linespec result's location instead of freeing the address string. * linespec.h (struct linespec_result) <addr_string>: Change to struct event_location and rename to ... <location>: ... this. (decode_line_1, decode_line_full): Change `argptr' to struct event_location. All callers updated. * mi/mi-cmd-break.c: Include language.h, location.h, and linespec.h. (mi_cmd_break_insert_1): Use locations instead of address strings. Throw an error if there was "garbage" at the end of the specified linespec. * probe.c: Include location.h. (parse_probes): Change `argptr' to struct event_location. Use event locations instead of address strings. * probe.h (parse_probes): Change `argptr' to struct event_location. * python/py-breakpoint.c: Include location.h. (bppy_get_location): Constify local variable `str'. Use event_location_to_string. (bppy_init): Use locations instead of address strings. * python/py-finishbreakpoint.c: Include location.h. (bpfinishpy_init): Remove local variable `addr_str'. Use locations instead of address strings. * python/python.c: Include location.h. (gdbpy_decode_line): Use locations instead of address strings. * remote.c: Include location.h. (remote_download_tracepoint): Use locations instead of address strings. * spu-tdep.c: Include location.h. (spu_catch_start): Remove local variable `buf'. Use locations instead of address strings. * tracepoint.c: Include location.h. (scope_info): Use locations instead of address strings. (encode_source_string): Constify parameter `src'. * tracepoint.h (encode_source_string): Likewise. gdb/testsuite/ChangeLog * gdb.base/dprintf-pending.exp: Update dprintf "without format" test. Add tests for missing ",FMT" and ",".
357 lines
10 KiB
C
357 lines
10 KiB
C
/* Data structures associated with tracepoints in GDB.
|
|
Copyright (C) 1997-2015 Free Software Foundation, Inc.
|
|
|
|
This file is part of GDB.
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
|
|
|
#if !defined (TRACEPOINT_H)
|
|
#define TRACEPOINT_H 1
|
|
|
|
#include "breakpoint.h"
|
|
#include "target.h"
|
|
#include "memrange.h"
|
|
#include "gdb_vecs.h"
|
|
|
|
/* An object describing the contents of a traceframe. */
|
|
|
|
struct traceframe_info
|
|
{
|
|
/* Collected memory. */
|
|
VEC(mem_range_s) *memory;
|
|
|
|
/* Collected trace state variables. */
|
|
VEC(int) *tvars;
|
|
};
|
|
|
|
/* A trace state variable is a value managed by a target being
|
|
traced. A trace state variable (or tsv for short) can be accessed
|
|
and assigned to by tracepoint actions and conditionals, but is not
|
|
part of the program being traced, and it doesn't have to be
|
|
collected. Effectively the variables are scratch space for
|
|
tracepoints. */
|
|
|
|
struct trace_state_variable
|
|
{
|
|
/* The variable's name. The user has to prefix with a dollar sign,
|
|
but we don't store that internally. */
|
|
const char *name;
|
|
|
|
/* An id number assigned by GDB, and transmitted to targets. */
|
|
int number;
|
|
|
|
/* The initial value of a variable is a 64-bit signed integer. */
|
|
LONGEST initial_value;
|
|
|
|
/* 1 if the value is known, else 0. The value is known during a
|
|
trace run, or in tfind mode if the variable was collected into
|
|
the current trace frame. */
|
|
int value_known;
|
|
|
|
/* The value of a variable is a 64-bit signed integer. */
|
|
LONGEST value;
|
|
|
|
/* This is true for variables that are predefined and built into
|
|
the target. */
|
|
int builtin;
|
|
};
|
|
|
|
/* The trace status encompasses various info about the general state
|
|
of the tracing run. */
|
|
|
|
enum trace_stop_reason
|
|
{
|
|
trace_stop_reason_unknown,
|
|
trace_never_run,
|
|
tstop_command,
|
|
trace_buffer_full,
|
|
trace_disconnected,
|
|
tracepoint_passcount,
|
|
tracepoint_error
|
|
};
|
|
|
|
struct trace_status
|
|
{
|
|
/* If the status is coming from a file rather than a live target,
|
|
this points at the file's filename. Otherwise, this is NULL. */
|
|
const char *filename;
|
|
|
|
/* This is true if the value of the running field is known. */
|
|
int running_known;
|
|
|
|
/* This is true when the trace experiment is actually running. */
|
|
int running;
|
|
|
|
enum trace_stop_reason stop_reason;
|
|
|
|
/* If stop_reason is tracepoint_passcount or tracepoint_error, this
|
|
is the (on-target) number of the tracepoint which caused the
|
|
stop. */
|
|
int stopping_tracepoint;
|
|
|
|
/* If stop_reason is tstop_command or tracepoint_error, this is an
|
|
arbitrary string that may describe the reason for the stop in
|
|
more detail. */
|
|
|
|
char *stop_desc;
|
|
|
|
/* Number of traceframes currently in the buffer. */
|
|
|
|
int traceframe_count;
|
|
|
|
/* Number of traceframes created since start of run. */
|
|
|
|
int traceframes_created;
|
|
|
|
/* Total size of the target's trace buffer. */
|
|
|
|
int buffer_size;
|
|
|
|
/* Unused bytes left in the target's trace buffer. */
|
|
|
|
int buffer_free;
|
|
|
|
/* 1 if the target will continue tracing after disconnection, else
|
|
0. If the target does not report a value, assume 0. */
|
|
|
|
int disconnected_tracing;
|
|
|
|
/* 1 if the target is using a circular trace buffer, else 0. If the
|
|
target does not report a value, assume 0. */
|
|
|
|
int circular_buffer;
|
|
|
|
/* The "name" of the person running the trace. This is an
|
|
arbitrary string. */
|
|
|
|
char *user_name;
|
|
|
|
/* "Notes" about the trace. This is an arbitrary string not
|
|
interpreted by GDBserver in any special way. */
|
|
|
|
char *notes;
|
|
|
|
/* The calendar times at which the trace run started and stopped,
|
|
both expressed in microseconds of Unix time. */
|
|
|
|
LONGEST start_time;
|
|
LONGEST stop_time;
|
|
};
|
|
|
|
struct trace_status *current_trace_status (void);
|
|
|
|
extern char *default_collect;
|
|
|
|
extern int trace_regblock_size;
|
|
|
|
extern const char *stop_reason_names[];
|
|
|
|
/* Struct to collect random info about tracepoints on the target. */
|
|
|
|
struct uploaded_tp
|
|
{
|
|
int number;
|
|
enum bptype type;
|
|
ULONGEST addr;
|
|
int enabled;
|
|
int step;
|
|
int pass;
|
|
int orig_size;
|
|
|
|
/* String that is the encoded form of the tracepoint's condition. */
|
|
char *cond;
|
|
|
|
/* Vectors of strings that are the encoded forms of a tracepoint's
|
|
actions. */
|
|
VEC(char_ptr) *actions;
|
|
VEC(char_ptr) *step_actions;
|
|
|
|
/* The original string defining the location of the tracepoint. */
|
|
char *at_string;
|
|
|
|
/* The original string defining the tracepoint's condition. */
|
|
char *cond_string;
|
|
|
|
/* List of original strings defining the tracepoint's actions. */
|
|
VEC(char_ptr) *cmd_strings;
|
|
|
|
/* The tracepoint's current hit count. */
|
|
int hit_count;
|
|
|
|
/* The tracepoint's current traceframe usage. */
|
|
ULONGEST traceframe_usage;
|
|
|
|
struct uploaded_tp *next;
|
|
};
|
|
|
|
/* Struct recording info about trace state variables on the target. */
|
|
|
|
struct uploaded_tsv
|
|
{
|
|
const char *name;
|
|
int number;
|
|
LONGEST initial_value;
|
|
int builtin;
|
|
struct uploaded_tsv *next;
|
|
};
|
|
|
|
/* Struct recording info about a target static tracepoint marker. */
|
|
|
|
struct static_tracepoint_marker
|
|
{
|
|
struct gdbarch *gdbarch;
|
|
CORE_ADDR address;
|
|
|
|
/* The string ID of the marker. */
|
|
char *str_id;
|
|
|
|
/* Extra target reported info associated with the marker. */
|
|
char *extra;
|
|
};
|
|
|
|
struct memrange
|
|
{
|
|
/* memrange_absolute for absolute memory range, else basereg
|
|
number. */
|
|
int type;
|
|
bfd_signed_vma start;
|
|
bfd_signed_vma end;
|
|
};
|
|
|
|
struct collection_list
|
|
{
|
|
/* room for up to 256 regs */
|
|
unsigned char regs_mask[32];
|
|
long listsize;
|
|
long next_memrange;
|
|
struct memrange *list;
|
|
|
|
/* size of array pointed to by expr_list elt. */
|
|
long aexpr_listsize;
|
|
long next_aexpr_elt;
|
|
struct agent_expr **aexpr_list;
|
|
|
|
/* True is the user requested a collection of "$_sdata", "static
|
|
tracepoint data". */
|
|
int strace_data;
|
|
|
|
/* A set of names of wholly collected objects. */
|
|
VEC(char_ptr) *wholly_collected;
|
|
/* A set of computed expressions. */
|
|
VEC(char_ptr) *computed;
|
|
};
|
|
|
|
extern void parse_static_tracepoint_marker_definition
|
|
(char *line, char **pp,
|
|
struct static_tracepoint_marker *marker);
|
|
extern void release_static_tracepoint_marker (struct static_tracepoint_marker *);
|
|
extern void free_current_marker (void *arg);
|
|
|
|
/* A hook used to notify the UI of tracepoint operations. */
|
|
|
|
extern void (*deprecated_trace_find_hook) (char *arg, int from_tty);
|
|
extern void (*deprecated_trace_start_stop_hook) (int start, int from_tty);
|
|
|
|
/* Returns the current traceframe number. */
|
|
extern int get_traceframe_number (void);
|
|
|
|
/* Returns the tracepoint number for current traceframe. */
|
|
extern int get_tracepoint_number (void);
|
|
|
|
/* Make the traceframe NUM be the current trace frame, all the way to
|
|
the target, and flushes all global state (register/frame caches,
|
|
etc.). */
|
|
extern void set_current_traceframe (int num);
|
|
|
|
struct cleanup *make_cleanup_restore_current_traceframe (void);
|
|
|
|
void free_actions (struct breakpoint *);
|
|
|
|
extern const char *decode_agent_options (const char *exp, int *trace_string);
|
|
|
|
extern struct cleanup *
|
|
encode_actions_and_make_cleanup (struct bp_location *tloc,
|
|
struct collection_list *tracepoint_list,
|
|
struct collection_list *stepping_list);
|
|
|
|
extern void encode_actions_rsp (struct bp_location *tloc,
|
|
char ***tdp_actions, char ***stepping_actions);
|
|
|
|
extern void validate_actionline (const char *, struct breakpoint *);
|
|
extern void validate_trace_state_variable_name (const char *name);
|
|
|
|
extern struct trace_state_variable *find_trace_state_variable (const char *name);
|
|
extern struct trace_state_variable *
|
|
find_trace_state_variable_by_number (int number);
|
|
|
|
extern struct trace_state_variable *create_trace_state_variable (const char *name);
|
|
|
|
extern int encode_source_string (int num, ULONGEST addr,
|
|
char *srctype, const char *src,
|
|
char *buf, int buf_size);
|
|
|
|
extern void parse_trace_status (char *line, struct trace_status *ts);
|
|
|
|
extern void parse_tracepoint_status (char *p, struct breakpoint *tp,
|
|
struct uploaded_tp *utp);
|
|
|
|
extern void parse_tracepoint_definition (char *line,
|
|
struct uploaded_tp **utpp);
|
|
extern void parse_tsv_definition (char *line, struct uploaded_tsv **utsvp);
|
|
|
|
extern struct uploaded_tp *get_uploaded_tp (int num, ULONGEST addr,
|
|
struct uploaded_tp **utpp);
|
|
extern void free_uploaded_tps (struct uploaded_tp **utpp);
|
|
|
|
extern struct uploaded_tsv *get_uploaded_tsv (int num,
|
|
struct uploaded_tsv **utsvp);
|
|
extern void free_uploaded_tsvs (struct uploaded_tsv **utsvp);
|
|
extern struct tracepoint *create_tracepoint_from_upload (struct uploaded_tp *utp);
|
|
extern void merge_uploaded_tracepoints (struct uploaded_tp **utpp);
|
|
extern void merge_uploaded_trace_state_variables (struct uploaded_tsv **utsvp);
|
|
|
|
extern void query_if_trace_running (int from_tty);
|
|
extern void disconnect_tracing (void);
|
|
extern void trace_reset_local_state (void);
|
|
|
|
extern void check_trace_running (struct trace_status *);
|
|
|
|
extern void start_tracing (char *notes);
|
|
extern void stop_tracing (char *notes);
|
|
|
|
extern void trace_status_mi (int on_stop);
|
|
|
|
extern void tvariables_info_1 (void);
|
|
extern void save_trace_state_variables (struct ui_file *fp);
|
|
|
|
extern void tfind_1 (enum trace_find_type type, int num,
|
|
CORE_ADDR addr1, CORE_ADDR addr2,
|
|
int from_tty);
|
|
|
|
extern void trace_save_tfile (const char *filename,
|
|
int target_does_save);
|
|
extern void trace_save_ctf (const char *dirname,
|
|
int target_does_save);
|
|
|
|
extern struct traceframe_info *parse_traceframe_info (const char *tframe_info);
|
|
|
|
extern int traceframe_available_memory (VEC(mem_range_s) **result,
|
|
CORE_ADDR memaddr, ULONGEST len);
|
|
|
|
extern struct traceframe_info *get_traceframe_info (void);
|
|
|
|
extern struct bp_location *get_traceframe_location (int *stepping_frame_p);
|
|
|
|
#endif /* TRACEPOINT_H */
|