debugfaults.hh revision 8332 
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{
50class M5DebugFault : public FaultBase
51{
52  public:
53    enum DebugFunc
54    {
55        PanicFunc,
56        FatalFunc,
57        WarnFunc,
58        WarnOnceFunc
59    };
60
61  protected:
62    std::string message;
63    DebugFunc func;
64
65  public:
66    M5DebugFault(DebugFunc _func, std::string _message) :
67        message(_message), func(_func)
68    {}
69
70    FaultName
71    name() const
72    {
73        switch (func) {
74          case PanicFunc:
75            return "panic fault";
76          case FatalFunc:
77            return "fatal fault";
78          case WarnFunc:
79            return "warn fault";
80          case WarnOnceFunc:
81            return "warn_once fault";
82          default:
83            panic("unrecognized debug function number\n");
84        }
85    }
86
87    void
88    invoke(ThreadContext *tc,
89            StaticInstPtr inst = StaticInst::nullStaticInstPtr)
90    {
91        switch (func) {
92          case PanicFunc:
93            panic(message);
94            break;
95          case FatalFunc:
96            fatal(message);
97            break;
98          case WarnFunc:
99            warn(message);
100            break;
101          case WarnOnceFunc:
102            warn_once(message);
103            break;
104          default:
105            panic("unrecognized debug function number\n");
106        }
107    }
108};
109} // namespace GenericISA
110
111#endif // __ARCH_GENERIC_DEBUGFAULTS_HH__
112