unimp.isa revision 2686:f0d591379ac3 
1// -*- mode:c++ -*-
2
3// Copyright (c) 2003-2005 The Regents of The University of Michigan
4// All rights reserved.
5//
6// Redistribution and use in source and binary forms, with or without
7// modification, are permitted provided that the following conditions are
8// met: redistributions of source code must retain the above copyright
9// notice, this list of conditions and the following disclaimer;
10// redistributions in binary form must reproduce the above copyright
11// notice, this list of conditions and the following disclaimer in the
12// documentation and/or other materials provided with the distribution;
13// neither the name of the copyright holders nor the names of its
14// contributors may be used to endorse or promote products derived from
15// this software without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29output header {{
30    /**
31     * Static instruction class for unimplemented instructions that
32     * cause simulator termination.  Note that these are recognized
33     * (legal) instructions that the simulator does not support; the
34     * 'Unknown' class is used for unrecognized/illegal instructions.
35     * This is a leaf class.
36     */
37    class FailUnimplemented : public MipsStaticInst
38    {
39      public:
40        /// Constructor
41        FailUnimplemented(const char *_mnemonic, MachInst _machInst)
42            : MipsStaticInst(_mnemonic, _machInst, No_OpClass)
43        {
44            // don't call execute() (which panics) if we're on a
45            // speculative path
46            flags[IsNonSpeculative] = true;
47        }
48
49        %(BasicExecDeclare)s
50
51        std::string
52        generateDisassembly(Addr pc, const SymbolTable *symtab) const;
53    };
54
55    /**
56     * Base class for unimplemented instructions that cause a warning
57     * to be printed (but do not terminate simulation).  This
58     * implementation is a little screwy in that it will print a
59     * warning for each instance of a particular unimplemented machine
60     * instruction, not just for each unimplemented opcode.  Should
61     * probably make the 'warned' flag a static member of the derived
62     * class.
63     */
64    class WarnUnimplemented : public MipsStaticInst
65    {
66      private:
67        /// Have we warned on this instruction yet?
68        mutable bool warned;
69
70      public:
71        /// Constructor
72        WarnUnimplemented(const char *_mnemonic, MachInst _machInst)
73            : MipsStaticInst(_mnemonic, _machInst, No_OpClass), warned(false)
74        {
75            // don't call execute() (which panics) if we're on a
76            // speculative path
77            flags[IsNonSpeculative] = true;
78        }
79
80        %(BasicExecDeclare)s
81
82        std::string
83        generateDisassembly(Addr pc, const SymbolTable *symtab) const;
84    };
85}};
86
87output decoder {{
88    std::string
89    FailUnimplemented::generateDisassembly(Addr pc,
90                                           const SymbolTable *symtab) const
91    {
92        return csprintf("%-10s (unimplemented)", mnemonic);
93    }
94
95    std::string
96    WarnUnimplemented::generateDisassembly(Addr pc,
97                                           const SymbolTable *symtab) const
98    {
99        return csprintf("%-10s (unimplemented)", mnemonic);
100    }
101}};
102
103output exec {{
104    Fault
105    FailUnimplemented::execute(%(CPU_exec_context)s *xc,
106                               Trace::InstRecord *traceData) const
107    {
108        panic("attempt to execute unimplemented instruction '%s' "
109              "(inst 0x%08x, opcode 0x%x, binary:%s)", mnemonic, machInst, OPCODE,
110              inst2string(machInst));
111        return new UnimplementedOpcodeFault;
112    }
113
114    Fault
115    WarnUnimplemented::execute(%(CPU_exec_context)s *xc,
116                               Trace::InstRecord *traceData) const
117    {
118        if (!warned) {
119            warn("\tinstruction '%s' unimplemented\n", mnemonic);
120            warned = true;
121        }
122
123        return NoFault;
124    }
125}};
126
127
128def format FailUnimpl() {{
129    iop = InstObjParams(name, 'FailUnimplemented')
130    decode_block = BasicDecodeWithMnemonic.subst(iop)
131}};
132
133def format WarnUnimpl() {{
134    iop = InstObjParams(name, 'WarnUnimplemented')
135    decode_block = BasicDecodeWithMnemonic.subst(iop)
136}};
137
138