Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Data structures associated with tracepoints in GDB. |
618f726f | 2 | Copyright (C) 1997-2016 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 | |
1f45808e PA |
27 | #include <vector> |
28 | #include <string> | |
29 | ||
393fd4c3 YQ |
30 | /* An object describing the contents of a traceframe. */ |
31 | ||
32 | struct traceframe_info | |
33 | { | |
34 | /* Collected memory. */ | |
35 | VEC(mem_range_s) *memory; | |
28a93511 YQ |
36 | |
37 | /* Collected trace state variables. */ | |
38 | VEC(int) *tvars; | |
393fd4c3 YQ |
39 | }; |
40 | ||
f61e138d | 41 | /* A trace state variable is a value managed by a target being |
c378eb4e | 42 | traced. A trace state variable (or tsv for short) can be accessed |
f61e138d SS |
43 | and assigned to by tracepoint actions and conditionals, but is not |
44 | part of the program being traced, and it doesn't have to be | |
c378eb4e | 45 | collected. Effectively the variables are scratch space for |
f61e138d SS |
46 | tracepoints. */ |
47 | ||
48 | struct trace_state_variable | |
49 | { | |
50 | /* The variable's name. The user has to prefix with a dollar sign, | |
51 | but we don't store that internally. */ | |
52 | const char *name; | |
53 | ||
54 | /* An id number assigned by GDB, and transmitted to targets. */ | |
55 | int number; | |
56 | ||
57 | /* The initial value of a variable is a 64-bit signed integer. */ | |
58 | LONGEST initial_value; | |
59 | ||
60 | /* 1 if the value is known, else 0. The value is known during a | |
61 | trace run, or in tfind mode if the variable was collected into | |
62 | the current trace frame. */ | |
63 | int value_known; | |
64 | ||
65 | /* The value of a variable is a 64-bit signed integer. */ | |
66 | LONGEST value; | |
00bf0b85 SS |
67 | |
68 | /* This is true for variables that are predefined and built into | |
69 | the target. */ | |
70 | int builtin; | |
71 | }; | |
72 | ||
73 | /* The trace status encompasses various info about the general state | |
74 | of the tracing run. */ | |
75 | ||
76 | enum trace_stop_reason | |
77 | { | |
78 | trace_stop_reason_unknown, | |
79 | trace_never_run, | |
80 | tstop_command, | |
81 | trace_buffer_full, | |
82 | trace_disconnected, | |
6c28cbf2 SS |
83 | tracepoint_passcount, |
84 | tracepoint_error | |
f61e138d SS |
85 | }; |
86 | ||
00bf0b85 SS |
87 | struct trace_status |
88 | { | |
f5911ea1 HAQ |
89 | /* If the status is coming from a file rather than a live target, |
90 | this points at the file's filename. Otherwise, this is NULL. */ | |
91 | const char *filename; | |
00bf0b85 SS |
92 | |
93 | /* This is true if the value of the running field is known. */ | |
94 | int running_known; | |
95 | ||
f196051f | 96 | /* This is true when the trace experiment is actually running. */ |
00bf0b85 SS |
97 | int running; |
98 | ||
99 | enum trace_stop_reason stop_reason; | |
100 | ||
6c28cbf2 SS |
101 | /* If stop_reason is tracepoint_passcount or tracepoint_error, this |
102 | is the (on-target) number of the tracepoint which caused the | |
103 | stop. */ | |
00bf0b85 SS |
104 | int stopping_tracepoint; |
105 | ||
f196051f SS |
106 | /* If stop_reason is tstop_command or tracepoint_error, this is an |
107 | arbitrary string that may describe the reason for the stop in | |
108 | more detail. */ | |
109 | ||
110 | char *stop_desc; | |
6c28cbf2 | 111 | |
4daf5ac0 SS |
112 | /* Number of traceframes currently in the buffer. */ |
113 | ||
00bf0b85 SS |
114 | int traceframe_count; |
115 | ||
4daf5ac0 SS |
116 | /* Number of traceframes created since start of run. */ |
117 | ||
118 | int traceframes_created; | |
119 | ||
120 | /* Total size of the target's trace buffer. */ | |
121 | ||
122 | int buffer_size; | |
123 | ||
124 | /* Unused bytes left in the target's trace buffer. */ | |
00bf0b85 | 125 | |
4daf5ac0 | 126 | int buffer_free; |
33da3f1c SS |
127 | |
128 | /* 1 if the target will continue tracing after disconnection, else | |
129 | 0. If the target does not report a value, assume 0. */ | |
130 | ||
131 | int disconnected_tracing; | |
132 | ||
133 | /* 1 if the target is using a circular trace buffer, else 0. If the | |
134 | target does not report a value, assume 0. */ | |
135 | ||
136 | int circular_buffer; | |
f196051f SS |
137 | |
138 | /* The "name" of the person running the trace. This is an | |
139 | arbitrary string. */ | |
140 | ||
141 | char *user_name; | |
142 | ||
143 | /* "Notes" about the trace. This is an arbitrary string not | |
144 | interpreted by GDBserver in any special way. */ | |
145 | ||
146 | char *notes; | |
147 | ||
148 | /* The calendar times at which the trace run started and stopped, | |
149 | both expressed in microseconds of Unix time. */ | |
150 | ||
151 | LONGEST start_time; | |
152 | LONGEST stop_time; | |
00bf0b85 SS |
153 | }; |
154 | ||
155 | struct trace_status *current_trace_status (void); | |
c906108c | 156 | |
35b1e5cc SS |
157 | extern char *default_collect; |
158 | ||
393fd4c3 YQ |
159 | extern int trace_regblock_size; |
160 | ||
7951c4eb YQ |
161 | extern const char *stop_reason_names[]; |
162 | ||
00bf0b85 SS |
163 | /* Struct to collect random info about tracepoints on the target. */ |
164 | ||
409873ef SS |
165 | struct uploaded_tp |
166 | { | |
00bf0b85 SS |
167 | int number; |
168 | enum bptype type; | |
169 | ULONGEST addr; | |
170 | int enabled; | |
171 | int step; | |
172 | int pass; | |
173 | int orig_size; | |
3149d8c1 SS |
174 | |
175 | /* String that is the encoded form of the tracepoint's condition. */ | |
00bf0b85 | 176 | char *cond; |
3149d8c1 | 177 | |
3e43a32a MS |
178 | /* Vectors of strings that are the encoded forms of a tracepoint's |
179 | actions. */ | |
3149d8c1 SS |
180 | VEC(char_ptr) *actions; |
181 | VEC(char_ptr) *step_actions; | |
409873ef SS |
182 | |
183 | /* The original string defining the location of the tracepoint. */ | |
184 | char *at_string; | |
185 | ||
186 | /* The original string defining the tracepoint's condition. */ | |
187 | char *cond_string; | |
188 | ||
189 | /* List of original strings defining the tracepoint's actions. */ | |
3149d8c1 | 190 | VEC(char_ptr) *cmd_strings; |
409873ef | 191 | |
f196051f SS |
192 | /* The tracepoint's current hit count. */ |
193 | int hit_count; | |
194 | ||
195 | /* The tracepoint's current traceframe usage. */ | |
196 | ULONGEST traceframe_usage; | |
197 | ||
00bf0b85 SS |
198 | struct uploaded_tp *next; |
199 | }; | |
200 | ||
201 | /* Struct recording info about trace state variables on the target. */ | |
202 | ||
409873ef SS |
203 | struct uploaded_tsv |
204 | { | |
00bf0b85 SS |
205 | const char *name; |
206 | int number; | |
207 | LONGEST initial_value; | |
208 | int builtin; | |
209 | struct uploaded_tsv *next; | |
210 | }; | |
211 | ||
0fb4aa4b PA |
212 | /* Struct recording info about a target static tracepoint marker. */ |
213 | ||
214 | struct static_tracepoint_marker | |
215 | { | |
216 | struct gdbarch *gdbarch; | |
217 | CORE_ADDR address; | |
218 | ||
219 | /* The string ID of the marker. */ | |
220 | char *str_id; | |
221 | ||
222 | /* Extra target reported info associated with the marker. */ | |
223 | char *extra; | |
224 | }; | |
225 | ||
dc673c81 YQ |
226 | struct memrange |
227 | { | |
1f45808e PA |
228 | memrange (int type_, bfd_signed_vma start_, bfd_signed_vma end_) |
229 | : type (type_), start (start_), end (end_) | |
230 | {} | |
231 | ||
232 | memrange () | |
233 | {} | |
234 | ||
dc673c81 YQ |
235 | /* memrange_absolute for absolute memory range, else basereg |
236 | number. */ | |
237 | int type; | |
238 | bfd_signed_vma start; | |
239 | bfd_signed_vma end; | |
240 | }; | |
241 | ||
1f45808e | 242 | class collection_list |
dc673c81 | 243 | { |
1f45808e PA |
244 | public: |
245 | collection_list (); | |
1f45808e PA |
246 | |
247 | void add_wholly_collected (const char *print_name); | |
248 | ||
249 | void append_exp (struct expression *exp); | |
250 | ||
833177a4 PA |
251 | /* Add AEXPR to the list, taking ownership. */ |
252 | void add_aexpr (agent_expr_up aexpr); | |
253 | ||
1f45808e PA |
254 | void add_register (unsigned int regno); |
255 | void add_memrange (int type, bfd_signed_vma base, | |
256 | unsigned long len); | |
257 | void collect_symbol (struct symbol *sym, | |
258 | struct gdbarch *gdbarch, | |
259 | long frame_regno, long frame_offset, | |
260 | CORE_ADDR scope, | |
261 | int trace_string); | |
262 | ||
263 | void add_local_symbols (struct gdbarch *gdbarch, CORE_ADDR pc, | |
264 | long frame_regno, long frame_offset, int type, | |
265 | int trace_string); | |
266 | void add_static_trace_data (); | |
267 | ||
268 | void finish (); | |
269 | ||
270 | char **stringify (); | |
271 | ||
272 | const std::vector<std::string> &wholly_collected () | |
273 | { return m_wholly_collected; } | |
274 | ||
275 | const std::vector<std::string> &computed () | |
276 | { return m_computed; } | |
277 | ||
278 | private: | |
dc673c81 | 279 | /* room for up to 256 regs */ |
1f45808e PA |
280 | unsigned char m_regs_mask[32]; |
281 | ||
282 | std::vector<memrange> m_memranges; | |
dc673c81 | 283 | |
6c73cd95 | 284 | std::vector<agent_expr_up> m_aexprs; |
dc673c81 YQ |
285 | |
286 | /* True is the user requested a collection of "$_sdata", "static | |
287 | tracepoint data". */ | |
1f45808e | 288 | bool m_strace_data; |
dc673c81 YQ |
289 | |
290 | /* A set of names of wholly collected objects. */ | |
1f45808e | 291 | std::vector<std::string> m_wholly_collected; |
dc673c81 | 292 | /* A set of computed expressions. */ |
1f45808e | 293 | std::vector<std::string> m_computed; |
dc673c81 YQ |
294 | }; |
295 | ||
0fb4aa4b PA |
296 | extern void parse_static_tracepoint_marker_definition |
297 | (char *line, char **pp, | |
298 | struct static_tracepoint_marker *marker); | |
299 | extern void release_static_tracepoint_marker (struct static_tracepoint_marker *); | |
5808517f | 300 | extern void free_current_marker (void *arg); |
0fb4aa4b | 301 | |
d183932d | 302 | /* A hook used to notify the UI of tracepoint operations. */ |
c906108c | 303 | |
98c5b216 TT |
304 | extern void (*deprecated_trace_find_hook) (char *arg, int from_tty); |
305 | extern void (*deprecated_trace_start_stop_hook) (int start, int from_tty); | |
c906108c | 306 | |
e6e4e701 PA |
307 | /* Returns the current traceframe number. */ |
308 | extern int get_traceframe_number (void); | |
309 | ||
393fd4c3 YQ |
310 | /* Returns the tracepoint number for current traceframe. */ |
311 | extern int get_tracepoint_number (void); | |
312 | ||
e6e4e701 PA |
313 | /* Make the traceframe NUM be the current trace frame, all the way to |
314 | the target, and flushes all global state (register/frame caches, | |
315 | etc.). */ | |
316 | extern void set_current_traceframe (int num); | |
317 | ||
06cd862c PA |
318 | struct cleanup *make_cleanup_restore_current_traceframe (void); |
319 | ||
1042e4c0 | 320 | void free_actions (struct breakpoint *); |
3065dfb6 | 321 | |
92bc6a20 | 322 | extern const char *decode_agent_options (const char *exp, int *trace_string); |
3065dfb6 | 323 | |
1f45808e PA |
324 | extern void encode_actions (struct bp_location *tloc, |
325 | struct collection_list *tracepoint_list, | |
326 | struct collection_list *stepping_list); | |
dc673c81 YQ |
327 | |
328 | extern void encode_actions_rsp (struct bp_location *tloc, | |
329 | char ***tdp_actions, char ***stepping_actions); | |
5fbce5df | 330 | |
6f937416 | 331 | extern void validate_actionline (const char *, struct breakpoint *); |
1773c82c | 332 | extern void validate_trace_state_variable_name (const char *name); |
c906108c | 333 | |
f61e138d | 334 | extern struct trace_state_variable *find_trace_state_variable (const char *name); |
dc673c81 YQ |
335 | extern struct trace_state_variable * |
336 | find_trace_state_variable_by_number (int number); | |
337 | ||
40e1c229 | 338 | extern struct trace_state_variable *create_trace_state_variable (const char *name); |
f61e138d | 339 | |
409873ef | 340 | extern int encode_source_string (int num, ULONGEST addr, |
f00aae0f | 341 | char *srctype, const char *src, |
409873ef SS |
342 | char *buf, int buf_size); |
343 | ||
00bf0b85 SS |
344 | extern void parse_trace_status (char *line, struct trace_status *ts); |
345 | ||
f196051f SS |
346 | extern void parse_tracepoint_status (char *p, struct breakpoint *tp, |
347 | struct uploaded_tp *utp); | |
348 | ||
3e43a32a MS |
349 | extern void parse_tracepoint_definition (char *line, |
350 | struct uploaded_tp **utpp); | |
00bf0b85 SS |
351 | extern void parse_tsv_definition (char *line, struct uploaded_tsv **utsvp); |
352 | ||
353 | extern struct uploaded_tp *get_uploaded_tp (int num, ULONGEST addr, | |
354 | struct uploaded_tp **utpp); | |
7951c4eb YQ |
355 | extern void free_uploaded_tps (struct uploaded_tp **utpp); |
356 | ||
393fd4c3 YQ |
357 | extern struct uploaded_tsv *get_uploaded_tsv (int num, |
358 | struct uploaded_tsv **utsvp); | |
7951c4eb | 359 | extern void free_uploaded_tsvs (struct uploaded_tsv **utsvp); |
d9b3f62e | 360 | extern struct tracepoint *create_tracepoint_from_upload (struct uploaded_tp *utp); |
00bf0b85 SS |
361 | extern void merge_uploaded_tracepoints (struct uploaded_tp **utpp); |
362 | extern void merge_uploaded_trace_state_variables (struct uploaded_tsv **utsvp); | |
363 | ||
2f9d54cf PA |
364 | extern void query_if_trace_running (int from_tty); |
365 | extern void disconnect_tracing (void); | |
aef525cb | 366 | extern void trace_reset_local_state (void); |
573cda03 | 367 | |
cc3da688 YQ |
368 | extern void check_trace_running (struct trace_status *); |
369 | ||
f196051f SS |
370 | extern void start_tracing (char *notes); |
371 | extern void stop_tracing (char *notes); | |
f224b49d VP |
372 | |
373 | extern void trace_status_mi (int on_stop); | |
374 | ||
40e1c229 | 375 | extern void tvariables_info_1 (void); |
8bf6485c | 376 | extern void save_trace_state_variables (struct ui_file *fp); |
40e1c229 | 377 | |
f197e0f1 | 378 | extern void tfind_1 (enum trace_find_type type, int num, |
cc5925ad | 379 | CORE_ADDR addr1, CORE_ADDR addr2, |
f197e0f1 VP |
380 | int from_tty); |
381 | ||
3f43bc09 YQ |
382 | extern void trace_save_tfile (const char *filename, |
383 | int target_does_save); | |
d0353e76 YQ |
384 | extern void trace_save_ctf (const char *dirname, |
385 | int target_does_save); | |
011aacb0 | 386 | |
b3b9301e PA |
387 | extern struct traceframe_info *parse_traceframe_info (const char *tframe_info); |
388 | ||
2a7498d8 PA |
389 | extern int traceframe_available_memory (VEC(mem_range_s) **result, |
390 | CORE_ADDR memaddr, ULONGEST len); | |
391 | ||
dc673c81 YQ |
392 | extern struct traceframe_info *get_traceframe_info (void); |
393 | ||
394 | extern struct bp_location *get_traceframe_location (int *stepping_frame_p); | |
395 | ||
d183932d | 396 | #endif /* TRACEPOINT_H */ |