gdb/nat/linux-btrace.h

   1 /* Linux-dependent part of branch trace support for GDB, and GDBserver.
   2
   3    Copyright (C) 2013-2022 Free Software Foundation, Inc.
   4
   5    Contributed by Intel Corp. <[email protected]>
   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 #if HAVE_LINUX_PERF_EVENT_H
  27 #  include <linux/perf_event.h>
  28 #endif
  29
  30 struct target_ops;
  31
  32 #if HAVE_LINUX_PERF_EVENT_H
  33 /* A Linux perf event buffer.  */
  34 struct perf_event_buffer
  35 {
  36   /* The mapped memory.  */
  37   const uint8_t *mem;
  38
  39   /* The size of the mapped memory in bytes.  */
  40   size_t size;
  41
  42   /* A pointer to the data_head field for this buffer. */
  43   volatile __u64 *data_head;
  44
  45   /* The data_head value from the last read.  */
  46   __u64 last_head;
  47 };
  48
  49 /* Branch trace target information for BTS tracing.  */
  50 struct btrace_tinfo_bts
  51 {
  52   /* The Linux perf_event configuration for collecting the branch trace.  */
  53   struct perf_event_attr attr;
  54
  55   /* The perf event file.  */
  56   int file;
  57
  58   /* The perf event configuration page. */
  59   volatile struct perf_event_mmap_page *header;
  60
  61   /* The BTS perf event buffer.  */
  62   struct perf_event_buffer bts;
  63 };
  64
  65 /* Branch trace target information for Intel Processor Trace
  66    tracing.  */
  67 struct btrace_tinfo_pt
  68 {
  69   /* The Linux perf_event configuration for collecting the branch trace.  */
  70   struct perf_event_attr attr;
  71
  72   /* The perf event file.  */
  73   int file;
  74
  75   /* The perf event configuration page. */
  76   volatile struct perf_event_mmap_page *header;
  77
  78   /* The trace perf event buffer.  */
  79   struct perf_event_buffer pt;
  80 };
  81 #endif /* HAVE_LINUX_PERF_EVENT_H */
  82
  83 /* Branch trace target information per thread.  */
  84 struct btrace_target_info
  85 {
  86   /* The ptid of this thread.  */
  87   ptid_t ptid;
  88
  89   /* The obtained branch trace configuration.  */
  90   struct btrace_config conf;
  91
  92 #if HAVE_LINUX_PERF_EVENT_H
  93   /* The branch tracing format specific information.  */
  94   union
  95   {
  96     /* CONF.FORMAT == BTRACE_FORMAT_BTS.  */
  97     struct btrace_tinfo_bts bts;
  98
  99     /* CONF.FORMAT == BTRACE_FORMAT_PT.  */
 100     struct btrace_tinfo_pt pt;
 101   } variant;
 102 #endif /* HAVE_LINUX_PERF_EVENT_H */
 103 };
 104
 105 /* See to_enable_btrace in target.h.  */
 106 extern struct btrace_target_info *
 107   linux_enable_btrace (ptid_t ptid, const struct btrace_config *conf);
 108
 109 /* See to_disable_btrace in target.h.  */
 110 extern enum btrace_error linux_disable_btrace (struct btrace_target_info *ti);
 111
 112 /* See to_read_btrace in target.h.  */
 113 extern enum btrace_error linux_read_btrace (struct btrace_data *btrace,
 114                                             struct btrace_target_info *btinfo,
 115                                             enum btrace_read_type type);
 116
 117 /* See to_btrace_conf in target.h.  */
 118 extern const struct btrace_config *
 119   linux_btrace_conf (const struct btrace_target_info *);
 120
 121 #endif /* NAT_LINUX_BTRACE_H */