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 class FaultBase
  45 {
  46   public:
  47     virtual FaultName name() const = 0;
  48     virtual void invoke(ThreadContext * tc, const StaticInstPtr &inst =
  49                         StaticInst::nullStaticInstPtr);
  50
  51     virtual ~FaultBase() {};
  52 };
  53
  54 class UnimpFault : public FaultBase
  55 {
  56   private:
  57     std::string panicStr;
  58   public:
  59     UnimpFault(std::string _str)
  60         : panicStr(_str)
  61     { }
  62
  63     FaultName name() const { return "Unimplemented simulator feature"; }
  64     void invoke(ThreadContext * tc, const StaticInstPtr &inst =
  65                 StaticInst::nullStaticInstPtr);
  66 };
  67
  68 class ReExec : public FaultBase
  69 {
  70   public:
  71     virtual FaultName name() const { return "Re-execution fault"; }
  72     ReExec() {}
  73     void invoke(ThreadContext *tc, const StaticInstPtr &inst =
  74                 StaticInst::nullStaticInstPtr);
  75 };
  76
  77 /*
  78  * This class is needed to allow system call retries to occur for blocking
  79  * system calls in SE mode. A retry fault will be generated by the system call
  80  * emulation code if blocking conditions arise; the fault is passed up the
  81  * function call chain into the CPU model where it is handled by retrying the
  82  * syscall instruction on a later tick.
  83  */
  84 class SyscallRetryFault : public FaultBase
  85 {
  86   public:
  87     virtual FaultName name() const { return "System call retry fault"; }
  88     SyscallRetryFault() {}
  89     void invoke(ThreadContext *tc, const StaticInstPtr &inst =
  90                 StaticInst::nullStaticInstPtr);
  91 };
  92
  93 class GenericPageTableFault : public FaultBase
  94 {
  95   private:
  96     Addr vaddr;
  97   public:
  98     FaultName name() const { return "Generic page table fault"; }
  99     GenericPageTableFault(Addr va) : vaddr(va) {}
 100     void invoke(ThreadContext * tc, const StaticInstPtr &inst =
 101                 StaticInst::nullStaticInstPtr);
 102     Addr getFaultVAddr() const { return vaddr; }
 103 };
 104
 105 class GenericAlignmentFault : public FaultBase
 106 {
 107   private:
 108     Addr vaddr;
 109   public:
 110     FaultName name() const { return "Generic alignment fault"; }
 111     GenericAlignmentFault(Addr va) : vaddr(va) {}
 112     void invoke(ThreadContext * tc, const StaticInstPtr &inst =
 113                 StaticInst::nullStaticInstPtr);
 114     Addr getFaultVAddr() const { return vaddr; }
 115 };
 116
 117 #endif // __FAULTS_HH__