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