src/sim/faults.hh

   1 /*
   2  * Copyright (c) 2020 ARM Limited
   3  * All rights reserved
   4  *
   5  * The license below extends only to copyright in the software and shall
   6  * not be construed as granting a license to any other intellectual
   7  * property including but not limited to intellectual property relating
   8  * to a hardware implementation of the functionality of the software
   9  * licensed hereunder.  You may use the software subject to the license
  10  * terms below provided that you ensure that this notice is replicated
  11  * unmodified and in its entirety in all distributions of the software,
  12  * modified or unmodified, in source code or in binary form.
  13  *
  14  * Copyright (c) 2003-2005 The Regents of The University of Michigan
  15  * All rights reserved.
  16  *
  17  * Redistribution and use in source and binary forms, with or without
  18  * modification, are permitted provided that the following conditions are
  19  * met: redistributions of source code must retain the above copyright
  20  * notice, this list of conditions and the following disclaimer;
  21  * redistributions in binary form must reproduce the above copyright
  22  * notice, this list of conditions and the following disclaimer in the
  23  * documentation and/or other materials provided with the distribution;
  24  * neither the name of the copyright holders nor the names of its
  25  * contributors may be used to endorse or promote products derived from
  26  * this software without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  39  */
  40
  41 #ifndef __FAULTS_HH__
  42 #define __FAULTS_HH__
  43
  44 #include "base/types.hh"
  45 #include "cpu/static_inst.hh"
  46 #include "mem/htm.hh"
  47 #include "sim/stats.hh"
  48
  49 class ThreadContext;
  50
  51 typedef const char *FaultName;
  52 typedef Stats::Scalar FaultStat;
  53
  54 class FaultBase
  55 {
  56   public:
  57     virtual FaultName name() const = 0;
  58     virtual void invoke(ThreadContext * tc, const StaticInstPtr &inst=
  59                         StaticInst::nullStaticInstPtr);
  60     virtual ~FaultBase() {};
  61 };
  62
  63 class UnimpFault : public FaultBase
  64 {
  65   private:
  66     std::string panicStr;
  67   public:
  68     UnimpFault(std::string _str) : panicStr(_str) {}
  69
  70     FaultName
  71     name() const override
  72     {
  73         return "Unimplemented simulator feature";
  74     }
  75     void invoke(ThreadContext *tc, const StaticInstPtr &inst =
  76                 StaticInst::nullStaticInstPtr) override;
  77 };
  78
  79 // A fault to trigger a system call in SE mode.
  80 class SESyscallFault : public FaultBase
  81 {
  82     const char *name() const override { return "syscall_fault"; }
  83
  84     void invoke(ThreadContext *tc, const StaticInstPtr &inst=
  85             StaticInst::nullStaticInstPtr) override;
  86 };
  87
  88 class ReExec : public FaultBase
  89 {
  90   public:
  91     virtual FaultName name() const override { return "Re-execution fault"; }
  92     void invoke(ThreadContext *tc, const StaticInstPtr &inst=
  93                 StaticInst::nullStaticInstPtr) override;
  94 };
  95
  96 /*
  97  * This class is needed to allow system call retries to occur for blocking
  98  * system calls in SE mode. A retry fault will be generated by the system call
  99  * emulation code if blocking conditions arise; the fault is passed up the
 100  * function call chain into the CPU model where it is handled by retrying the
 101  * syscall instruction on a later tick.
 102  */
 103 class SyscallRetryFault : public FaultBase
 104 {
 105   public:
 106     FaultName name() const override { return "System call retry fault"; }
 107     SyscallRetryFault() {}
 108     void invoke(ThreadContext *tc, const StaticInstPtr &inst=
 109                 StaticInst::nullStaticInstPtr) override;
 110 };
 111
 112 class GenericPageTableFault : public FaultBase
 113 {
 114   private:
 115     Addr vaddr;
 116   public:
 117     FaultName name() const override { return "Generic page table fault"; }
 118     GenericPageTableFault(Addr va) : vaddr(va) {}
 119     void invoke(ThreadContext *tc, const StaticInstPtr &inst=
 120                 StaticInst::nullStaticInstPtr) override;
 121     Addr getFaultVAddr() const { return vaddr; }
 122 };
 123
 124 class GenericAlignmentFault : public FaultBase
 125 {
 126   private:
 127     Addr vaddr;
 128   public:
 129     FaultName name() const override { return "Generic alignment fault"; }
 130     GenericAlignmentFault(Addr va) : vaddr(va) {}
 131     void invoke(ThreadContext *tc, const StaticInstPtr &inst=
 132                 StaticInst::nullStaticInstPtr) override;
 133     Addr getFaultVAddr() const { return vaddr; }
 134 };
 135
 136 class GenericHtmFailureFault : public FaultBase
 137 {
 138   protected:
 139     uint64_t htmUid; // unique identifier used for debugging
 140     HtmFailureFaultCause cause;
 141
 142   public:
 143     GenericHtmFailureFault(uint64_t htm_uid, HtmFailureFaultCause _cause)
 144       : htmUid(htm_uid), cause(_cause)
 145     {}
 146
 147     FaultName name() const override { return "Generic HTM failure fault"; }
 148
 149     uint64_t getHtmUid() const { return htmUid; }
 150     HtmFailureFaultCause getHtmFailureFaultCause() const { return cause; }
 151     void invoke(ThreadContext *tc, const StaticInstPtr &inst =
 152                 StaticInst::nullStaticInstPtr) override;
 153 };
 154
 155 #endif // __FAULTS_HH__