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