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 | ||
48 | /* Branch trace is represented as a vector of branch trace blocks starting with | |
49 | the most recent block. */ | |
50 | typedef struct btrace_block btrace_block_s; | |
51 | ||
52 | /* Define functions operating on a vector of branch trace blocks. */ | |
53 | DEF_VEC_O (btrace_block_s); | |
54 | ||
55 | /* Target specific branch trace information. */ | |
56 | struct btrace_target_info; | |
57 | ||
58 | /* Enumeration of btrace read types. */ | |
59 | ||
60 | enum btrace_read_type | |
61 | { | |
62 | /* Send all available trace. */ | |
864089d2 | 63 | BTRACE_READ_ALL, |
02d27625 MM |
64 | |
65 | /* Send all available trace, if it changed. */ | |
969c39fb MM |
66 | BTRACE_READ_NEW, |
67 | ||
68 | /* Send the trace since the last request. This will fail if the trace | |
69 | buffer overflowed. */ | |
70 | BTRACE_READ_DELTA | |
71 | }; | |
72 | ||
73 | /* Enumeration of btrace errors. */ | |
74 | ||
75 | enum btrace_error | |
76 | { | |
77 | /* No error. Everything is OK. */ | |
78 | BTRACE_ERR_NONE, | |
79 | ||
80 | /* An unknown error. */ | |
81 | BTRACE_ERR_UNKNOWN, | |
82 | ||
83 | /* Branch tracing is not supported on this system. */ | |
84 | BTRACE_ERR_NOT_SUPPORTED, | |
85 | ||
86 | /* The branch trace buffer overflowed; no delta read possible. */ | |
87 | BTRACE_ERR_OVERFLOW | |
02d27625 MM |
88 | }; |
89 | ||
90 | #endif /* BTRACE_COMMON_H */ |