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