Commit | Line | Data |
---|---|---|
02d27625 MM |
1 | /* Branch trace support for GDB, the GNU debugger. |
2 | ||
32d0add0 | 3 | Copyright (C) 2013-2015 Free Software Foundation, Inc. |
02d27625 MM |
4 | |
5 | Contributed by Intel Corp. <markus.t.metzger@intel.com>. | |
6 | ||
7 | This file is part of GDB. | |
8 | ||
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. | |
13 | ||
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. | |
18 | ||
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/>. */ | |
21 | ||
22 | #ifndef BTRACE_COMMON_H | |
23 | #define BTRACE_COMMON_H | |
24 | ||
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. */ | |
28 | ||
02d27625 MM |
29 | #include "vec.h" |
30 | ||
31 | /* A branch trace block. | |
32 | ||
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. */ | |
37 | struct btrace_block | |
38 | { | |
969c39fb MM |
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. */ | |
02d27625 MM |
42 | CORE_ADDR begin; |
43 | ||
44 | /* The address of the first byte of the last instruction in the block. */ | |
45 | CORE_ADDR end; | |
46 | }; | |
47 | ||
02d27625 | 48 | /* Define functions operating on a vector of branch trace blocks. */ |
734b0e4b | 49 | typedef struct btrace_block btrace_block_s; |
02d27625 MM |
50 | DEF_VEC_O (btrace_block_s); |
51 | ||
734b0e4b MM |
52 | /* Enumeration of btrace formats. */ |
53 | ||
54 | enum btrace_format | |
55 | { | |
56 | /* No branch trace format. */ | |
57 | BTRACE_FORMAT_NONE, | |
58 | ||
59 | /* Branch trace is in Branch Trace Store (BTS) format. | |
60 | Actually, the format is a sequence of blocks derived from BTS. */ | |
61 | BTRACE_FORMAT_BTS | |
62 | }; | |
63 | ||
64 | /* Branch trace in BTS format. */ | |
65 | struct btrace_data_bts | |
66 | { | |
67 | /* Branch trace is represented as a vector of branch trace blocks starting | |
68 | with the most recent block. */ | |
69 | VEC (btrace_block_s) *blocks; | |
70 | }; | |
71 | ||
72 | /* The branch trace data. */ | |
73 | struct btrace_data | |
74 | { | |
75 | enum btrace_format format; | |
76 | ||
77 | union | |
78 | { | |
79 | /* Format == BTRACE_FORMAT_BTS. */ | |
80 | struct btrace_data_bts bts; | |
81 | } variant; | |
82 | }; | |
83 | ||
02d27625 MM |
84 | /* Target specific branch trace information. */ |
85 | struct btrace_target_info; | |
86 | ||
87 | /* Enumeration of btrace read types. */ | |
88 | ||
89 | enum btrace_read_type | |
90 | { | |
91 | /* Send all available trace. */ | |
864089d2 | 92 | BTRACE_READ_ALL, |
02d27625 MM |
93 | |
94 | /* Send all available trace, if it changed. */ | |
969c39fb MM |
95 | BTRACE_READ_NEW, |
96 | ||
97 | /* Send the trace since the last request. This will fail if the trace | |
98 | buffer overflowed. */ | |
99 | BTRACE_READ_DELTA | |
100 | }; | |
101 | ||
102 | /* Enumeration of btrace errors. */ | |
103 | ||
104 | enum btrace_error | |
105 | { | |
106 | /* No error. Everything is OK. */ | |
107 | BTRACE_ERR_NONE, | |
108 | ||
109 | /* An unknown error. */ | |
110 | BTRACE_ERR_UNKNOWN, | |
111 | ||
112 | /* Branch tracing is not supported on this system. */ | |
113 | BTRACE_ERR_NOT_SUPPORTED, | |
114 | ||
115 | /* The branch trace buffer overflowed; no delta read possible. */ | |
116 | BTRACE_ERR_OVERFLOW | |
02d27625 MM |
117 | }; |
118 | ||
734b0e4b MM |
119 | /* Return a string representation of FORMAT. */ |
120 | extern const char *btrace_format_string (enum btrace_format format); | |
121 | ||
122 | /* Initialize DATA. */ | |
123 | extern void btrace_data_init (struct btrace_data *data); | |
124 | ||
125 | /* Cleanup DATA. */ | |
126 | extern void btrace_data_fini (struct btrace_data *data); | |
127 | ||
128 | /* Return non-zero if DATA is empty; zero otherwise. */ | |
129 | extern int btrace_data_empty (struct btrace_data *data); | |
130 | ||
02d27625 | 131 | #endif /* BTRACE_COMMON_H */ |