1 /* Data structures associated with tracepoints in GDB.
2 Copyright (C) 1997-2018 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"
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
49 struct trace_state_variable
51 /* The variable's name. The user has to prefix with a dollar sign,
52 but we don't store that internally. */
55 /* An id number assigned by GDB, and transmitted to targets. */
58 /* The initial value of a variable is a 64-bit signed integer. */
59 LONGEST initial_value;
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. */
66 /* The value of a variable is a 64-bit signed integer. */
69 /* This is true for variables that are predefined and built into
74 /* The trace status encompasses various info about the general state
75 of the tracing run. */
77 enum trace_stop_reason
79 trace_stop_reason_unknown,
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. */
94 /* This is true if the value of the running field is known. */
97 /* This is true when the trace experiment is actually running. */
100 enum trace_stop_reason stop_reason;
102 /* If stop_reason is tracepoint_passcount or tracepoint_error, this
103 is the (on-target) number of the tracepoint which caused the
105 int stopping_tracepoint;
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
113 /* Number of traceframes currently in the buffer. */
115 int traceframe_count;
117 /* Number of traceframes created since start of run. */
119 int traceframes_created;
121 /* Total size of the target's trace buffer. */
125 /* Unused bytes left in the target's trace buffer. */
129 /* 1 if the target will continue tracing after disconnection, else
130 0. If the target does not report a value, assume 0. */
132 int disconnected_tracing;
134 /* 1 if the target is using a circular trace buffer, else 0. If the
135 target does not report a value, assume 0. */
139 /* The "name" of the person running the trace. This is an
144 /* "Notes" about the trace. This is an arbitrary string not
145 interpreted by GDBserver in any special way. */
149 /* The calendar times at which the trace run started and stopped,
150 both expressed in microseconds of Unix time. */
156 struct trace_status *current_trace_status (void);
158 extern char *default_collect;
160 extern int trace_regblock_size;
162 extern const char *stop_reason_names[];
164 /* Struct to collect random info about tracepoints on the target. */
176 /* String that is the encoded form of the tracepoint's condition. */
179 /* Vectors of strings that are the encoded forms of a tracepoint's
181 VEC(char_ptr) *actions;
182 VEC(char_ptr) *step_actions;
184 /* The original string defining the location of the tracepoint. */
187 /* The original string defining the tracepoint's condition. */
190 /* List of original strings defining the tracepoint's actions. */
191 VEC(char_ptr) *cmd_strings;
193 /* The tracepoint's current hit count. */
196 /* The tracepoint's current traceframe usage. */
197 ULONGEST traceframe_usage;
199 struct uploaded_tp *next;
202 /* Struct recording info about trace state variables on the target. */
208 LONGEST initial_value;
210 struct uploaded_tsv *next;
213 /* Struct recording info about a target static tracepoint marker. */
215 struct static_tracepoint_marker
217 DISABLE_COPY_AND_ASSIGN (static_tracepoint_marker);
219 static_tracepoint_marker () = default;
220 static_tracepoint_marker (static_tracepoint_marker &&) = default;
221 static_tracepoint_marker &operator= (static_tracepoint_marker &&) = default;
223 struct gdbarch *gdbarch = NULL;
224 CORE_ADDR address = 0;
226 /* The string ID of the marker. */
229 /* Extra target reported info associated with the marker. */
235 memrange (int type_, bfd_signed_vma start_, bfd_signed_vma end_)
236 : type (type_), start (start_), end (end_)
242 /* memrange_absolute for absolute memory range, else basereg
245 bfd_signed_vma start;
249 class collection_list
254 void add_wholly_collected (const char *print_name);
256 void append_exp (struct expression *exp);
258 /* Add AEXPR to the list, taking ownership. */
259 void add_aexpr (agent_expr_up aexpr);
261 void add_register (unsigned int regno);
262 void add_memrange (struct gdbarch *gdbarch,
263 int type, bfd_signed_vma base,
265 void collect_symbol (struct symbol *sym,
266 struct gdbarch *gdbarch,
267 long frame_regno, long frame_offset,
271 void add_local_symbols (struct gdbarch *gdbarch, CORE_ADDR pc,
272 long frame_regno, long frame_offset, int type,
274 void add_static_trace_data ();
278 std::vector<std::string> stringify ();
280 const std::vector<std::string> &wholly_collected ()
281 { return m_wholly_collected; }
283 const std::vector<std::string> &computed ()
284 { return m_computed; }
287 /* room for up to 256 regs */
288 unsigned char m_regs_mask[32];
290 std::vector<memrange> m_memranges;
292 std::vector<agent_expr_up> m_aexprs;
294 /* True is the user requested a collection of "$_sdata", "static
298 /* A set of names of wholly collected objects. */
299 std::vector<std::string> m_wholly_collected;
300 /* A set of computed expressions. */
301 std::vector<std::string> m_computed;
305 parse_static_tracepoint_marker_definition (const char *line, const char **pp,
306 static_tracepoint_marker *marker);
308 /* A hook used to notify the UI of tracepoint operations. */
310 extern void (*deprecated_trace_find_hook) (char *arg, int from_tty);
311 extern void (*deprecated_trace_start_stop_hook) (int start, int from_tty);
313 /* Returns the current traceframe number. */
314 extern int get_traceframe_number (void);
316 /* Returns the tracepoint number for current traceframe. */
317 extern int get_tracepoint_number (void);
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,
322 extern void set_current_traceframe (int num);
324 struct cleanup *make_cleanup_restore_current_traceframe (void);
326 void free_actions (struct breakpoint *);
328 extern const char *decode_agent_options (const char *exp, int *trace_string);
330 extern void encode_actions (struct bp_location *tloc,
331 struct collection_list *tracepoint_list,
332 struct collection_list *stepping_list);
334 extern void encode_actions_rsp (struct bp_location *tloc,
335 std::vector<std::string> *tdp_actions,
336 std::vector<std::string> *stepping_actions);
338 extern void validate_actionline (const char *, struct breakpoint *);
339 extern void validate_trace_state_variable_name (const char *name);
341 extern struct trace_state_variable *find_trace_state_variable (const char *name);
342 extern struct trace_state_variable *
343 find_trace_state_variable_by_number (int number);
345 extern struct trace_state_variable *create_trace_state_variable (const char *name);
347 extern int encode_source_string (int num, ULONGEST addr,
348 const char *srctype, const char *src,
349 char *buf, int buf_size);
351 extern void parse_trace_status (const char *line, struct trace_status *ts);
353 extern void parse_tracepoint_status (const char *p, struct breakpoint *tp,
354 struct uploaded_tp *utp);
356 extern void parse_tracepoint_definition (const char *line,
357 struct uploaded_tp **utpp);
358 extern void parse_tsv_definition (const char *line, struct uploaded_tsv **utsvp);
360 extern struct uploaded_tp *get_uploaded_tp (int num, ULONGEST addr,
361 struct uploaded_tp **utpp);
362 extern void free_uploaded_tps (struct uploaded_tp **utpp);
364 extern struct uploaded_tsv *get_uploaded_tsv (int num,
365 struct uploaded_tsv **utsvp);
366 extern void free_uploaded_tsvs (struct uploaded_tsv **utsvp);
367 extern struct tracepoint *create_tracepoint_from_upload (struct uploaded_tp *utp);
368 extern void merge_uploaded_tracepoints (struct uploaded_tp **utpp);
369 extern void merge_uploaded_trace_state_variables (struct uploaded_tsv **utsvp);
371 extern void query_if_trace_running (int from_tty);
372 extern void disconnect_tracing (void);
373 extern void trace_reset_local_state (void);
375 extern void check_trace_running (struct trace_status *);
377 extern void start_tracing (const char *notes);
378 extern void stop_tracing (const char *notes);
380 extern void trace_status_mi (int on_stop);
382 extern void tvariables_info_1 (void);
383 extern void save_trace_state_variables (struct ui_file *fp);
385 /* Enumeration of the kinds of traceframe searches that a target may
386 be able to perform. */
397 extern void tfind_1 (enum trace_find_type type, int num,
398 CORE_ADDR addr1, CORE_ADDR addr2,
401 extern void trace_save_tfile (const char *filename,
402 int target_does_save);
403 extern void trace_save_ctf (const char *dirname,
404 int target_does_save);
406 extern traceframe_info_up parse_traceframe_info (const char *tframe_info);
408 extern int traceframe_available_memory (std::vector<mem_range> *result,
409 CORE_ADDR memaddr, ULONGEST len);
411 extern struct traceframe_info *get_traceframe_info (void);
413 extern struct bp_location *get_traceframe_location (int *stepping_frame_p);
415 #endif /* TRACEPOINT_H */