sim/common/sim-trace.h

   1 /* Simulator tracing/debugging support.
   2    Copyright (C) 1997 Free Software Foundation, Inc.
   3    Contributed by Cygnus Support.
   4
   5 This file is part of GDB, the GNU debugger.
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License along
  18 with this program; if not, write to the Free Software Foundation, Inc.,
  19 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  20
  21 /* This file is meant to be included by sim-basics.h.  */
  22
  23 #ifndef SIM_TRACE_H
  24 #define SIM_TRACE_H
  25
  26 #ifndef __attribute__
  27 #if !defined(__GNUC__) || (__GNUC__ < 2) || (__GNUC__ == 2 && __GNU_MINOR__ < 7)
  28 #define __attribute__(attr)
  29 #endif
  30 #endif
  31
  32 /* Maximum number of traceable entities.  */
  33 #ifndef MAX_TRACE_VALUES
  34 #define MAX_TRACE_VALUES 12
  35 #endif
  36
  37 /* Standard traceable entities.  */
  38 #define TRACE_INSN_IDX 0
  39 #define TRACE_DECODE_IDX 1
  40 #define TRACE_EXTRACT_IDX 2
  41 #define TRACE_LINENUM_IDX 3
  42 #define TRACE_MEMORY_IDX 4
  43 #define TRACE_MODEL_IDX 5
  44 #define TRACE_ALU_IDX 6
  45 #define TRACE_CORE_IDX 7
  46 #define TRACE_EVENTS_IDX 8
  47 #define TRACE_FPU_IDX 9
  48 #define TRACE_NEXT_IDX 16 /* simulator specific trace bits begin here */
  49
  50 /* Masks so WITH_TRACE can have symbolic values.  */
  51 #define TRACE_insn 1
  52 #define TRACE_decode 2
  53 #define TRACE_extract 4
  54 #define TRACE_linenum 8
  55 #define TRACE_memory 16
  56 #define TRACE_model 32
  57 #define TRACE_alu 64
  58 #define TRACE_core 128
  59 #define TRACE_events 256
  60 #define TRACE_fpu 512
  61
  62 /* Preprocessor macros to simplify tests of WITH_TRACE.  */
  63 #define WITH_TRACE_INSN_P (WITH_TRACE & TRACE_insn)
  64 #define WITH_TRACE_DECODE_P (WITH_TRACE & TRACE_decode)
  65 #define WITH_TRACE_EXTRACT_P (WITH_TRACE & TRACE_extract)
  66 #define WITH_TRACE_LINENUM_P (WITH_TRACE & TRACE_linenum)
  67 #define WITH_TRACE_MEMORY_P (WITH_TRACE & TRACE_memory)
  68 #define WITH_TRACE_MODEL_P (WITH_TRACE & TRACE_model)
  69 #define WITH_TRACE_ALU_P (WITH_TRACE & TRACE_alu)
  70 #define WITH_TRACE_CORE_P (WITH_TRACE & TRACE_core)
  71 #define WITH_TRACE_EVENTS_P (WITH_TRACE & TRACE_events)
  72 #define WITH_TRACE_FPU_P (WITH_TRACE & TRACE_fpu)
  73
  74 /* Tracing install handler.  */
  75 MODULE_INSTALL_FN trace_install;
  76 \f
  77 /* Struct containing all trace data.  */
  78
  79 typedef struct {
  80   /* Boolean array of specified tracing flags.  */
  81   /* ??? It's not clear that using an array vs a bit mask is faster.
  82      Consider the case where one wants to test whether any of several bits
  83      are set.  */
  84   char trace_flags[MAX_TRACE_VALUES];
  85 #define TRACE_FLAGS(t) ((t)->trace_flags)
  86
  87   /* Tracing output goes to this or stderr if NULL.
  88      We can't store `stderr' here as stderr goes through a callback.  */
  89   FILE *trace_file;
  90 #define TRACE_FILE(t) ((t)->trace_file)
  91 } TRACE_DATA;
  92 \f
  93 /* Usage macros.  */
  94
  95 #define CPU_TRACE_FLAGS(cpu) TRACE_FLAGS (CPU_TRACE_DATA (cpu))
  96
  97 /* forward reference */
  98 struct _sim_cpu;
  99
 100 /* Tracing support.  */
 101
 102 /* Return non-zero if tracing of IDX is enabled for CPU.  */
 103 #define TRACE_P(cpu,idx) \
 104 ((WITH_TRACE & (1 << (idx))) != 0 \
 105  && CPU_TRACE_FLAGS (cpu)[idx] != 0)
 106
 107 /* Non-zero if "--trace-insn" specified for CPU.  */
 108 #define TRACE_INSN_P(cpu) TRACE_P (cpu, TRACE_INSN_IDX)
 109 /* Non-zero if "--trace-linenum" specified for CPU.  */
 110 #define TRACE_LINENUM_P(cpu) TRACE_P (cpu, TRACE_LINENUM_IDX)
 111 /* Non-zero if "--trace-decode" specified for CPU.  */
 112 #define TRACE_DECODE_P(cpu) TRACE_P (cpu, TRACE_DECODE_IDX)
 113 /* Non-zero if "--trace-fpu" specified for CPU. */
 114 #define TRACE_FPU_P(cpu) TRACE_P (cpu, TRACE_FPU_IDX)
 115
 116 extern void trace_one_insn PARAMS ((SIM_DESC, sim_cpu *, const char *,
 117                                     int, int, address_word,
 118                                     const char *name));
 119
 120 extern void trace_printf PARAMS ((SIM_DESC, sim_cpu *, const char *, ...))
 121      __attribute__((format (printf, 3, 4)));
 122
 123 /* Debug support.
 124    This is included here because there isn't enough of it to justify
 125    a sim-debug.h.  */
 126
 127 /* Return non-zero if debugging of IDX for CPU is enabled.  */
 128 #define DEBUG_P(cpu, idx) \
 129 ((WITH_DEBUG & (1 << (idx))) != 0 \
 130  && CPU_DEBUG_FLAGS (cpu)[idx] != 0)
 131
 132 /* Non-zero if "--debug-insn" specified.  */
 133 #define DEBUG_INSN_P(cpu) DEBUG_P (cpu, DEBUG_INSN_IDX)
 134
 135 extern void debug_printf PARAMS ((struct _sim_cpu *, const char *, ...))
 136      __attribute__((format (printf, 2, 3)));
 137
 138 #endif /* SIM_TRACE_H */