Automatic date update in version.in
[binutils-gdb.git] / gdb / tracepoint.h
blob5e6ea67c8d2056b031731caf46915ced48cab0a6
1 /* Data structures associated with tracepoints in GDB.
2 Copyright (C) 1997-2024 Free Software Foundation, Inc.
4 This file is part of GDB.
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.
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.
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/>. */
19 #if !defined (TRACEPOINT_H)
20 #define TRACEPOINT_H 1
22 #include "breakpoint.h"
23 #include "memrange.h"
24 #include "gdbsupport/gdb_vecs.h"
26 #include <vector>
27 #include <string>
29 /* An object describing the contents of a traceframe. */
31 struct traceframe_info
33 /* Collected memory. */
34 std::vector<mem_range> memory;
36 /* Collected trace state variables. */
37 std::vector<int> tvars;
40 typedef std::unique_ptr<traceframe_info> traceframe_info_up;
42 /* A trace state variable is a value managed by a target being
43 traced. A trace state variable (or tsv for short) can be accessed
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
46 collected. Effectively the variables are scratch space for
47 tracepoints. */
49 struct trace_state_variable
51 trace_state_variable (std::string &&name_, int number_)
52 : name (name_), number (number_)
55 /* The variable's name. The user has to prefix with a dollar sign,
56 but we don't store that internally. */
57 std::string name;
59 /* An id number assigned by GDB, and transmitted to targets. */
60 int number = 0;
62 /* The initial value of a variable is a 64-bit signed integer. */
63 LONGEST initial_value = 0;
65 /* 1 if the value is known, else 0. The value is known during a
66 trace run, or in tfind mode if the variable was collected into
67 the current trace frame. */
68 int value_known = 0;
70 /* The value of a variable is a 64-bit signed integer. */
71 LONGEST value = 0;
73 /* This is true for variables that are predefined and built into
74 the target. */
75 int builtin = 0;
78 /* The trace status encompasses various info about the general state
79 of the tracing run. */
81 enum trace_stop_reason
83 trace_stop_reason_unknown,
84 trace_never_run,
85 trace_stop_command,
86 trace_buffer_full,
87 trace_disconnected,
88 tracepoint_passcount,
89 tracepoint_error
92 struct trace_status
94 /* If the status is coming from a file rather than a live target,
95 this points at the file's filename. Otherwise, this is NULL. */
96 const char *filename;
98 /* This is true if the value of the running field is known. */
99 int running_known;
101 /* This is true when the trace experiment is actually running. */
102 int running;
104 enum trace_stop_reason stop_reason;
106 /* If stop_reason is tracepoint_passcount or tracepoint_error, this
107 is the (on-target) number of the tracepoint which caused the
108 stop. */
109 int stopping_tracepoint;
111 /* If stop_reason is tstop_command or tracepoint_error, this is an
112 arbitrary string that may describe the reason for the stop in
113 more detail. */
115 char *stop_desc;
117 /* Number of traceframes currently in the buffer. */
119 int traceframe_count;
121 /* Number of traceframes created since start of run. */
123 int traceframes_created;
125 /* Total size of the target's trace buffer. */
127 int buffer_size;
129 /* Unused bytes left in the target's trace buffer. */
131 int buffer_free;
133 /* 1 if the target will continue tracing after disconnection, else
134 0. If the target does not report a value, assume 0. */
136 int disconnected_tracing;
138 /* 1 if the target is using a circular trace buffer, else 0. If the
139 target does not report a value, assume 0. */
141 int circular_buffer;
143 /* The "name" of the person running the trace. This is an
144 arbitrary string. */
146 char *user_name;
148 /* "Notes" about the trace. This is an arbitrary string not
149 interpreted by GDBserver in any special way. */
151 char *notes;
153 /* The calendar times at which the trace run started and stopped,
154 both expressed in microseconds of Unix time. */
156 LONGEST start_time;
157 LONGEST stop_time;
160 struct trace_status *current_trace_status (void);
162 extern std::string default_collect;
164 extern int trace_regblock_size;
166 extern const char *stop_reason_names[];
168 /* Struct to collect random info about tracepoints on the target. */
170 struct uploaded_tp
172 int number = 0;
173 enum bptype type = bp_none;
174 ULONGEST addr = 0;
175 int enabled = 0;
176 int step = 0;
177 int pass = 0;
178 int orig_size = 0;
180 /* String that is the encoded form of the tracepoint's condition. */
181 gdb::unique_xmalloc_ptr<char[]> cond;
183 /* Vectors of strings that are the encoded forms of a tracepoint's
184 actions. */
185 std::vector<gdb::unique_xmalloc_ptr<char[]>> actions;
186 std::vector<gdb::unique_xmalloc_ptr<char[]>> step_actions;
188 /* The original string defining the location of the tracepoint. */
189 gdb::unique_xmalloc_ptr<char[]> at_string;
191 /* The original string defining the tracepoint's condition. */
192 gdb::unique_xmalloc_ptr<char[]> cond_string;
194 /* List of original strings defining the tracepoint's actions. */
195 std::vector<gdb::unique_xmalloc_ptr<char[]>> cmd_strings;
197 /* The tracepoint's current hit count. */
198 int hit_count = 0;
200 /* The tracepoint's current traceframe usage. */
201 ULONGEST traceframe_usage = 0;
203 struct uploaded_tp *next = nullptr;
206 /* Struct recording info about trace state variables on the target. */
208 struct uploaded_tsv
210 const char *name;
211 int number;
212 LONGEST initial_value;
213 int builtin;
214 struct uploaded_tsv *next;
217 /* Struct recording info about a target static tracepoint marker. */
219 struct static_tracepoint_marker
221 DISABLE_COPY_AND_ASSIGN (static_tracepoint_marker);
223 static_tracepoint_marker () = default;
224 static_tracepoint_marker (static_tracepoint_marker &&) = default;
225 static_tracepoint_marker &operator= (static_tracepoint_marker &&) = default;
227 struct gdbarch *gdbarch = NULL;
228 CORE_ADDR address = 0;
230 /* The string ID of the marker. */
231 std::string str_id;
233 /* Extra target reported info associated with the marker. */
234 std::string extra;
237 struct memrange
239 memrange (int type_, bfd_signed_vma start_, bfd_signed_vma end_)
240 : type (type_), start (start_), end (end_)
243 memrange ()
246 /* memrange_absolute for absolute memory range, else basereg
247 number. */
248 int type;
249 bfd_signed_vma start;
250 bfd_signed_vma end;
253 class collection_list
255 public:
256 collection_list ();
258 void add_wholly_collected (const char *print_name);
260 void append_exp (std::string &&exp);
262 /* Add AEXPR to the list, taking ownership. */
263 void add_aexpr (agent_expr_up aexpr);
265 void add_remote_register (unsigned int regno);
266 void add_ax_registers (struct agent_expr *aexpr);
267 void add_local_register (struct gdbarch *gdbarch,
268 unsigned int regno,
269 CORE_ADDR scope);
270 void add_memrange (struct gdbarch *gdbarch,
271 int type, bfd_signed_vma base,
272 unsigned long len, CORE_ADDR scope);
273 void collect_symbol (struct symbol *sym,
274 struct gdbarch *gdbarch,
275 long frame_regno, long frame_offset,
276 CORE_ADDR scope,
277 int trace_string);
279 void add_local_symbols (struct gdbarch *gdbarch, CORE_ADDR pc,
280 long frame_regno, long frame_offset, int type,
281 int trace_string);
282 void add_static_trace_data ();
284 void finish ();
286 std::vector<std::string> stringify ();
288 const std::vector<std::string> &wholly_collected ()
289 { return m_wholly_collected; }
291 const std::vector<std::string> &computed ()
292 { return m_computed; }
294 private:
295 /* We need the allocator zero-initialize the mask, so we don't use
296 gdb::byte_vector. */
297 std::vector<unsigned char> m_regs_mask;
299 std::vector<memrange> m_memranges;
301 std::vector<agent_expr_up> m_aexprs;
303 /* True is the user requested a collection of "$_sdata", "static
304 tracepoint data". */
305 bool m_strace_data;
307 /* A set of names of wholly collected objects. */
308 std::vector<std::string> m_wholly_collected;
309 /* A set of computed expressions. */
310 std::vector<std::string> m_computed;
313 extern void
314 parse_static_tracepoint_marker_definition (const char *line, const char **pp,
315 static_tracepoint_marker *marker);
317 /* Returns the current traceframe number. */
318 extern int get_traceframe_number (void);
320 /* Returns the tracepoint number for current traceframe. */
321 extern int get_tracepoint_number (void);
323 /* Make the traceframe NUM be the current trace frame, all the way to
324 the target, and flushes all global state (register/frame caches,
325 etc.). */
326 extern void set_current_traceframe (int num);
328 struct scoped_restore_current_traceframe
330 scoped_restore_current_traceframe ();
332 ~scoped_restore_current_traceframe ()
334 set_current_traceframe (m_traceframe_number);
337 DISABLE_COPY_AND_ASSIGN (scoped_restore_current_traceframe);
339 private:
341 /* The traceframe we were inspecting. */
342 int m_traceframe_number;
345 extern const char *decode_agent_options (const char *exp, int *trace_string);
347 extern void encode_actions (struct bp_location *tloc,
348 struct collection_list *tracepoint_list,
349 struct collection_list *stepping_list);
351 extern void encode_actions_rsp (struct bp_location *tloc,
352 std::vector<std::string> *tdp_actions,
353 std::vector<std::string> *stepping_actions);
355 extern void validate_actionline (const char *, tracepoint *);
356 extern void validate_trace_state_variable_name (const char *name);
358 extern struct trace_state_variable *find_trace_state_variable (const char *name);
359 extern struct trace_state_variable *
360 find_trace_state_variable_by_number (int number);
362 extern struct trace_state_variable *create_trace_state_variable (const char *name);
364 extern int encode_source_string (int num, ULONGEST addr,
365 const char *srctype, const char *src,
366 char *buf, int buf_size);
368 extern void parse_trace_status (const char *line, struct trace_status *ts);
370 extern void parse_tracepoint_status (const char *p, tracepoint *tp,
371 struct uploaded_tp *utp);
373 extern void parse_tracepoint_definition (const char *line,
374 struct uploaded_tp **utpp);
375 extern void parse_tsv_definition (const char *line, struct uploaded_tsv **utsvp);
377 extern struct uploaded_tp *get_uploaded_tp (int num, ULONGEST addr,
378 struct uploaded_tp **utpp);
379 extern void free_uploaded_tps (struct uploaded_tp **utpp);
381 extern struct uploaded_tsv *get_uploaded_tsv (int num,
382 struct uploaded_tsv **utsvp);
383 extern void free_uploaded_tsvs (struct uploaded_tsv **utsvp);
384 extern struct tracepoint *create_tracepoint_from_upload (struct uploaded_tp *utp);
385 extern void merge_uploaded_tracepoints (struct uploaded_tp **utpp);
386 extern void merge_uploaded_trace_state_variables (struct uploaded_tsv **utsvp);
388 extern void query_if_trace_running (int from_tty);
389 extern void disconnect_tracing (void);
390 extern void trace_reset_local_state (void);
392 extern void check_trace_running (struct trace_status *);
394 extern void start_tracing (const char *notes);
395 extern void stop_tracing (const char *notes);
397 extern void trace_status_mi (int on_stop);
399 extern void tvariables_info_1 (void);
400 extern void save_trace_state_variables (struct ui_file *fp);
402 /* Enumeration of the kinds of traceframe searches that a target may
403 be able to perform. */
405 enum trace_find_type
407 tfind_number,
408 tfind_pc,
409 tfind_tp,
410 tfind_range,
411 tfind_outside,
414 extern void tfind_1 (enum trace_find_type type, int num,
415 CORE_ADDR addr1, CORE_ADDR addr2,
416 int from_tty);
418 extern void trace_save_tfile (const char *filename,
419 int target_does_save);
420 extern void trace_save_ctf (const char *dirname,
421 int target_does_save);
423 extern traceframe_info_up parse_traceframe_info (const char *tframe_info);
425 extern int traceframe_available_memory (std::vector<mem_range> *result,
426 CORE_ADDR memaddr, ULONGEST len);
428 extern struct traceframe_info *get_traceframe_info (void);
430 extern struct bp_location *get_traceframe_location (int *stepping_frame_p);
432 /* Command element for the 'while-stepping' command. */
433 extern cmd_list_element *while_stepping_cmd_element;
435 #endif /* TRACEPOINT_H */