1 /* Data structures associated with tracepoints in GDB.
2 Copyright (C) 1997-2000, 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 (TRACEPOINT_H)
20 #define TRACEPOINT_H 1
22 #include "breakpoint.h"
26 /* A trace state variable is a value managed by a target being
27 traced. A trace state variable (or tsv for short) can be accessed
28 and assigned to by tracepoint actions and conditionals, but is not
29 part of the program being traced, and it doesn't have to be
30 collected. Effectively the variables are scratch space for
33 struct trace_state_variable
35 /* The variable's name. The user has to prefix with a dollar sign,
36 but we don't store that internally. */
39 /* An id number assigned by GDB, and transmitted to targets. */
42 /* The initial value of a variable is a 64-bit signed integer. */
43 LONGEST initial_value
;
45 /* 1 if the value is known, else 0. The value is known during a
46 trace run, or in tfind mode if the variable was collected into
47 the current trace frame. */
50 /* The value of a variable is a 64-bit signed integer. */
53 /* This is true for variables that are predefined and built into
58 /* The trace status encompasses various info about the general state
59 of the tracing run. */
61 enum trace_stop_reason
63 trace_stop_reason_unknown
,
74 /* This is true if the status is coming from a file rather
75 than a live target. */
78 /* This is true if the value of the running field is known. */
81 /* This is true when the trace experiment is actually running. */
84 enum trace_stop_reason stop_reason
;
86 /* If stop_reason is tracepoint_passcount or tracepoint_error, this
87 is the (on-target) number of the tracepoint which caused the
89 int stopping_tracepoint
;
91 /* If stop_reason is tstop_command or tracepoint_error, this is an
92 arbitrary string that may describe the reason for the stop in
97 /* Number of traceframes currently in the buffer. */
101 /* Number of traceframes created since start of run. */
103 int traceframes_created
;
105 /* Total size of the target's trace buffer. */
109 /* Unused bytes left in the target's trace buffer. */
113 /* 1 if the target will continue tracing after disconnection, else
114 0. If the target does not report a value, assume 0. */
116 int disconnected_tracing
;
118 /* 1 if the target is using a circular trace buffer, else 0. If the
119 target does not report a value, assume 0. */
123 /* The "name" of the person running the trace. This is an
128 /* "Notes" about the trace. This is an arbitrary string not
129 interpreted by GDBserver in any special way. */
133 /* The calendar times at which the trace run started and stopped,
134 both expressed in microseconds of Unix time. */
140 struct trace_status
*current_trace_status (void);
142 extern char *default_collect
;
144 /* Struct to collect random info about tracepoints on the target. */
146 DEF_VEC_P (char_ptr
);
158 /* String that is the encoded form of the tracepoint's condition. */
161 /* Vectors of strings that are the encoded forms of a tracepoint's
163 VEC(char_ptr
) *actions
;
164 VEC(char_ptr
) *step_actions
;
166 /* The original string defining the location of the tracepoint. */
169 /* The original string defining the tracepoint's condition. */
172 /* List of original strings defining the tracepoint's actions. */
173 VEC(char_ptr
) *cmd_strings
;
175 /* The tracepoint's current hit count. */
178 /* The tracepoint's current traceframe usage. */
179 ULONGEST traceframe_usage
;
181 struct uploaded_tp
*next
;
184 /* Struct recording info about trace state variables on the target. */
190 LONGEST initial_value
;
192 struct uploaded_tsv
*next
;
195 /* Struct recording info about a target static tracepoint marker. */
197 struct static_tracepoint_marker
199 struct gdbarch
*gdbarch
;
202 /* The string ID of the marker. */
205 /* Extra target reported info associated with the marker. */
209 extern void parse_static_tracepoint_marker_definition
210 (char *line
, char **pp
,
211 struct static_tracepoint_marker
*marker
);
212 extern void release_static_tracepoint_marker (struct static_tracepoint_marker
*);
214 /* A hook used to notify the UI of tracepoint operations. */
216 extern void (*deprecated_trace_find_hook
) (char *arg
, int from_tty
);
217 extern void (*deprecated_trace_start_stop_hook
) (int start
, int from_tty
);
219 /* Returns the current traceframe number. */
220 extern int get_traceframe_number (void);
222 /* Make the traceframe NUM be the current GDB trace frame number, and
223 do nothing more. In particular, this does not flush the
224 register/frame caches or notify the target about the trace frame
225 change, so that is can be used when we need to momentarily access
226 live memory. Targets lazily switch their current traceframe to
227 match GDB's traceframe number, at the appropriate times. */
228 extern void set_traceframe_number (int);
230 /* Make the traceframe NUM be the current trace frame, all the way to
231 the target, and flushes all global state (register/frame caches,
233 extern void set_current_traceframe (int num
);
235 struct cleanup
*make_cleanup_restore_current_traceframe (void);
236 struct cleanup
*make_cleanup_restore_traceframe_number (void);
238 void free_actions (struct breakpoint
*);
240 extern char *decode_agent_options (char *exp
);
242 extern void validate_actionline (char **, struct breakpoint
*);
244 extern void end_actions_pseudocommand (char *args
, int from_tty
);
245 extern void while_stepping_pseudocommand (char *args
, int from_tty
);
247 extern struct trace_state_variable
*find_trace_state_variable (const char *name
);
248 extern struct trace_state_variable
*create_trace_state_variable (const char *name
);
250 extern int encode_source_string (int num
, ULONGEST addr
,
251 char *srctype
, char *src
,
252 char *buf
, int buf_size
);
254 extern void parse_trace_status (char *line
, struct trace_status
*ts
);
256 extern void parse_tracepoint_status (char *p
, struct breakpoint
*tp
,
257 struct uploaded_tp
*utp
);
259 extern void parse_tracepoint_definition (char *line
,
260 struct uploaded_tp
**utpp
);
261 extern void parse_tsv_definition (char *line
, struct uploaded_tsv
**utsvp
);
263 extern struct uploaded_tp
*get_uploaded_tp (int num
, ULONGEST addr
,
264 struct uploaded_tp
**utpp
);
265 extern struct tracepoint
*create_tracepoint_from_upload (struct uploaded_tp
*utp
);
266 extern void merge_uploaded_tracepoints (struct uploaded_tp
**utpp
);
267 extern void merge_uploaded_trace_state_variables (struct uploaded_tsv
**utsvp
);
269 extern void disconnect_tracing (int from_tty
);
271 extern void start_tracing (char *notes
);
272 extern void stop_tracing (char *notes
);
274 extern void trace_status_mi (int on_stop
);
276 extern void tvariables_info_1 (void);
277 extern void save_trace_state_variables (struct ui_file
*fp
);
279 extern void tfind_1 (enum trace_find_type type
, int num
,
280 ULONGEST addr1
, ULONGEST addr2
,
283 extern void trace_save (const char *filename
, int target_does_save
);
285 extern struct traceframe_info
*parse_traceframe_info (const char *tframe_info
);
287 extern int traceframe_available_memory (VEC(mem_range_s
) **result
,
288 CORE_ADDR memaddr
, ULONGEST len
);
290 #endif /* TRACEPOINT_H */