Upgrade GDB from 7.4.1 to 7.6.1 on the vendor branch
[dragonfly.git] / contrib / gdb-7 / gdb / tracepoint.h
CommitLineData
5796c8dc 1/* Data structures associated with tracepoints in GDB.
ef5ccd6c 2 Copyright (C) 1997-2013 Free Software Foundation, Inc.
5796c8dc
SS
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
cf7f2e2d
JM
22#include "breakpoint.h"
23#include "target.h"
c50c785c 24#include "memrange.h"
ef5ccd6c 25#include "gdb_vecs.h"
cf7f2e2d
JM
26
27/* A trace state variable is a value managed by a target being
c50c785c 28 traced. A trace state variable (or tsv for short) can be accessed
cf7f2e2d
JM
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
c50c785c 31 collected. Effectively the variables are scratch space for
cf7f2e2d
JM
32 tracepoints. */
33
34struct trace_state_variable
5796c8dc 35 {
cf7f2e2d
JM
36 /* The variable's name. The user has to prefix with a dollar sign,
37 but we don't store that internally. */
38 const char *name;
39
40 /* An id number assigned by GDB, and transmitted to targets. */
41 int number;
42
43 /* The initial value of a variable is a 64-bit signed integer. */
44 LONGEST initial_value;
45
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. */
49 int value_known;
50
51 /* The value of a variable is a 64-bit signed integer. */
52 LONGEST value;
5796c8dc 53
cf7f2e2d
JM
54 /* This is true for variables that are predefined and built into
55 the target. */
56 int builtin;
57 };
58
59/* The trace status encompasses various info about the general state
60 of the tracing run. */
61
62enum trace_stop_reason
5796c8dc 63 {
cf7f2e2d
JM
64 trace_stop_reason_unknown,
65 trace_never_run,
66 tstop_command,
67 trace_buffer_full,
68 trace_disconnected,
69 tracepoint_passcount,
70 tracepoint_error
5796c8dc
SS
71 };
72
cf7f2e2d
JM
73struct trace_status
74{
ef5ccd6c
JM
75 /* If the status is coming from a file rather than a live target,
76 this points at the file's filename. Otherwise, this is NULL. */
77 const char *filename;
cf7f2e2d
JM
78
79 /* This is true if the value of the running field is known. */
80 int running_known;
81
a45ae5f8 82 /* This is true when the trace experiment is actually running. */
cf7f2e2d
JM
83 int running;
84
85 enum trace_stop_reason stop_reason;
86
87 /* If stop_reason is tracepoint_passcount or tracepoint_error, this
88 is the (on-target) number of the tracepoint which caused the
89 stop. */
90 int stopping_tracepoint;
91
a45ae5f8
JM
92 /* If stop_reason is tstop_command or tracepoint_error, this is an
93 arbitrary string that may describe the reason for the stop in
94 more detail. */
95
96 char *stop_desc;
cf7f2e2d
JM
97
98 /* Number of traceframes currently in the buffer. */
99
100 int traceframe_count;
101
102 /* Number of traceframes created since start of run. */
103
104 int traceframes_created;
105
106 /* Total size of the target's trace buffer. */
107
108 int buffer_size;
109
110 /* Unused bytes left in the target's trace buffer. */
111
112 int buffer_free;
113
114 /* 1 if the target will continue tracing after disconnection, else
115 0. If the target does not report a value, assume 0. */
116
117 int disconnected_tracing;
118
119 /* 1 if the target is using a circular trace buffer, else 0. If the
120 target does not report a value, assume 0. */
121
122 int circular_buffer;
a45ae5f8
JM
123
124 /* The "name" of the person running the trace. This is an
125 arbitrary string. */
126
127 char *user_name;
128
129 /* "Notes" about the trace. This is an arbitrary string not
130 interpreted by GDBserver in any special way. */
131
132 char *notes;
133
134 /* The calendar times at which the trace run started and stopped,
135 both expressed in microseconds of Unix time. */
136
137 LONGEST start_time;
138 LONGEST stop_time;
cf7f2e2d
JM
139};
140
141struct trace_status *current_trace_status (void);
142
143extern char *default_collect;
144
145/* Struct to collect random info about tracepoints on the target. */
146
cf7f2e2d
JM
147struct uploaded_tp
148{
149 int number;
150 enum bptype type;
151 ULONGEST addr;
152 int enabled;
153 int step;
154 int pass;
155 int orig_size;
156
157 /* String that is the encoded form of the tracepoint's condition. */
158 char *cond;
159
c50c785c
JM
160 /* Vectors of strings that are the encoded forms of a tracepoint's
161 actions. */
cf7f2e2d
JM
162 VEC(char_ptr) *actions;
163 VEC(char_ptr) *step_actions;
164
165 /* The original string defining the location of the tracepoint. */
166 char *at_string;
167
168 /* The original string defining the tracepoint's condition. */
169 char *cond_string;
170
171 /* List of original strings defining the tracepoint's actions. */
172 VEC(char_ptr) *cmd_strings;
173
a45ae5f8
JM
174 /* The tracepoint's current hit count. */
175 int hit_count;
176
177 /* The tracepoint's current traceframe usage. */
178 ULONGEST traceframe_usage;
179
cf7f2e2d
JM
180 struct uploaded_tp *next;
181};
182
183/* Struct recording info about trace state variables on the target. */
184
185struct uploaded_tsv
186{
187 const char *name;
188 int number;
189 LONGEST initial_value;
190 int builtin;
191 struct uploaded_tsv *next;
192};
193
194/* Struct recording info about a target static tracepoint marker. */
195
196struct static_tracepoint_marker
197{
198 struct gdbarch *gdbarch;
199 CORE_ADDR address;
200
201 /* The string ID of the marker. */
202 char *str_id;
203
204 /* Extra target reported info associated with the marker. */
205 char *extra;
206};
207
208extern void parse_static_tracepoint_marker_definition
209 (char *line, char **pp,
210 struct static_tracepoint_marker *marker);
211extern void release_static_tracepoint_marker (struct static_tracepoint_marker *);
ef5ccd6c 212extern void free_current_marker (void *arg);
5796c8dc
SS
213
214/* A hook used to notify the UI of tracepoint operations. */
215
cf7f2e2d
JM
216extern void (*deprecated_trace_find_hook) (char *arg, int from_tty);
217extern void (*deprecated_trace_start_stop_hook) (int start, int from_tty);
5796c8dc 218
c50c785c
JM
219/* Returns the current traceframe number. */
220extern int get_traceframe_number (void);
221
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. */
228extern void set_traceframe_number (int);
229
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,
232 etc.). */
233extern void set_current_traceframe (int num);
234
cf7f2e2d 235struct cleanup *make_cleanup_restore_current_traceframe (void);
c50c785c 236struct cleanup *make_cleanup_restore_traceframe_number (void);
cf7f2e2d 237
5796c8dc 238void free_actions (struct breakpoint *);
a45ae5f8
JM
239
240extern char *decode_agent_options (char *exp);
241
ef5ccd6c
JM
242extern void encode_actions (struct breakpoint *t, struct bp_location *tloc,
243 char ***tdp_actions, char ***stepping_actions);
5796c8dc 244
ef5ccd6c
JM
245extern void validate_actionline (char **, struct breakpoint *);
246extern void validate_trace_state_variable_name (const char *name);
5796c8dc 247
cf7f2e2d
JM
248extern struct trace_state_variable *find_trace_state_variable (const char *name);
249extern struct trace_state_variable *create_trace_state_variable (const char *name);
250
251extern int encode_source_string (int num, ULONGEST addr,
252 char *srctype, char *src,
253 char *buf, int buf_size);
254
255extern void parse_trace_status (char *line, struct trace_status *ts);
256
a45ae5f8
JM
257extern void parse_tracepoint_status (char *p, struct breakpoint *tp,
258 struct uploaded_tp *utp);
259
c50c785c
JM
260extern void parse_tracepoint_definition (char *line,
261 struct uploaded_tp **utpp);
cf7f2e2d
JM
262extern void parse_tsv_definition (char *line, struct uploaded_tsv **utsvp);
263
264extern struct uploaded_tp *get_uploaded_tp (int num, ULONGEST addr,
265 struct uploaded_tp **utpp);
a45ae5f8 266extern struct tracepoint *create_tracepoint_from_upload (struct uploaded_tp *utp);
cf7f2e2d
JM
267extern void merge_uploaded_tracepoints (struct uploaded_tp **utpp);
268extern void merge_uploaded_trace_state_variables (struct uploaded_tsv **utsvp);
269
270extern void disconnect_tracing (int from_tty);
271
a45ae5f8
JM
272extern void start_tracing (char *notes);
273extern void stop_tracing (char *notes);
cf7f2e2d
JM
274
275extern void trace_status_mi (int on_stop);
276
277extern void tvariables_info_1 (void);
278extern void save_trace_state_variables (struct ui_file *fp);
279
280extern void tfind_1 (enum trace_find_type type, int num,
281 ULONGEST addr1, ULONGEST addr2,
282 int from_tty);
283
284extern void trace_save (const char *filename, int target_does_save);
285
c50c785c
JM
286extern struct traceframe_info *parse_traceframe_info (const char *tframe_info);
287
288extern int traceframe_available_memory (VEC(mem_range_s) **result,
289 CORE_ADDR memaddr, ULONGEST len);
290
5796c8dc 291#endif /* TRACEPOINT_H */