1 /* Data structures associated with tracepoints in GDB.
2 Copyright (C) 1997-2014 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"
27 /* An object describing the contents of a traceframe. */
29 struct traceframe_info
31 /* Collected memory. */
32 VEC(mem_range_s
) *memory
;
34 /* Collected trace state variables. */
38 /* A trace state variable is a value managed by a target being
39 traced. A trace state variable (or tsv for short) can be accessed
40 and assigned to by tracepoint actions and conditionals, but is not
41 part of the program being traced, and it doesn't have to be
42 collected. Effectively the variables are scratch space for
45 struct trace_state_variable
47 /* The variable's name. The user has to prefix with a dollar sign,
48 but we don't store that internally. */
51 /* An id number assigned by GDB, and transmitted to targets. */
54 /* The initial value of a variable is a 64-bit signed integer. */
55 LONGEST initial_value
;
57 /* 1 if the value is known, else 0. The value is known during a
58 trace run, or in tfind mode if the variable was collected into
59 the current trace frame. */
62 /* The value of a variable is a 64-bit signed integer. */
65 /* This is true for variables that are predefined and built into
70 /* The trace status encompasses various info about the general state
71 of the tracing run. */
73 enum trace_stop_reason
75 trace_stop_reason_unknown
,
86 /* If the status is coming from a file rather than a live target,
87 this points at the file's filename. Otherwise, this is NULL. */
90 /* This is true if the value of the running field is known. */
93 /* This is true when the trace experiment is actually running. */
96 enum trace_stop_reason stop_reason
;
98 /* If stop_reason is tracepoint_passcount or tracepoint_error, this
99 is the (on-target) number of the tracepoint which caused the
101 int stopping_tracepoint
;
103 /* If stop_reason is tstop_command or tracepoint_error, this is an
104 arbitrary string that may describe the reason for the stop in
109 /* Number of traceframes currently in the buffer. */
111 int traceframe_count
;
113 /* Number of traceframes created since start of run. */
115 int traceframes_created
;
117 /* Total size of the target's trace buffer. */
121 /* Unused bytes left in the target's trace buffer. */
125 /* 1 if the target will continue tracing after disconnection, else
126 0. If the target does not report a value, assume 0. */
128 int disconnected_tracing
;
130 /* 1 if the target is using a circular trace buffer, else 0. If the
131 target does not report a value, assume 0. */
135 /* The "name" of the person running the trace. This is an
140 /* "Notes" about the trace. This is an arbitrary string not
141 interpreted by GDBserver in any special way. */
145 /* The calendar times at which the trace run started and stopped,
146 both expressed in microseconds of Unix time. */
152 struct trace_status
*current_trace_status (void);
154 extern char *default_collect
;
156 extern int trace_regblock_size
;
158 extern const char *stop_reason_names
[];
160 /* Struct to collect random info about tracepoints on the target. */
172 /* String that is the encoded form of the tracepoint's condition. */
175 /* Vectors of strings that are the encoded forms of a tracepoint's
177 VEC(char_ptr
) *actions
;
178 VEC(char_ptr
) *step_actions
;
180 /* The original string defining the location of the tracepoint. */
183 /* The original string defining the tracepoint's condition. */
186 /* List of original strings defining the tracepoint's actions. */
187 VEC(char_ptr
) *cmd_strings
;
189 /* The tracepoint's current hit count. */
192 /* The tracepoint's current traceframe usage. */
193 ULONGEST traceframe_usage
;
195 struct uploaded_tp
*next
;
198 /* Struct recording info about trace state variables on the target. */
204 LONGEST initial_value
;
206 struct uploaded_tsv
*next
;
209 /* Struct recording info about a target static tracepoint marker. */
211 struct static_tracepoint_marker
213 struct gdbarch
*gdbarch
;
216 /* The string ID of the marker. */
219 /* Extra target reported info associated with the marker. */
225 /* memrange_absolute for absolute memory range, else basereg
228 bfd_signed_vma start
;
232 struct collection_list
234 /* room for up to 256 regs */
235 unsigned char regs_mask
[32];
238 struct memrange
*list
;
240 /* size of array pointed to by expr_list elt. */
243 struct agent_expr
**aexpr_list
;
245 /* True is the user requested a collection of "$_sdata", "static
249 /* A set of names of wholly collected objects. */
250 VEC(char_ptr
) *wholly_collected
;
251 /* A set of computed expressions. */
252 VEC(char_ptr
) *computed
;
255 extern void parse_static_tracepoint_marker_definition
256 (char *line
, char **pp
,
257 struct static_tracepoint_marker
*marker
);
258 extern void release_static_tracepoint_marker (struct static_tracepoint_marker
*);
259 extern void free_current_marker (void *arg
);
261 /* A hook used to notify the UI of tracepoint operations. */
263 extern void (*deprecated_trace_find_hook
) (char *arg
, int from_tty
);
264 extern void (*deprecated_trace_start_stop_hook
) (int start
, int from_tty
);
266 /* Returns the current traceframe number. */
267 extern int get_traceframe_number (void);
269 /* Returns the tracepoint number for current traceframe. */
270 extern int get_tracepoint_number (void);
272 /* Make the traceframe NUM be the current GDB trace frame number, and
273 do nothing more. In particular, this does not flush the
274 register/frame caches or notify the target about the trace frame
275 change, so that is can be used when we need to momentarily access
276 live memory. Targets lazily switch their current traceframe to
277 match GDB's traceframe number, at the appropriate times. */
278 extern void set_traceframe_number (int);
280 /* Make the traceframe NUM be the current trace frame, all the way to
281 the target, and flushes all global state (register/frame caches,
283 extern void set_current_traceframe (int num
);
285 struct cleanup
*make_cleanup_restore_current_traceframe (void);
286 struct cleanup
*make_cleanup_restore_traceframe_number (void);
288 void free_actions (struct breakpoint
*);
290 extern const char *decode_agent_options (const char *exp
, int *trace_string
);
292 extern struct cleanup
*
293 encode_actions_and_make_cleanup (struct bp_location
*tloc
,
294 struct collection_list
*tracepoint_list
,
295 struct collection_list
*stepping_list
);
297 extern void encode_actions_rsp (struct bp_location
*tloc
,
298 char ***tdp_actions
, char ***stepping_actions
);
300 extern void validate_actionline (const char *, struct breakpoint
*);
301 extern void validate_trace_state_variable_name (const char *name
);
303 extern struct trace_state_variable
*find_trace_state_variable (const char *name
);
304 extern struct trace_state_variable
*
305 find_trace_state_variable_by_number (int number
);
307 extern struct trace_state_variable
*create_trace_state_variable (const char *name
);
309 extern int encode_source_string (int num
, ULONGEST addr
,
310 char *srctype
, char *src
,
311 char *buf
, int buf_size
);
313 extern void parse_trace_status (char *line
, struct trace_status
*ts
);
315 extern void parse_tracepoint_status (char *p
, struct breakpoint
*tp
,
316 struct uploaded_tp
*utp
);
318 extern void parse_tracepoint_definition (char *line
,
319 struct uploaded_tp
**utpp
);
320 extern void parse_tsv_definition (char *line
, struct uploaded_tsv
**utsvp
);
322 extern struct uploaded_tp
*get_uploaded_tp (int num
, ULONGEST addr
,
323 struct uploaded_tp
**utpp
);
324 extern void free_uploaded_tps (struct uploaded_tp
**utpp
);
326 extern struct uploaded_tsv
*get_uploaded_tsv (int num
,
327 struct uploaded_tsv
**utsvp
);
328 extern void free_uploaded_tsvs (struct uploaded_tsv
**utsvp
);
329 extern struct tracepoint
*create_tracepoint_from_upload (struct uploaded_tp
*utp
);
330 extern void merge_uploaded_tracepoints (struct uploaded_tp
**utpp
);
331 extern void merge_uploaded_trace_state_variables (struct uploaded_tsv
**utsvp
);
333 extern void query_if_trace_running (int from_tty
);
334 extern void disconnect_tracing (void);
335 extern void trace_reset_local_state (void);
337 extern void start_tracing (char *notes
);
338 extern void stop_tracing (char *notes
);
340 extern void trace_status_mi (int on_stop
);
342 extern void tvariables_info_1 (void);
343 extern void save_trace_state_variables (struct ui_file
*fp
);
345 extern void tfind_1 (enum trace_find_type type
, int num
,
346 CORE_ADDR addr1
, CORE_ADDR addr2
,
349 extern void trace_save_tfile (const char *filename
,
350 int target_does_save
);
351 extern void trace_save_ctf (const char *dirname
,
352 int target_does_save
);
354 extern struct traceframe_info
*parse_traceframe_info (const char *tframe_info
);
356 extern int traceframe_available_memory (VEC(mem_range_s
) **result
,
357 CORE_ADDR memaddr
, ULONGEST len
);
359 extern struct traceframe_info
*get_traceframe_info (void);
361 extern struct bp_location
*get_traceframe_location (int *stepping_frame_p
);
363 #endif /* TRACEPOINT_H */