1 /* Branch trace support for GDB, the GNU debugger.
3 Copyright (C) 2013-2015 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. */
64 /* An enumeration of cpu vendors. */
66 enum btrace_cpu_vendor
68 /* We do not know this vendor. */
75 /* A cpu identifier. */
79 /* The processor vendor. */
80 enum btrace_cpu_vendor vendor
;
83 unsigned short family
;
88 /* The cpu stepping. */
89 unsigned char stepping
;
92 /* A BTS configuration. */
94 struct btrace_config_bts
96 /* The size of the branch trace buffer in bytes. */
100 /* A branch tracing configuration.
102 This describes the requested configuration as well as the actually
103 obtained configuration.
104 We describe the configuration for all different formats so we can
105 easily switch between formats. */
109 /* The branch tracing format. */
110 enum btrace_format format
;
112 /* The BTS format configuration. */
113 struct btrace_config_bts bts
;
116 /* Branch trace in BTS format. */
117 struct btrace_data_bts
119 /* Branch trace is represented as a vector of branch trace blocks starting
120 with the most recent block. */
121 VEC (btrace_block_s
) *blocks
;
124 /* The branch trace data. */
127 enum btrace_format format
;
131 /* Format == BTRACE_FORMAT_BTS. */
132 struct btrace_data_bts bts
;
136 /* Target specific branch trace information. */
137 struct btrace_target_info
;
139 /* Enumeration of btrace read types. */
141 enum btrace_read_type
143 /* Send all available trace. */
146 /* Send all available trace, if it changed. */
149 /* Send the trace since the last request. This will fail if the trace
150 buffer overflowed. */
154 /* Enumeration of btrace errors. */
158 /* No error. Everything is OK. */
161 /* An unknown error. */
164 /* Branch tracing is not supported on this system. */
165 BTRACE_ERR_NOT_SUPPORTED
,
167 /* The branch trace buffer overflowed; no delta read possible. */
171 /* Return a string representation of FORMAT. */
172 extern const char *btrace_format_string (enum btrace_format format
);
174 /* Initialize DATA. */
175 extern void btrace_data_init (struct btrace_data
*data
);
178 extern void btrace_data_fini (struct btrace_data
*data
);
180 /* Return non-zero if DATA is empty; zero otherwise. */
181 extern int btrace_data_empty (struct btrace_data
*data
);
183 #endif /* BTRACE_COMMON_H */