src/sim/faults.hh

   1 /*
   2  * Copyright (c) 2003-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: Nathan Binkert
  29  *          Gabe Black
  30  */
  31
  32 #ifndef __FAULTS_HH__
  33 #define __FAULTS_HH__
  34
  35 #include "base/refcnt.hh"
  36 #include "base/types.hh"
  37 #include "sim/fault.hh"
  38 #include "sim/stats.hh"
  39 #include "config/full_system.hh"
  40 #include "cpu/static_inst.hh"
  41
  42 class ThreadContext;
  43
  44 typedef const char * FaultName;
  45 typedef Stats::Scalar FaultStat;
  46
  47 // Each class has it's name statically define in _name,
  48 // and has a virtual function to access it's name.
  49 // The function is necessary because otherwise, all objects
  50 // which are being accessed cast as a FaultBase * (namely
  51 // all faults returned using the Fault type) will use the
  52 // generic FaultBase name.
  53
  54 class FaultBase : public RefCounted
  55 {
  56   public:
  57     virtual FaultName name() const = 0;
  58     virtual void invoke(ThreadContext * tc,
  59             StaticInstPtr inst = StaticInst::nullStaticInstPtr);
  60     virtual bool isMachineCheckFault() const {return false;}
  61     virtual bool isAlignmentFault() const {return false;}
  62 };
  63
  64 FaultBase * const NoFault = 0;
  65
  66 class UnimpFault : public FaultBase
  67 {
  68   private:
  69     std::string panicStr;
  70   public:
  71     UnimpFault(std::string _str)
  72         : panicStr(_str)
  73     { }
  74
  75     FaultName name() const {return "Unimplemented simulator feature";}
  76     void invoke(ThreadContext * tc,
  77             StaticInstPtr inst = StaticInst::nullStaticInstPtr);
  78 };
  79
  80 #if !FULL_SYSTEM
  81 class GenericPageTableFault : public FaultBase
  82 {
  83   private:
  84     Addr vaddr;
  85   public:
  86     FaultName name() const {return "Generic page table fault";}
  87     GenericPageTableFault(Addr va) : vaddr(va) {}
  88     void invoke(ThreadContext * tc,
  89             StaticInstPtr inst = StaticInst::nullStaticInstPtr);
  90 };
  91
  92 class GenericAlignmentFault : public FaultBase
  93 {
  94   private:
  95     Addr vaddr;
  96   public:
  97     FaultName name() const {return "Generic alignment fault";}
  98     GenericAlignmentFault(Addr va) : vaddr(va) {}
  99     void invoke(ThreadContext * tc,
 100             StaticInstPtr inst = StaticInst::nullStaticInstPtr);
 101 };
 102 #endif
 103
 104 #endif // __FAULTS_HH__