debugfaults.hh (9414:88fa4031a9e3) debugfaults.hh (10292:933dfb9d8279)
1/*
2 * Copyright (c) 2010 Advanced Micro Devices, Inc.
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 * 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.
24 *
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.
36 *
37 * Authors: Gabe Black
38 */
39
40#ifndef __ARCH_GENERIC_DEBUGFAULTS_HH__
41#define __ARCH_GENERIC_DEBUGFAULTS_HH__
42
43#include <string>
44
45#include "base/misc.hh"
46#include "sim/faults.hh"
47
48namespace GenericISA
49{
50
51class M5DebugFault : public FaultBase
52{
53 public:
54 enum DebugFunc
55 {
56 PanicFunc,
57 FatalFunc,
58 WarnFunc,
59 WarnOnceFunc
60 };
61
62 protected:
63 std::string message;
64 DebugFunc func;
65
66 public:
67 M5DebugFault(DebugFunc _func, std::string _message) :
68 message(_message), func(_func)
69 {}
70
71 FaultName
72 name() const
73 {
74 switch (func) {
75 case PanicFunc:
76 return "panic fault";
77 case FatalFunc:
78 return "fatal fault";
79 case WarnFunc:
80 return "warn fault";
81 case WarnOnceFunc:
82 return "warn_once fault";
83 default:
84 panic("unrecognized debug function number\n");
85 }
86 }
87
88 void
89 invoke(ThreadContext *tc,
90 StaticInstPtr inst = StaticInst::nullStaticInstPtr)
91 {
92 switch (func) {
93 case PanicFunc:
94 panic(message);
95 break;
96 case FatalFunc:
97 fatal(message);
98 break;
99 case WarnFunc:
100 warn(message);
101 break;
102 case WarnOnceFunc:
103 warn_once(message);
104 break;
105 default:
106 panic("unrecognized debug function number\n");
107 }
108 }
109};
110
111template <int Func>
112class M5VarArgsFault : public M5DebugFault
113{
114 public:
1/*
2 * Copyright (c) 2010 Advanced Micro Devices, Inc.
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 * 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.
24 *
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.
36 *
37 * Authors: Gabe Black
38 */
39
40#ifndef __ARCH_GENERIC_DEBUGFAULTS_HH__
41#define __ARCH_GENERIC_DEBUGFAULTS_HH__
42
43#include <string>
44
45#include "base/misc.hh"
46#include "sim/faults.hh"
47
48namespace GenericISA
49{
50
51class M5DebugFault : public FaultBase
52{
53 public:
54 enum DebugFunc
55 {
56 PanicFunc,
57 FatalFunc,
58 WarnFunc,
59 WarnOnceFunc
60 };
61
62 protected:
63 std::string message;
64 DebugFunc func;
65
66 public:
67 M5DebugFault(DebugFunc _func, std::string _message) :
68 message(_message), func(_func)
69 {}
70
71 FaultName
72 name() const
73 {
74 switch (func) {
75 case PanicFunc:
76 return "panic fault";
77 case FatalFunc:
78 return "fatal fault";
79 case WarnFunc:
80 return "warn fault";
81 case WarnOnceFunc:
82 return "warn_once fault";
83 default:
84 panic("unrecognized debug function number\n");
85 }
86 }
87
88 void
89 invoke(ThreadContext *tc,
90 StaticInstPtr inst = StaticInst::nullStaticInstPtr)
91 {
92 switch (func) {
93 case PanicFunc:
94 panic(message);
95 break;
96 case FatalFunc:
97 fatal(message);
98 break;
99 case WarnFunc:
100 warn(message);
101 break;
102 case WarnOnceFunc:
103 warn_once(message);
104 break;
105 default:
106 panic("unrecognized debug function number\n");
107 }
108 }
109};
110
111template <int Func>
112class M5VarArgsFault : public M5DebugFault
113{
114 public:
115 M5VarArgsFault(const std::string &format, CPRINTF_DECLARATION) :
116 M5DebugFault((DebugFunc)Func, csprintf(format, VARARGS_ALLARGS))
115 template<typename ...Args>
116 M5VarArgsFault(const std::string &format, const Args &...args) :
117 M5DebugFault((DebugFunc)Func, csprintf(format, args...))
117 {}
118};
119
120typedef M5VarArgsFault<M5DebugFault::PanicFunc> M5PanicFault;
121typedef M5VarArgsFault<M5DebugFault::FatalFunc> M5FatalFault;
122typedef M5VarArgsFault<M5DebugFault::WarnFunc> M5WarnFault;
123typedef M5VarArgsFault<M5DebugFault::WarnOnceFunc> M5WarnOnceFault;
124
125} // namespace GenericISA
126
127#endif // __ARCH_GENERIC_DEBUGFAULTS_HH__
118 {}
119};
120
121typedef M5VarArgsFault<M5DebugFault::PanicFunc> M5PanicFault;
122typedef M5VarArgsFault<M5DebugFault::FatalFunc> M5FatalFault;
123typedef M5VarArgsFault<M5DebugFault::WarnFunc> M5WarnFault;
124typedef M5VarArgsFault<M5DebugFault::WarnOnceFunc> M5WarnOnceFault;
125
126} // namespace GenericISA
127
128#endif // __ARCH_GENERIC_DEBUGFAULTS_HH__