2 * Copyright (c) 2010 Advanced Micro Devices, Inc.
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.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 #ifndef __ARCH_GENERIC_DEBUGFAULTS_HH__
41 #define __ARCH_GENERIC_DEBUGFAULTS_HH__
45 #include "base/logging.hh"
46 #include "sim/faults.hh"
51 class M5DebugFault : public FaultBase
55 virtual void debugFunc() = 0;
57 advancePC(ThreadContext *tc, const StaticInstPtr &inst)
60 auto pc = tc->pcState();
67 M5DebugFault(std::string _m) : _message(_m) {}
69 template <class ...Args>
70 M5DebugFault(const std::string &format, const Args &...args) :
71 _message(csprintf(format, args...))
74 std::string message() { return _message; }
77 invoke(ThreadContext *tc, const StaticInstPtr &inst =
78 StaticInst::nullStaticInstPtr) override
85 // The "Flavor" template parameter is to keep warn, hack or inform messages
86 // with the same token from blocking each other.
87 template <class Flavor>
88 class M5DebugOnceFault : public M5DebugFault
93 template <class F, class OnceToken>
95 lookUpToken(const OnceToken &token)
97 static std::map<OnceToken, bool> tokenMap;
98 return tokenMap[token];
102 template <class OnceToken, class ...Args>
103 M5DebugOnceFault(const OnceToken &token, const std::string &format,
104 const Args &...args) :
105 M5DebugFault(format, args...), once(lookUpToken<Flavor>(token))
109 invoke(ThreadContext *tc, const StaticInstPtr &inst =
110 StaticInst::nullStaticInstPtr) override
120 class M5PanicFault : public M5DebugFault
123 using M5DebugFault::M5DebugFault;
124 void debugFunc() override { panic(message()); }
125 FaultName name() const override { return "panic fault"; }
128 class M5FatalFault : public M5DebugFault
131 using M5DebugFault::M5DebugFault;
132 void debugFunc() override { fatal(message()); }
133 FaultName name() const override { return "fatal fault"; }
136 template <class Base>
137 class M5WarnFaultBase : public Base
141 void debugFunc() override { warn(this->message()); }
142 FaultName name() const override { return "warn fault"; }
145 using M5WarnFault = M5WarnFaultBase<M5DebugFault>;
146 using M5WarnOnceFault = M5WarnFaultBase<M5DebugOnceFault<M5WarnFault>>;
148 template <class Base>
149 class M5HackFaultBase : public Base
153 void debugFunc() override { hack(this->message()); }
154 FaultName name() const override { return "hack fault"; }
157 using M5HackFault = M5HackFaultBase<M5DebugFault>;
158 using M5HackOnceFault = M5HackFaultBase<M5DebugOnceFault<M5HackFault>>;
160 template <class Base>
161 class M5InformFaultBase : public Base
165 void debugFunc() override { inform(this->message()); }
166 FaultName name() const override { return "inform fault"; }
169 using M5InformFault = M5InformFaultBase<M5DebugFault>;
170 using M5InformOnceFault =
171 M5InformFaultBase<M5DebugOnceFault<M5InformFault>>;
173 } // namespace GenericISA
175 #endif // __ARCH_GENERIC_DEBUGFAULTS_HH__