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