gdb/nat/linux-btrace.h

   1 /* Linux-dependent part of branch trace support for GDB, and GDBserver.
   2
   3    Copyright (C) 2013-2024 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 NAT_LINUX_BTRACE_H
  23 #define NAT_LINUX_BTRACE_H
  24
  25 #include "gdbsupport/btrace-common.h"
  26 #include "gdbsupport/gdb-checked-static-cast.h"
  27 #if HAVE_LINUX_PERF_EVENT_H
  28 #  include <linux/perf_event.h>
  29 #endif
  30
  31 struct target_ops;
  32
  33 #if HAVE_LINUX_PERF_EVENT_H
  34 /* A Linux perf event buffer.  */
  35 struct perf_event_buffer
  36 {
  37   /* The mapped memory.  */
  38   const uint8_t *mem;
  39
  40   /* The size of the mapped memory in bytes.  */
  41   size_t size;
  42
  43   /* A pointer to the data_head field for this buffer. */
  44   volatile __u64 *data_head;
  45
  46   /* The data_head value from the last read.  */
  47   __u64 last_head;
  48 };
  49 #endif /* HAVE_LINUX_PERF_EVENT_H */
  50
  51 /* Branch trace target information per thread.  */
  52 struct linux_btrace_target_info final : public btrace_target_info
  53 {
  54   linux_btrace_target_info (ptid_t ptid)
  55     : btrace_target_info (ptid)
  56     {}
  57
  58 #if HAVE_LINUX_PERF_EVENT_H
  59   /* The Linux perf_event configuration for collecting the branch trace.  */
  60   struct perf_event_attr attr {};
  61
  62   /* The perf event file.  */
  63   int file = -1;
  64
  65   /* The perf event configuration page.  */
  66   volatile struct perf_event_mmap_page *header = nullptr;
  67
  68   /* The perf event buffer containing the trace data.  */
  69   struct perf_event_buffer pev {};
  70 #endif /* HAVE_LINUX_PERF_EVENT_H */
  71 };
  72
  73 /* See to_enable_btrace in target.h.  */
  74 extern struct btrace_target_info *
  75   linux_enable_btrace (ptid_t ptid, const struct btrace_config *conf);
  76
  77 /* See to_disable_btrace in target.h.  */
  78 extern enum btrace_error linux_disable_btrace (struct btrace_target_info *ti);
  79
  80 /* See to_read_btrace in target.h.  */
  81 extern enum btrace_error linux_read_btrace (struct btrace_data *btrace,
  82                                             struct btrace_target_info *btinfo,
  83                                             enum btrace_read_type type);
  84
  85 /* See to_btrace_conf in target.h.  */
  86 extern const struct btrace_config *
  87   linux_btrace_conf (const struct btrace_target_info *);
  88
  89 #endif /* NAT_LINUX_BTRACE_H */