1 /* Data structures associated with tracepoints in GDB.
2 Copyright (C) 1997, 1998, 1999, 2000, 2007, 2008, 2009, 2010
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"
34 /* A trace state variable is a value managed by a target being
35 traced. A trace state variable (or tsv for short) can be accessed
36 and assigned to by tracepoint actions and conditionals, but is not
37 part of the program being traced, and it doesn't have to be
38 collected. Effectively the variables are scratch space for
41 struct trace_state_variable
43 /* The variable's name. The user has to prefix with a dollar sign,
44 but we don't store that internally. */
47 /* An id number assigned by GDB, and transmitted to targets. */
50 /* The initial value of a variable is a 64-bit signed integer. */
51 LONGEST initial_value
;
53 /* 1 if the value is known, else 0. The value is known during a
54 trace run, or in tfind mode if the variable was collected into
55 the current trace frame. */
58 /* The value of a variable is a 64-bit signed integer. */
61 /* This is true for variables that are predefined and built into
66 /* The trace status encompasses various info about the general state
67 of the tracing run. */
69 enum trace_stop_reason
71 trace_stop_reason_unknown
,
82 /* This is true if the status is coming from a file rather
83 than a live target. */
86 /* This is true if the value of the running field is known. */
91 enum trace_stop_reason stop_reason
;
93 /* If stop_reason is tracepoint_passcount or tracepoint_error, this
94 is the (on-target) number of the tracepoint which caused the
96 int stopping_tracepoint
;
98 /* If stop_reason is tracepoint_error, this is a human-readable
99 string that describes the error that happened on the target. */
102 /* Number of traceframes currently in the buffer. */
104 int traceframe_count
;
106 /* Number of traceframes created since start of run. */
108 int traceframes_created
;
110 /* Total size of the target's trace buffer. */
114 /* Unused bytes left in the target's trace buffer. */
119 struct trace_status
*current_trace_status (void);
121 extern char *default_collect
;
123 /* Struct to collect random info about tracepoints on the target. */
125 struct uploaded_string
128 struct uploaded_string
*next
;
143 int num_step_actions
;
144 char *step_actions
[100];
146 /* The original string defining the location of the tracepoint. */
149 /* The original string defining the tracepoint's condition. */
152 /* List of original strings defining the tracepoint's actions. */
153 struct uploaded_string
*cmd_strings
;
155 struct uploaded_tp
*next
;
158 /* Struct recording info about trace state variables on the target. */
164 LONGEST initial_value
;
166 struct uploaded_tsv
*next
;
169 /* A hook used to notify the UI of tracepoint operations. */
171 extern void (*deprecated_trace_find_hook
) (char *arg
, int from_tty
);
172 extern void (*deprecated_trace_start_stop_hook
) (int start
, int from_tty
);
174 int get_traceframe_number (void);
175 void set_traceframe_number (int);
176 struct cleanup
*make_cleanup_restore_current_traceframe (void);
178 void free_actions (struct breakpoint
*);
179 enum actionline_type
validate_actionline (char **, struct breakpoint
*);
181 extern void end_actions_pseudocommand (char *args
, int from_tty
);
182 extern void while_stepping_pseudocommand (char *args
, int from_tty
);
184 extern struct trace_state_variable
*find_trace_state_variable (const char *name
);
185 extern struct trace_state_variable
*create_trace_state_variable (const char *name
);
187 extern int encode_source_string (int num
, ULONGEST addr
,
188 char *srctype
, char *src
,
189 char *buf
, int buf_size
);
191 extern void parse_trace_status (char *line
, struct trace_status
*ts
);
193 extern void parse_tracepoint_definition (char *line
, struct uploaded_tp
**utpp
);
194 extern void parse_tsv_definition (char *line
, struct uploaded_tsv
**utsvp
);
196 extern struct uploaded_tp
*get_uploaded_tp (int num
, ULONGEST addr
,
197 struct uploaded_tp
**utpp
);
198 extern struct breakpoint
*create_tracepoint_from_upload (struct uploaded_tp
*utp
);
199 extern void merge_uploaded_tracepoints (struct uploaded_tp
**utpp
);
200 extern void merge_uploaded_trace_state_variables (struct uploaded_tsv
**utsvp
);
202 extern void disconnect_or_stop_tracing (int from_tty
);
204 extern void start_tracing (void);
205 extern void stop_tracing (void);
207 extern void trace_status_mi (int on_stop
);
209 extern void tvariables_info_1 (void);
211 extern void tfind_1 (enum trace_find_type type
, int num
,
212 ULONGEST addr1
, ULONGEST addr2
,
215 extern void trace_save (const char *filename
, int target_does_save
);
217 #endif /* TRACEPOINT_H */