1 /* Branch trace support for GDB, the GNU debugger.
3 Copyright (C) 2013-2016 Free Software Foundation, Inc.
5 Contributed by Intel Corp. <markus.t.metzger@intel.com>.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #ifndef BTRACE_COMMON_H
23 #define BTRACE_COMMON_H
25 /* Branch tracing (btrace) is a per-thread control-flow execution trace of the
26 inferior. For presentation purposes, the branch trace is represented as a
27 list of sequential control-flow blocks, one such list per thread. */
31 /* A branch trace block.
33 This represents a block of sequential control-flow. Adjacent blocks will be
34 connected via calls, returns, or jumps. The latter can be direct or
35 indirect, conditional or unconditional. Branches can further be
36 asynchronous, e.g. interrupts. */
39 /* The address of the first byte of the first instruction in the block.
40 The address may be zero if we do not know the beginning of this block,
41 such as for the first block in a delta trace. */
44 /* The address of the first byte of the last instruction in the block. */
48 /* Define functions operating on a vector of branch trace blocks. */
49 typedef struct btrace_block btrace_block_s
;
50 DEF_VEC_O (btrace_block_s
);
52 /* Enumeration of btrace formats. */
56 /* No branch trace format. */
59 /* Branch trace is in Branch Trace Store (BTS) format.
60 Actually, the format is a sequence of blocks derived from BTS. */
63 /* Branch trace is in Intel Processor Trace format. */
67 /* An enumeration of cpu vendors. */
69 enum btrace_cpu_vendor
71 /* We do not know this vendor. */
78 /* A cpu identifier. */
82 /* The processor vendor. */
83 enum btrace_cpu_vendor vendor
;
86 unsigned short family
;
91 /* The cpu stepping. */
92 unsigned char stepping
;
95 /* A BTS configuration. */
97 struct btrace_config_bts
99 /* The size of the branch trace buffer in bytes.
101 This is unsigned int and not size_t since it is registered as
102 control variable for "set record btrace bts buffer-size". */
106 /* An Intel Processor Trace configuration. */
108 struct btrace_config_pt
110 /* The size of the branch trace buffer in bytes.
112 This is unsigned int and not size_t since it is registered as
113 control variable for "set record btrace pt buffer-size". */
117 /* A branch tracing configuration.
119 This describes the requested configuration as well as the actually
120 obtained configuration.
121 We describe the configuration for all different formats so we can
122 easily switch between formats. */
126 /* The branch tracing format. */
127 enum btrace_format format
;
129 /* The BTS format configuration. */
130 struct btrace_config_bts bts
;
132 /* The Intel Processor Trace format configuration. */
133 struct btrace_config_pt pt
;
136 /* Branch trace in BTS format. */
137 struct btrace_data_bts
139 /* Branch trace is represented as a vector of branch trace blocks starting
140 with the most recent block. */
141 VEC (btrace_block_s
) *blocks
;
144 /* Configuration information to go with the trace data. */
145 struct btrace_data_pt_config
147 /* The processor on which the trace has been collected. */
148 struct btrace_cpu cpu
;
151 /* Branch trace in Intel Processor Trace format. */
152 struct btrace_data_pt
154 /* Some configuration information to go with the data. */
155 struct btrace_data_pt_config config
;
157 /* The trace data. */
160 /* The size of DATA in bytes. */
164 /* The branch trace data. */
167 enum btrace_format format
;
171 /* Format == BTRACE_FORMAT_BTS. */
172 struct btrace_data_bts bts
;
174 /* Format == BTRACE_FORMAT_PT. */
175 struct btrace_data_pt pt
;
179 /* Target specific branch trace information. */
180 struct btrace_target_info
;
182 /* Enumeration of btrace read types. */
184 enum btrace_read_type
186 /* Send all available trace. */
189 /* Send all available trace, if it changed. */
192 /* Send the trace since the last request. This will fail if the trace
193 buffer overflowed. */
197 /* Enumeration of btrace errors. */
201 /* No error. Everything is OK. */
204 /* An unknown error. */
207 /* Branch tracing is not supported on this system. */
208 BTRACE_ERR_NOT_SUPPORTED
,
210 /* The branch trace buffer overflowed; no delta read possible. */
214 /* Return a string representation of FORMAT. */
215 extern const char *btrace_format_string (enum btrace_format format
);
217 /* Return an abbreviation string representation of FORMAT. */
218 extern const char *btrace_format_short_string (enum btrace_format format
);
220 /* Initialize DATA. */
221 extern void btrace_data_init (struct btrace_data
*data
);
224 extern void btrace_data_fini (struct btrace_data
*data
);
227 extern void btrace_data_clear (struct btrace_data
*data
);
229 /* Return non-zero if DATA is empty; zero otherwise. */
230 extern int btrace_data_empty (struct btrace_data
*data
);
232 /* Append the branch trace data from SRC to the end of DST.
233 Both SRC and DST must use the same format.
234 Returns zero on success; a negative number otherwise. */
235 extern int btrace_data_append (struct btrace_data
*dst
,
236 const struct btrace_data
*src
);
238 #endif /* BTRACE_COMMON_H */