faults.hh revision 2665 
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 "sim/stats.hh"
37#include "config/full_system.hh"
38
39class ExecContext;
40class FaultBase;
41typedef RefCountingPtr<FaultBase> Fault;
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() = 0;
57#if FULL_SYSTEM
58    virtual void invoke(ExecContext * xc);
59#else
60    virtual void invoke(ExecContext * xc);
61#endif
62//    template<typename T>
63//    bool isA() {return dynamic_cast<T *>(this);}
64    virtual bool isMachineCheckFault() {return false;}
65    virtual bool isAlignmentFault() {return false;}
66};
67
68FaultBase * const NoFault = 0;
69
70class UnimpFault : public FaultBase
71{
72  private:
73    std::string panicStr;
74  public:
75    UnimpFault(std::string _str)
76        : panicStr(_str)
77    { }
78
79    FaultName name() {return "Unimplemented simulator feature";}
80    void invoke(ExecContext * xc);
81};
82
83#endif // __FAULTS_HH__
84