unimp.hh revision 12291:2c0d8c31fc3d 
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: Steve Reinhardt
29 */
30
31#ifndef __ARCH_SPARC_INSTS_UNIMP_HH__
32#define __ARCH_SPARC_INSTS_UNIMP_HH__
33
34#include "arch/sparc/insts/static_inst.hh"
35#include "base/cprintf.hh"
36
37namespace SparcISA
38{
39
40////////////////////////////////////////////////////////////////////
41//
42// Unimplemented instructions
43//
44
45/**
46 * Static instruction class for unimplemented instructions that
47 * cause simulator termination.  Note that these are recognized
48 * (legal) instructions that the simulator does not support; the
49 * 'Unknown' class is used for unrecognized/illegal instructions.
50 * This is a leaf class.
51 */
52class FailUnimplemented : public SparcStaticInst
53{
54  public:
55    /// Constructor
56    FailUnimplemented(const char *_mnemonic, ExtMachInst _machInst) :
57            SparcStaticInst(_mnemonic, _machInst, No_OpClass)
58    {
59        // don't call execute() (which panics) if we're on a
60        // speculative path
61        flags[IsNonSpeculative] = true;
62    }
63
64    Fault
65    execute(ExecContext *xc, Trace::InstRecord *traceData) const override
66    {
67        panic("attempt to execute unimplemented instruction '%s' "
68              "(inst 0x%08x)", mnemonic, machInst);
69    }
70
71    std::string
72    generateDisassembly(Addr pc, const SymbolTable *symtab) const override
73    {
74        return csprintf("%-10s (unimplemented)", mnemonic);
75    }
76};
77
78/**
79 * Base class for unimplemented instructions that cause a warning
80 * to be printed (but do not terminate simulation).  This
81 * implementation is a little screwy in that it will print a
82 * warning for each instance of a particular unimplemented machine
83 * instruction, not just for each unimplemented opcode.  Should
84 * probably make the 'warned' flag a static member of the derived
85 * class.
86 */
87class WarnUnimplemented : public SparcStaticInst
88{
89  private:
90    /// Have we warned on this instruction yet?
91    mutable bool warned;
92
93  public:
94    /// Constructor
95    WarnUnimplemented(const char *_mnemonic, ExtMachInst _machInst) :
96            SparcStaticInst(_mnemonic, _machInst, No_OpClass), warned(false)
97    {
98        // don't call execute() (which panics) if we're on a
99        // speculative path
100        flags[IsNonSpeculative] = true;
101    }
102
103    Fault
104    execute(ExecContext *xc, Trace::InstRecord *traceData) const override
105    {
106        if (!warned) {
107            warn("instruction '%s' unimplemented\n", mnemonic);
108            warned = true;
109        }
110        return NoFault;
111    }
112
113    std::string
114    generateDisassembly(Addr pc, const SymbolTable *symtab) const override
115    {
116        return csprintf("%-10s (unimplemented)", mnemonic);
117    }
118};
119
120}
121
122#endif // __ARCH_SPARC_INSTS_UNIMP_HH__
123