Imported Upstream version 7.8.1
[platform/upstream/gdb.git] / gdb / nat / linux-btrace.h
1 /* Linux-dependent part of branch trace support for GDB, and GDBserver.
2
3    Copyright (C) 2013-2015 Free Software Foundation, Inc.
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 LINUX_BTRACE_H
23 #define LINUX_BTRACE_H
24
25 #include "btrace-common.h"
26 #include "vec.h"
27 #include <stdint.h>
28
29 #if HAVE_LINUX_PERF_EVENT_H
30 #  include <linux/perf_event.h>
31 #endif
32
33 struct target_ops;
34
35 /* Branch trace target information per thread.  */
36 struct btrace_target_info
37 {
38 #if HAVE_LINUX_PERF_EVENT_H
39   /* The Linux perf_event configuration for collecting the branch trace.  */
40   struct perf_event_attr attr;
41
42   /* The ptid of this thread.  */
43   ptid_t ptid;
44
45   /* The mmap configuration mapping the branch trace perf_event buffer.
46
47      file      .. the file descriptor
48      buffer    .. the mmapped memory buffer
49      size      .. the buffer's size in pages without the configuration page
50      data_head .. the data head from the last read  */
51   int file;
52   void *buffer;
53   size_t size;
54   unsigned long data_head;
55 #endif /* HAVE_LINUX_PERF_EVENT_H */
56
57   /* The size of a pointer in bits for this thread.
58      The information is used to identify kernel addresses in order to skip
59      records from/to kernel space.  */
60   int ptr_bits;
61 };
62
63 /* See to_supports_btrace in target.h.  */
64 extern int linux_supports_btrace (struct target_ops *);
65
66 /* See to_enable_btrace in target.h.  */
67 extern struct btrace_target_info *linux_enable_btrace (ptid_t ptid);
68
69 /* See to_disable_btrace in target.h.  */
70 extern enum btrace_error linux_disable_btrace (struct btrace_target_info *ti);
71
72 /* See to_read_btrace in target.h.  */
73 extern enum btrace_error linux_read_btrace (VEC (btrace_block_s) **btrace,
74                                             struct btrace_target_info *btinfo,
75                                             enum btrace_read_type type);
76
77 #endif /* LINUX_BTRACE_H */