Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Data structures associated with tracepoints in GDB. |
8acc9f48 | 2 | Copyright (C) 1997-2013 Free Software Foundation, Inc. |
c906108c | 3 | |
c5aa993b | 4 | This file is part of GDB. |
c906108c | 5 | |
c5aa993b JM |
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 | |
a9762ec7 | 8 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 9 | (at your option) any later version. |
c906108c | 10 | |
c5aa993b JM |
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. | |
c906108c | 15 | |
c5aa993b | 16 | You should have received a copy of the GNU General Public License |
a9762ec7 | 17 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c SS |
18 | |
19 | #if !defined (TRACEPOINT_H) | |
20 | #define TRACEPOINT_H 1 | |
21 | ||
f197e0f1 VP |
22 | #include "breakpoint.h" |
23 | #include "target.h" | |
2a7498d8 | 24 | #include "memrange.h" |
fa864999 | 25 | #include "gdb_vecs.h" |
f197e0f1 | 26 | |
f61e138d | 27 | /* A trace state variable is a value managed by a target being |
c378eb4e | 28 | traced. A trace state variable (or tsv for short) can be accessed |
f61e138d SS |
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 | |
c378eb4e | 31 | collected. Effectively the variables are scratch space for |
f61e138d SS |
32 | tracepoints. */ |
33 | ||
34 | struct trace_state_variable | |
35 | { | |
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; | |
00bf0b85 SS |
53 | |
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 | ||
62 | enum trace_stop_reason | |
63 | { | |
64 | trace_stop_reason_unknown, | |
65 | trace_never_run, | |
66 | tstop_command, | |
67 | trace_buffer_full, | |
68 | trace_disconnected, | |
6c28cbf2 SS |
69 | tracepoint_passcount, |
70 | tracepoint_error | |
f61e138d SS |
71 | }; |
72 | ||
00bf0b85 SS |
73 | struct trace_status |
74 | { | |
75 | /* This is true if the status is coming from a file rather | |
76 | than a live target. */ | |
77 | int from_file; | |
78 | ||
79 | /* This is true if the value of the running field is known. */ | |
80 | int running_known; | |
81 | ||
f196051f | 82 | /* This is true when the trace experiment is actually running. */ |
00bf0b85 SS |
83 | int running; |
84 | ||
85 | enum trace_stop_reason stop_reason; | |
86 | ||
6c28cbf2 SS |
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. */ | |
00bf0b85 SS |
90 | int stopping_tracepoint; |
91 | ||
f196051f SS |
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; | |
6c28cbf2 | 97 | |
4daf5ac0 SS |
98 | /* Number of traceframes currently in the buffer. */ |
99 | ||
00bf0b85 SS |
100 | int traceframe_count; |
101 | ||
4daf5ac0 SS |
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. */ | |
00bf0b85 | 111 | |
4daf5ac0 | 112 | int buffer_free; |
33da3f1c SS |
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; | |
f196051f SS |
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; | |
00bf0b85 SS |
139 | }; |
140 | ||
141 | struct trace_status *current_trace_status (void); | |
c906108c | 142 | |
35b1e5cc SS |
143 | extern char *default_collect; |
144 | ||
00bf0b85 SS |
145 | /* Struct to collect random info about tracepoints on the target. */ |
146 | ||
409873ef SS |
147 | struct uploaded_tp |
148 | { | |
00bf0b85 SS |
149 | int number; |
150 | enum bptype type; | |
151 | ULONGEST addr; | |
152 | int enabled; | |
153 | int step; | |
154 | int pass; | |
155 | int orig_size; | |
3149d8c1 SS |
156 | |
157 | /* String that is the encoded form of the tracepoint's condition. */ | |
00bf0b85 | 158 | char *cond; |
3149d8c1 | 159 | |
3e43a32a MS |
160 | /* Vectors of strings that are the encoded forms of a tracepoint's |
161 | actions. */ | |
3149d8c1 SS |
162 | VEC(char_ptr) *actions; |
163 | VEC(char_ptr) *step_actions; | |
409873ef SS |
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. */ | |
3149d8c1 | 172 | VEC(char_ptr) *cmd_strings; |
409873ef | 173 | |
f196051f SS |
174 | /* The tracepoint's current hit count. */ |
175 | int hit_count; | |
176 | ||
177 | /* The tracepoint's current traceframe usage. */ | |
178 | ULONGEST traceframe_usage; | |
179 | ||
00bf0b85 SS |
180 | struct uploaded_tp *next; |
181 | }; | |
182 | ||
183 | /* Struct recording info about trace state variables on the target. */ | |
184 | ||
409873ef SS |
185 | struct uploaded_tsv |
186 | { | |
00bf0b85 SS |
187 | const char *name; |
188 | int number; | |
189 | LONGEST initial_value; | |
190 | int builtin; | |
191 | struct uploaded_tsv *next; | |
192 | }; | |
193 | ||
0fb4aa4b PA |
194 | /* Struct recording info about a target static tracepoint marker. */ |
195 | ||
196 | struct 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 | ||
208 | extern void parse_static_tracepoint_marker_definition | |
209 | (char *line, char **pp, | |
210 | struct static_tracepoint_marker *marker); | |
211 | extern void release_static_tracepoint_marker (struct static_tracepoint_marker *); | |
5808517f | 212 | extern void free_current_marker (void *arg); |
0fb4aa4b | 213 | |
d183932d | 214 | /* A hook used to notify the UI of tracepoint operations. */ |
c906108c | 215 | |
98c5b216 TT |
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); | |
c906108c | 218 | |
e6e4e701 PA |
219 | /* Returns the current traceframe number. */ |
220 | extern 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. */ | |
228 | extern 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.). */ | |
233 | extern void set_current_traceframe (int num); | |
234 | ||
06cd862c | 235 | struct cleanup *make_cleanup_restore_current_traceframe (void); |
e6e4e701 | 236 | struct cleanup *make_cleanup_restore_traceframe_number (void); |
06cd862c | 237 | |
1042e4c0 | 238 | void free_actions (struct breakpoint *); |
3065dfb6 SS |
239 | |
240 | extern char *decode_agent_options (char *exp); | |
241 | ||
5fbce5df PA |
242 | extern void encode_actions (struct breakpoint *t, struct bp_location *tloc, |
243 | char ***tdp_actions, char ***stepping_actions); | |
244 | ||
fff87407 | 245 | extern void validate_actionline (char **, struct breakpoint *); |
c906108c | 246 | |
1042e4c0 SS |
247 | extern void end_actions_pseudocommand (char *args, int from_tty); |
248 | extern void while_stepping_pseudocommand (char *args, int from_tty); | |
c906108c | 249 | |
f61e138d | 250 | extern struct trace_state_variable *find_trace_state_variable (const char *name); |
40e1c229 | 251 | extern struct trace_state_variable *create_trace_state_variable (const char *name); |
f61e138d | 252 | |
409873ef SS |
253 | extern int encode_source_string (int num, ULONGEST addr, |
254 | char *srctype, char *src, | |
255 | char *buf, int buf_size); | |
256 | ||
00bf0b85 SS |
257 | extern void parse_trace_status (char *line, struct trace_status *ts); |
258 | ||
f196051f SS |
259 | extern void parse_tracepoint_status (char *p, struct breakpoint *tp, |
260 | struct uploaded_tp *utp); | |
261 | ||
3e43a32a MS |
262 | extern void parse_tracepoint_definition (char *line, |
263 | struct uploaded_tp **utpp); | |
00bf0b85 SS |
264 | extern void parse_tsv_definition (char *line, struct uploaded_tsv **utsvp); |
265 | ||
266 | extern struct uploaded_tp *get_uploaded_tp (int num, ULONGEST addr, | |
267 | struct uploaded_tp **utpp); | |
d9b3f62e | 268 | extern struct tracepoint *create_tracepoint_from_upload (struct uploaded_tp *utp); |
00bf0b85 SS |
269 | extern void merge_uploaded_tracepoints (struct uploaded_tp **utpp); |
270 | extern void merge_uploaded_trace_state_variables (struct uploaded_tsv **utsvp); | |
271 | ||
33da3f1c | 272 | extern void disconnect_tracing (int from_tty); |
573cda03 | 273 | |
f196051f SS |
274 | extern void start_tracing (char *notes); |
275 | extern void stop_tracing (char *notes); | |
f224b49d VP |
276 | |
277 | extern void trace_status_mi (int on_stop); | |
278 | ||
40e1c229 | 279 | extern void tvariables_info_1 (void); |
8bf6485c | 280 | extern void save_trace_state_variables (struct ui_file *fp); |
40e1c229 | 281 | |
f197e0f1 VP |
282 | extern void tfind_1 (enum trace_find_type type, int num, |
283 | ULONGEST addr1, ULONGEST addr2, | |
284 | int from_tty); | |
285 | ||
011aacb0 VP |
286 | extern void trace_save (const char *filename, int target_does_save); |
287 | ||
b3b9301e PA |
288 | extern struct traceframe_info *parse_traceframe_info (const char *tframe_info); |
289 | ||
2a7498d8 PA |
290 | extern int traceframe_available_memory (VEC(mem_range_s) **result, |
291 | CORE_ADDR memaddr, ULONGEST len); | |
292 | ||
d183932d | 293 | #endif /* TRACEPOINT_H */ |