faults.hh revision 2175 
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
29#ifndef __FAULTS_HH__
30#define __FAULTS_HH__
31
32#include "base/refcnt.hh"
33#include "sim/stats.hh"
34#include "config/full_system.hh"
35
36class ExecContext;
37class FaultBase;
38typedef RefCountingPtr<FaultBase> Fault;
39
40typedef const char * FaultName;
41typedef Stats::Scalar<> FaultStat;
42
43// Each class has it's name statically define in _name,
44// and has a virtual function to access it's name.
45// The function is necessary because otherwise, all objects
46// which are being accessed cast as a FaultBase * (namely
47// all faults returned using the Fault type) will use the
48// generic FaultBase name.
49
50class FaultBase : public RefCounted
51{
52  public:
53    virtual FaultName name() = 0;
54    virtual FaultStat & stat() = 0;
55#if FULL_SYSTEM
56    virtual void ev5_trap(ExecContext * xc) = 0;
57#endif
58    template<typename T>
59    bool isA() {return dynamic_cast<T *>(this);}
60    virtual bool isMachineCheckFault() {return false;}
61    virtual bool isAlignmentFault() {return false;}
62};
63
64FaultBase * const NoFault = 0;
65
66//The ISAs are each responsible for providing a genMachineCheckFault and a
67//genAlignmentFault functions, which return faults to use in the case of a
68//machine check fault or an alignment fault, respectively. Base classes which
69//provide the name() function, and the isMachineCheckFault and isAlignmentFault
70//functions are provided below.
71
72class MachineCheckFault : public virtual FaultBase
73{
74  private:
75    static FaultName _name;
76  public:
77    FaultName name() {return _name;}
78    bool isMachineCheckFault() {return true;}
79};
80
81class AlignmentFault : public virtual FaultBase
82{
83  private:
84    static FaultName _name;
85  public:
86    FaultName name() {return _name;}
87    bool isAlignmentFault() {return true;}
88};
89
90
91#endif // __FAULTS_HH__
92