faults.hh revision 10417 
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/refcnt.hh"
36#include "base/types.hh"
37#include "cpu/static_inst.hh"
38#include "sim/fault_fwd.hh"
39#include "sim/stats.hh"
40
41class ThreadContext;
42
43typedef const char * FaultName;
44typedef Stats::Scalar FaultStat;
45
46// Each class has it's name statically define in _name,
47// and has a virtual function to access it's name.
48// The function is necessary because otherwise, all objects
49// which are being accessed cast as a FaultBase * (namely
50// all faults returned using the Fault type) will use the
51// generic FaultBase name.
52
53class FaultBase : public RefCounted
54{
55  public:
56    virtual FaultName name() const = 0;
57    virtual void invoke(ThreadContext * tc, const StaticInstPtr &inst =
58                        StaticInst::nullStaticInstPtr);
59};
60
61class UnimpFault : public FaultBase
62{
63  private:
64    std::string panicStr;
65  public:
66    UnimpFault(std::string _str)
67        : panicStr(_str)
68    { }
69
70    FaultName name() const {return "Unimplemented simulator feature";}
71    void invoke(ThreadContext * tc, const StaticInstPtr &inst =
72                StaticInst::nullStaticInstPtr);
73};
74
75class ReExec : public FaultBase
76{
77  public:
78    virtual FaultName name() const { return "Re-execution fault";}
79    ReExec() {}
80    void invoke(ThreadContext *tc, const StaticInstPtr &inst =
81                StaticInst::nullStaticInstPtr);
82};
83
84class GenericPageTableFault : public FaultBase
85{
86  private:
87    Addr vaddr;
88  public:
89    FaultName name() const {return "Generic page table fault";}
90    GenericPageTableFault(Addr va) : vaddr(va) {}
91    void invoke(ThreadContext * tc, const StaticInstPtr &inst =
92                StaticInst::nullStaticInstPtr);
93};
94
95class GenericAlignmentFault : public FaultBase
96{
97  private:
98    Addr vaddr;
99  public:
100    FaultName name() const {return "Generic alignment fault";}
101    GenericAlignmentFault(Addr va) : vaddr(va) {}
102    void invoke(ThreadContext * tc, const StaticInstPtr &inst =
103                StaticInst::nullStaticInstPtr);
104};
105
106#endif // __FAULTS_HH__
107