1 /* Data structures associated with tracepoints in GDB.
2 Copyright (C) 1997, 1998, 1999, 2000, 2007, 2008, 2009, 2010, 2011
3 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #if !defined (TRACEPOINT_H)
21 #define TRACEPOINT_H 1
23 #include "breakpoint.h"
27 /* A trace state variable is a value managed by a target being
28 traced. A trace state variable (or tsv for short) can be accessed
29 and assigned to by tracepoint actions and conditionals, but is not
30 part of the program being traced, and it doesn't have to be
31 collected. Effectively the variables are scratch space for
34 struct trace_state_variable
36 /* The variable's name. The user has to prefix with a dollar sign,
37 but we don't store that internally. */
40 /* An id number assigned by GDB, and transmitted to targets. */
43 /* The initial value of a variable is a 64-bit signed integer. */
44 LONGEST initial_value
;
46 /* 1 if the value is known, else 0. The value is known during a
47 trace run, or in tfind mode if the variable was collected into
48 the current trace frame. */
51 /* The value of a variable is a 64-bit signed integer. */
54 /* This is true for variables that are predefined and built into
59 /* The trace status encompasses various info about the general state
60 of the tracing run. */
62 enum trace_stop_reason
64 trace_stop_reason_unknown
,
75 /* This is true if the status is coming from a file rather
76 than a live target. */
79 /* This is true if the value of the running field is known. */
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 tracepoint_error, this is a human-readable
92 string that describes the error that happened on the target. */
95 /* Number of traceframes currently in the buffer. */
99 /* Number of traceframes created since start of run. */
101 int traceframes_created
;
103 /* Total size of the target's trace buffer. */
107 /* Unused bytes left in the target's trace buffer. */
111 /* 1 if the target will continue tracing after disconnection, else
112 0. If the target does not report a value, assume 0. */
114 int disconnected_tracing
;
116 /* 1 if the target is using a circular trace buffer, else 0. If the
117 target does not report a value, assume 0. */
122 struct trace_status
*current_trace_status (void);
124 extern char *default_collect
;
126 /* Struct to collect random info about tracepoints on the target. */
128 DEF_VEC_P (char_ptr
);
140 /* String that is the encoded form of the tracepoint's condition. */
143 /* Vectors of strings that are the encoded forms of a tracepoint's
145 VEC(char_ptr
) *actions
;
146 VEC(char_ptr
) *step_actions
;
148 /* The original string defining the location of the tracepoint. */
151 /* The original string defining the tracepoint's condition. */
154 /* List of original strings defining the tracepoint's actions. */
155 VEC(char_ptr
) *cmd_strings
;
157 struct uploaded_tp
*next
;
160 /* Struct recording info about trace state variables on the target. */
166 LONGEST initial_value
;
168 struct uploaded_tsv
*next
;
171 /* Struct recording info about a target static tracepoint marker. */
173 struct static_tracepoint_marker
175 struct gdbarch
*gdbarch
;
178 /* The string ID of the marker. */
181 /* Extra target reported info associated with the marker. */
185 extern void parse_static_tracepoint_marker_definition
186 (char *line
, char **pp
,
187 struct static_tracepoint_marker
*marker
);
188 extern void release_static_tracepoint_marker (struct static_tracepoint_marker
*);
190 /* A hook used to notify the UI of tracepoint operations. */
192 extern void (*deprecated_trace_find_hook
) (char *arg
, int from_tty
);
193 extern void (*deprecated_trace_start_stop_hook
) (int start
, int from_tty
);
195 int get_traceframe_number (void);
196 void set_traceframe_number (int);
197 struct cleanup
*make_cleanup_restore_current_traceframe (void);
199 void free_actions (struct breakpoint
*);
200 extern void validate_actionline (char **, struct breakpoint
*);
202 extern void end_actions_pseudocommand (char *args
, int from_tty
);
203 extern void while_stepping_pseudocommand (char *args
, int from_tty
);
205 extern struct trace_state_variable
*find_trace_state_variable (const char *name
);
206 extern struct trace_state_variable
*create_trace_state_variable (const char *name
);
208 extern int encode_source_string (int num
, ULONGEST addr
,
209 char *srctype
, char *src
,
210 char *buf
, int buf_size
);
212 extern void parse_trace_status (char *line
, struct trace_status
*ts
);
214 extern void parse_tracepoint_definition (char *line
,
215 struct uploaded_tp
**utpp
);
216 extern void parse_tsv_definition (char *line
, struct uploaded_tsv
**utsvp
);
218 extern struct uploaded_tp
*get_uploaded_tp (int num
, ULONGEST addr
,
219 struct uploaded_tp
**utpp
);
220 extern struct breakpoint
*create_tracepoint_from_upload (struct uploaded_tp
*utp
);
221 extern void merge_uploaded_tracepoints (struct uploaded_tp
**utpp
);
222 extern void merge_uploaded_trace_state_variables (struct uploaded_tsv
**utsvp
);
224 extern void disconnect_tracing (int from_tty
);
226 extern void start_tracing (void);
227 extern void stop_tracing (void);
229 extern void trace_status_mi (int on_stop
);
231 extern void tvariables_info_1 (void);
232 extern void save_trace_state_variables (struct ui_file
*fp
);
234 extern void tfind_1 (enum trace_find_type type
, int num
,
235 ULONGEST addr1
, ULONGEST addr2
,
238 extern void trace_save (const char *filename
, int target_does_save
);
240 extern struct traceframe_info
*parse_traceframe_info (const char *tframe_info
);
242 extern int traceframe_available_memory (VEC(mem_range_s
) **result
,
243 CORE_ADDR memaddr
, ULONGEST len
);
245 #endif /* TRACEPOINT_H */