gdb/common/btrace-common.h

   1 /* Branch trace support for GDB, the GNU debugger.
   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 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
  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 {
  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.  */
  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 /* Define functions operating on a vector of branch trace blocks.  */
  49 typedef struct btrace_block btrace_block_s;
  50 DEF_VEC_O (btrace_block_s);
  51
  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 /* A branch tracing configuration.
  65
  66    This describes the requested configuration as well as the actually
  67    obtained configuration.  */
  68
  69 struct btrace_config
  70 {
  71   /* The branch tracing format.  */
  72   enum btrace_format format;
  73 };
  74
  75 /* Branch trace in BTS format.  */
  76 struct btrace_data_bts
  77 {
  78   /* Branch trace is represented as a vector of branch trace blocks starting
  79      with the most recent block.  */
  80   VEC (btrace_block_s) *blocks;
  81 };
  82
  83 /* The branch trace data.  */
  84 struct btrace_data
  85 {
  86   enum btrace_format format;
  87
  88   union
  89   {
  90     /* Format == BTRACE_FORMAT_BTS.  */
  91     struct btrace_data_bts bts;
  92   } variant;
  93 };
  94
  95 /* Target specific branch trace information.  */
  96 struct btrace_target_info;
  97
  98 /* Enumeration of btrace read types.  */
  99
 100 enum btrace_read_type
 101 {
 102   /* Send all available trace.  */
 103   BTRACE_READ_ALL,
 104
 105   /* Send all available trace, if it changed.  */
 106   BTRACE_READ_NEW,
 107
 108   /* Send the trace since the last request.  This will fail if the trace
 109      buffer overflowed.  */
 110   BTRACE_READ_DELTA
 111 };
 112
 113 /* Enumeration of btrace errors.  */
 114
 115 enum btrace_error
 116 {
 117   /* No error.  Everything is OK.  */
 118   BTRACE_ERR_NONE,
 119
 120   /* An unknown error.  */
 121   BTRACE_ERR_UNKNOWN,
 122
 123   /* Branch tracing is not supported on this system.  */
 124   BTRACE_ERR_NOT_SUPPORTED,
 125
 126   /* The branch trace buffer overflowed; no delta read possible.  */
 127   BTRACE_ERR_OVERFLOW
 128 };
 129
 130 /* Return a string representation of FORMAT.  */
 131 extern const char *btrace_format_string (enum btrace_format format);
 132
 133 /* Initialize DATA.  */
 134 extern void btrace_data_init (struct btrace_data *data);
 135
 136 /* Cleanup DATA.  */
 137 extern void btrace_data_fini (struct btrace_data *data);
 138
 139 /* Return non-zero if DATA is empty; zero otherwise.  */
 140 extern int btrace_data_empty (struct btrace_data *data);
 141
 142 #endif /* BTRACE_COMMON_H */