unimp.isa revision 2632:1bb2f91485ea 
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 AlphaStaticInst
38    {
39      public:
40        /// Constructor
41        FailUnimplemented(const char *_mnemonic, ExtMachInst _machInst)
42            : AlphaStaticInst(_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 AlphaStaticInst
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, ExtMachInst _machInst)
73            : AlphaStaticInst(_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#ifdef SS_COMPATIBLE_DISASSEMBLY
100        return csprintf("%-10s", mnemonic);
101#else
102        return csprintf("%-10s (unimplemented)", mnemonic);
103#endif
104    }
105}};
106
107output exec {{
108    Fault
109    FailUnimplemented::execute(%(CPU_exec_context)s *xc,
110                               Trace::InstRecord *traceData) const
111    {
112        panic("attempt to execute unimplemented instruction '%s' "
113              "(inst 0x%08x, opcode 0x%x)", mnemonic, machInst, OPCODE);
114        return new UnimplementedOpcodeFault;
115    }
116
117    Fault
118    WarnUnimplemented::execute(%(CPU_exec_context)s *xc,
119                               Trace::InstRecord *traceData) const
120    {
121        if (!warned) {
122            warn("instruction '%s' unimplemented\n", mnemonic);
123            warned = true;
124        }
125
126        return NoFault;
127    }
128}};
129
130
131def format FailUnimpl() {{
132    iop = InstObjParams(name, 'FailUnimplemented')
133    decode_block = BasicDecodeWithMnemonic.subst(iop)
134}};
135
136def format WarnUnimpl() {{
137    iop = InstObjParams(name, 'WarnUnimplemented')
138    decode_block = BasicDecodeWithMnemonic.subst(iop)
139}};
140
141output header {{
142    /**
143     * Static instruction class for unknown (illegal) instructions.
144     * These cause simulator termination if they are executed in a
145     * non-speculative mode.  This is a leaf class.
146     */
147    class Unknown : public AlphaStaticInst
148    {
149      public:
150        /// Constructor
151        Unknown(ExtMachInst _machInst)
152            : AlphaStaticInst("unknown", _machInst, No_OpClass)
153        {
154            // don't call execute() (which panics) if we're on a
155            // speculative path
156            flags[IsNonSpeculative] = true;
157        }
158
159        %(BasicExecDeclare)s
160
161        std::string
162        generateDisassembly(Addr pc, const SymbolTable *symtab) const;
163    };
164}};
165
166