GDB (xrefs)
/tmp/gdb-7.10/gdb/tracepoint.h
Go to the documentation of this file.
1 /* Data structures associated with tracepoints in GDB.
2  Copyright (C) 1997-2015 Free Software Foundation, Inc.
3 
4  This file is part of GDB.
5 
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.
10 
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.
15 
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/>. */
18 
19 #if !defined (TRACEPOINT_H)
20 #define TRACEPOINT_H 1
21 
22 #include "breakpoint.h"
23 #include "target.h"
24 #include "memrange.h"
25 #include "gdb_vecs.h"
26 
27 /* An object describing the contents of a traceframe. */
28 
30 {
31  /* Collected memory. */
32  VEC(mem_range_s) *memory;
33 
34  /* Collected trace state variables. */
35  VEC(int) *tvars;
36 };
37 
38 /* A trace state variable is a value managed by a target being
39  traced. A trace state variable (or tsv for short) can be accessed
40  and assigned to by tracepoint actions and conditionals, but is not
41  part of the program being traced, and it doesn't have to be
42  collected. Effectively the variables are scratch space for
43  tracepoints. */
44 
46  {
47  /* The variable's name. The user has to prefix with a dollar sign,
48  but we don't store that internally. */
49  const char *name;
50 
51  /* An id number assigned by GDB, and transmitted to targets. */
52  int number;
53 
54  /* The initial value of a variable is a 64-bit signed integer. */
56 
57  /* 1 if the value is known, else 0. The value is known during a
58  trace run, or in tfind mode if the variable was collected into
59  the current trace frame. */
61 
62  /* The value of a variable is a 64-bit signed integer. */
64 
65  /* This is true for variables that are predefined and built into
66  the target. */
67  int builtin;
68  };
69 
70 /* The trace status encompasses various info about the general state
71  of the tracing run. */
72 
74  {
82  };
83 
85 {
86  /* If the status is coming from a file rather than a live target,
87  this points at the file's filename. Otherwise, this is NULL. */
88  const char *filename;
89 
90  /* This is true if the value of the running field is known. */
92 
93  /* This is true when the trace experiment is actually running. */
94  int running;
95 
97 
98  /* If stop_reason is tracepoint_passcount or tracepoint_error, this
99  is the (on-target) number of the tracepoint which caused the
100  stop. */
102 
103  /* If stop_reason is tstop_command or tracepoint_error, this is an
104  arbitrary string that may describe the reason for the stop in
105  more detail. */
106 
107  char *stop_desc;
108 
109  /* Number of traceframes currently in the buffer. */
110 
112 
113  /* Number of traceframes created since start of run. */
114 
116 
117  /* Total size of the target's trace buffer. */
118 
120 
121  /* Unused bytes left in the target's trace buffer. */
122 
124 
125  /* 1 if the target will continue tracing after disconnection, else
126  0. If the target does not report a value, assume 0. */
127 
129 
130  /* 1 if the target is using a circular trace buffer, else 0. If the
131  target does not report a value, assume 0. */
132 
134 
135  /* The "name" of the person running the trace. This is an
136  arbitrary string. */
137 
138  char *user_name;
139 
140  /* "Notes" about the trace. This is an arbitrary string not
141  interpreted by GDBserver in any special way. */
142 
143  char *notes;
144 
145  /* The calendar times at which the trace run started and stopped,
146  both expressed in microseconds of Unix time. */
147 
150 };
151 
152 struct trace_status *current_trace_status (void);
153 
154 extern char *default_collect;
155 
156 extern int trace_regblock_size;
157 
158 extern const char *stop_reason_names[];
159 
160 /* Struct to collect random info about tracepoints on the target. */
161 
163 {
164  int number;
165  enum bptype type;
167  int enabled;
168  int step;
169  int pass;
171 
172  /* String that is the encoded form of the tracepoint's condition. */
173  char *cond;
174 
175  /* Vectors of strings that are the encoded forms of a tracepoint's
176  actions. */
177  VEC(char_ptr) *actions;
178  VEC(char_ptr) *step_actions;
179 
180  /* The original string defining the location of the tracepoint. */
181  char *at_string;
182 
183  /* The original string defining the tracepoint's condition. */
184  char *cond_string;
185 
186  /* List of original strings defining the tracepoint's actions. */
187  VEC(char_ptr) *cmd_strings;
188 
189  /* The tracepoint's current hit count. */
191 
192  /* The tracepoint's current traceframe usage. */
194 
195  struct uploaded_tp *next;
196 };
197 
198 /* Struct recording info about trace state variables on the target. */
199 
201 {
202  const char *name;
203  int number;
205  int builtin;
207 };
208 
209 /* Struct recording info about a target static tracepoint marker. */
210 
212 {
213  struct gdbarch *gdbarch;
215 
216  /* The string ID of the marker. */
217  char *str_id;
218 
219  /* Extra target reported info associated with the marker. */
220  char *extra;
221 };
222 
223 struct memrange
224 {
225  /* memrange_absolute for absolute memory range, else basereg
226  number. */
227  int type;
228  bfd_signed_vma start;
229  bfd_signed_vma end;
230 };
231 
233 {
234  /* room for up to 256 regs */
235  unsigned char regs_mask[32];
236  long listsize;
238  struct memrange *list;
239 
240  /* size of array pointed to by expr_list elt. */
244 
245  /* True is the user requested a collection of "$_sdata", "static
246  tracepoint data". */
248 
249  /* A set of names of wholly collected objects. */
250  VEC(char_ptr) *wholly_collected;
251  /* A set of computed expressions. */
252  VEC(char_ptr) *computed;
253 };
254 
256  (char *line, char **pp,
257  struct static_tracepoint_marker *marker);
259 extern void free_current_marker (void *arg);
260 
261 /* A hook used to notify the UI of tracepoint operations. */
262 
263 extern void (*deprecated_trace_find_hook) (char *arg, int from_tty);
264 extern void (*deprecated_trace_start_stop_hook) (int start, int from_tty);
265 
266 /* Returns the current traceframe number. */
267 extern int get_traceframe_number (void);
268 
269 /* Returns the tracepoint number for current traceframe. */
270 extern int get_tracepoint_number (void);
271 
272 /* Make the traceframe NUM be the current trace frame, all the way to
273  the target, and flushes all global state (register/frame caches,
274  etc.). */
275 extern void set_current_traceframe (int num);
276 
278 
279 void free_actions (struct breakpoint *);
280 
281 extern const char *decode_agent_options (const char *exp, int *trace_string);
282 
283 extern struct cleanup *
285  struct collection_list *tracepoint_list,
286  struct collection_list *stepping_list);
287 
288 extern void encode_actions_rsp (struct bp_location *tloc,
289  char ***tdp_actions, char ***stepping_actions);
290 
291 extern void validate_actionline (const char *, struct breakpoint *);
292 extern void validate_trace_state_variable_name (const char *name);
293 
294 extern struct trace_state_variable *find_trace_state_variable (const char *name);
295 extern struct trace_state_variable *
297 
298 extern struct trace_state_variable *create_trace_state_variable (const char *name);
299 
300 extern int encode_source_string (int num, ULONGEST addr,
301  char *srctype, char *src,
302  char *buf, int buf_size);
303 
304 extern void parse_trace_status (char *line, struct trace_status *ts);
305 
306 extern void parse_tracepoint_status (char *p, struct breakpoint *tp,
307  struct uploaded_tp *utp);
308 
309 extern void parse_tracepoint_definition (char *line,
310  struct uploaded_tp **utpp);
311 extern void parse_tsv_definition (char *line, struct uploaded_tsv **utsvp);
312 
313 extern struct uploaded_tp *get_uploaded_tp (int num, ULONGEST addr,
314  struct uploaded_tp **utpp);
315 extern void free_uploaded_tps (struct uploaded_tp **utpp);
316 
317 extern struct uploaded_tsv *get_uploaded_tsv (int num,
318  struct uploaded_tsv **utsvp);
319 extern void free_uploaded_tsvs (struct uploaded_tsv **utsvp);
320 extern struct tracepoint *create_tracepoint_from_upload (struct uploaded_tp *utp);
321 extern void merge_uploaded_tracepoints (struct uploaded_tp **utpp);
322 extern void merge_uploaded_trace_state_variables (struct uploaded_tsv **utsvp);
323 
324 extern void query_if_trace_running (int from_tty);
325 extern void disconnect_tracing (void);
326 extern void trace_reset_local_state (void);
327 
328 extern void check_trace_running (struct trace_status *);
329 
330 extern void start_tracing (char *notes);
331 extern void stop_tracing (char *notes);
332 
333 extern void trace_status_mi (int on_stop);
334 
335 extern void tvariables_info_1 (void);
336 extern void save_trace_state_variables (struct ui_file *fp);
337 
338 extern void tfind_1 (enum trace_find_type type, int num,
339  CORE_ADDR addr1, CORE_ADDR addr2,
340  int from_tty);
341 
342 extern void trace_save_tfile (const char *filename,
343  int target_does_save);
344 extern void trace_save_ctf (const char *dirname,
345  int target_does_save);
346 
347 extern struct traceframe_info *parse_traceframe_info (const char *tframe_info);
348 
349 extern int traceframe_available_memory (VEC(mem_range_s) **result,
350  CORE_ADDR memaddr, ULONGEST len);
351 
352 extern struct traceframe_info *get_traceframe_info (void);
353 
354 extern struct bp_location *get_traceframe_location (int *stepping_frame_p);
355 
356 #endif /* TRACEPOINT_H */
int type
Definition: tracepoint.h:227
void release_static_tracepoint_marker(struct static_tracepoint_marker *)
Definition: tracepoint.c:3941
bfd_vma CORE_ADDR
Definition: common-types.h:41
void parse_tsv_definition(char *line, struct uploaded_tsv **utsvp)
Definition: tracepoint.c:3858
void encode_actions_rsp(struct bp_location *tloc, char ***tdp_actions, char ***stepping_actions)
Definition: tracepoint.c:1687
LONGEST initial_value
Definition: tracepoint.h:204
int circular_buffer
Definition: tracepoint.h:133
void set_current_traceframe(int num)
Definition: tracepoint.c:3195
void tvariables_info_1(void)
Definition: tracepoint.c:482
struct gdbarch * gdbarch
Definition: tracepoint.h:213
void free_current_marker(void *arg)
Definition: tracepoint.c:3884
int traceframes_created
Definition: tracepoint.h:115
int encode_source_string(int num, ULONGEST addr, char *srctype, char *src, char *buf, int buf_size)
Definition: tracepoint.c:3080
Definition: ax.h:95
void check_trace_running(struct trace_status *)
Definition: tracepoint.c:2449
#define VEC(T)
Definition: vec.h:398
VEC(char_ptr)*actions
int get_traceframe_number(void)
Definition: tracepoint.c:3180
ULONGEST traceframe_usage
Definition: tracepoint.h:193
char * char_ptr
Definition: gdb_vecs.h:25
struct trace_state_variable * find_trace_state_variable_by_number(int number)
Definition: tracepoint.c:329
int get_tracepoint_number(void)
Definition: tracepoint.c:3186
LONGEST stop_time
Definition: tracepoint.h:149
void merge_uploaded_tracepoints(struct uploaded_tp **utpp)
Definition: tracepoint.c:3376
struct cleanup * encode_actions_and_make_cleanup(struct bp_location *tloc, struct collection_list *tracepoint_list, struct collection_list *stepping_list)
Definition: tracepoint.c:1650
unsigned char regs_mask[32]
Definition: tracepoint.h:235
void trace_save_tfile(const char *filename, int target_does_save)
Definition: tracefile.c:355
char * at_string
Definition: tracepoint.h:181
void validate_trace_state_variable_name(const char *name)
Definition: tracepoint.c:365
void query_if_trace_running(int from_tty)
Definition: tracepoint.c:2261
void merge_uploaded_trace_state_variables(struct uploaded_tsv **utsvp)
Definition: tracepoint.c:3507
const char *const name
Definition: aarch64-tdep.c:68
struct trace_state_variable * create_trace_state_variable(const char *name)
Definition: tracepoint.c:300
enum bptype type
Definition: tracepoint.h:165
void start_tracing(char *notes)
Definition: tracepoint.c:1773
int trace_regblock_size
VEC(mem_range_s)*memory
char * cond_string
Definition: tracepoint.h:184
struct uploaded_tsv * next
Definition: tracepoint.h:206
const char * name
Definition: tracepoint.h:202
void(* deprecated_trace_start_stop_hook)(int start, int from_tty)
Definition: tracepoint.c:81
int traceframe_available_memory(VEC(mem_range_s)**result, CORE_ADDR memaddr, ULONGEST len)
Definition: tracepoint.c:4291
void disconnect_tracing(void)
Definition: tracepoint.c:2302
bfd_signed_vma start
Definition: tracepoint.h:228
void trace_status_mi(int on_stop)
Definition: tracepoint.c:2147
VEC(char_ptr)*wholly_collected
struct bp_location * get_traceframe_location(int *stepping_frame_p)
Definition: tracepoint.c:2972
struct uploaded_tp * next
Definition: tracepoint.h:195
enum trace_stop_reason stop_reason
Definition: tracepoint.h:96
trace_find_type
Definition: target.h:246
void tfind_1(enum trace_find_type type, int num, CORE_ADDR addr1, CORE_ADDR addr2, int from_tty)
Definition: tracepoint.c:2313
void parse_tracepoint_status(char *p, struct breakpoint *tp, struct uploaded_tp *utp)
Definition: tracepoint.c:3720
Definition: gdbtypes.h:749
const char * filename
Definition: tracepoint.h:88
char * default_collect
void stop_tracing(char *notes)
Definition: tracepoint.c:1936
char * user_name
Definition: tracepoint.h:138
void validate_actionline(const char *, struct breakpoint *)
Definition: tracepoint.c:699
void free_actions(struct breakpoint *)
void parse_trace_status(char *line, struct trace_status *ts)
Definition: tracepoint.c:3560
int stopping_tracepoint
Definition: tracepoint.h:101
const char * stop_reason_names[]
void parse_static_tracepoint_marker_definition(char *line, char **pp, struct static_tracepoint_marker *marker)
Definition: tracepoint.c:3903
bptype
Definition: breakpoint.h:51
struct trace_state_variable * find_trace_state_variable(const char *name)
Definition: tracepoint.c:313
int running_known
Definition: tracepoint.h:91
void save_trace_state_variables(struct ui_file *fp)
Definition: tracepoint.c:556
char * stop_desc
Definition: tracepoint.h:107
void trace_reset_local_state(void)
Definition: tracepoint.c:1764
int traceframe_count
Definition: tracepoint.h:111
char * notes
Definition: tracepoint.h:143
struct cleanup * make_cleanup_restore_current_traceframe(void)
Definition: tracepoint.c:3244
void parse_tracepoint_definition(char *line, struct uploaded_tp **utpp)
Definition: tracepoint.c:3743
const char * decode_agent_options(const char *exp, int *trace_string)
Definition: tracepoint.c:608
char * cond
Definition: tracepoint.h:173
void trace_save_ctf(const char *dirname, int target_does_save)
Definition: tracefile.c:369
struct trace_status * current_trace_status(void)
Definition: tracepoint.c:205
int disconnected_tracing
Definition: tracepoint.h:128
int line
Definition: symtab.h:1570
ULONGEST addr
Definition: tracepoint.h:166
bfd_signed_vma end
Definition: tracepoint.h:229
trace_stop_reason
Definition: tracepoint.h:73
struct traceframe_info * get_traceframe_info(void)
Definition: tracepoint.c:4276
struct uploaded_tsv * get_uploaded_tsv(int num, struct uploaded_tsv **utsvp)
Definition: tracepoint.c:3295
unsigned long long ULONGEST
Definition: common-types.h:53
struct tracepoint * create_tracepoint_from_upload(struct uploaded_tp *utp)
Definition: breakpoint.c:14976
struct memrange * list
Definition: tracepoint.h:238
struct agent_expr ** aexpr_list
Definition: tracepoint.h:243
void free_uploaded_tsvs(struct uploaded_tsv **utsvp)
Definition: tracepoint.c:3311
struct uploaded_tp * get_uploaded_tp(int num, ULONGEST addr, struct uploaded_tp **utpp)
Definition: tracepoint.c:3259
void free_uploaded_tps(struct uploaded_tp **utpp)
Definition: tracepoint.c:3279
void(* deprecated_trace_find_hook)(char *arg, int from_tty)
Definition: tracepoint.c:80
long long LONGEST
Definition: common-types.h:52
struct traceframe_info * parse_traceframe_info(const char *tframe_info)
Definition: tracepoint.c:4247
const ULONGEST const LONGEST len
Definition: target.h:309
const char * name
Definition: tracepoint.h:49
LONGEST start_time
Definition: tracepoint.h:148