src/cpu/exetrace.hh

   1 /*
   2  * Copyright (c) 2001-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Steve Reinhardt
  29  *          Nathan Binkert
  30  */
  31
  32 #ifndef __CPU_EXETRACE_HH__
  33 #define __CPU_EXETRACE_HH__
  34
  35 #include "base/trace.hh"
  36 #include "base/types.hh"
  37 #include "cpu/static_inst.hh"
  38 #include "cpu/thread_context.hh"
  39 #include "debug/ExecEnable.hh"
  40 #include "debug/ExecSpeculative.hh"
  41 #include "params/ExeTracer.hh"
  42 #include "sim/insttracer.hh"
  43
  44 class ThreadContext;
  45
  46 namespace Trace {
  47
  48 class ExeTracerRecord : public InstRecord
  49 {
  50   public:
  51     ExeTracerRecord(Tick _when, ThreadContext *_thread,
  52                const StaticInstPtr _staticInst, TheISA::PCState _pc,
  53                bool spec, const StaticInstPtr _macroStaticInst = NULL)
  54         : InstRecord(_when, _thread, _staticInst, _pc, spec,
  55                 _macroStaticInst)
  56     {
  57     }
  58
  59     void traceInst(const StaticInstPtr &inst, bool ran);
  60
  61     void dump();
  62     virtual void dumpTicks(std::ostream &outs);
  63 };
  64
  65 class ExeTracer : public InstTracer
  66 {
  67   public:
  68     typedef ExeTracerParams Params;
  69     ExeTracer(const Params *params) : InstTracer(params)
  70     {}
  71
  72     InstRecord *
  73     getInstRecord(Tick when, ThreadContext *tc,
  74             const StaticInstPtr staticInst, TheISA::PCState pc,
  75             const StaticInstPtr macroStaticInst = NULL)
  76     {
  77         if (!Debug::ExecEnable)
  78             return NULL;
  79
  80         if (!Trace::enabled)
  81             return NULL;
  82
  83         if (!Debug::ExecSpeculative && tc->misspeculating())
  84             return NULL;
  85
  86         return new ExeTracerRecord(when, tc,
  87                 staticInst, pc, tc->misspeculating(), macroStaticInst);
  88     }
  89 };
  90
  91 } // namespace Trace
  92
  93 #endif // __CPU_EXETRACE_HH__