1// -*- mode:c++ -*-
2
3// Copyright (c) 2007 MIPS Technologies, Inc.
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//
29// Authors: Korey Sewell
30//          Jaidev Patwardhan
31
32////////////////////////////////////////////////////////////////////
33//
34// Trap instructions
35//
36
37output header {{
38        /**
39         * Base class for integer operations.
40         */
41        class Trap : public MipsStaticInst
42        {
43                protected:
44
45                /// Constructor
46                Trap(const char *mnem, MachInst _machInst, OpClass __opClass) : MipsStaticInst(mnem, _machInst, __opClass)
47                {
48                }
49
50                std::string generateDisassembly(
51                        Addr pc, const SymbolTable *symtab) const override;
52        };
53        class TrapImm : public MipsStaticInst
54        {
55                protected:
56
57                int16_t imm;
58
59                /// Constructor
60                TrapImm(const char *mnem, MachInst _machInst, OpClass __opClass) :
61                    MipsStaticInst(mnem, _machInst, __opClass),imm(INTIMM)
62                {
63                }
64
65                std::string generateDisassembly(
66                        Addr pc, const SymbolTable *symtab) const override;
67        };
68
69}};
70
71output decoder {{
72        std::string Trap::generateDisassembly(Addr pc, const SymbolTable *symtab) const
73        {
74                return "Disassembly of trap instruction\n";
75        }
76        std::string TrapImm::generateDisassembly(Addr pc, const SymbolTable *symtab) const
77        {
78                return "Disassembly of trap instruction\n";
79        }
80}};
81
82def template TrapExecute {{
83        //Edit This Template When Traps Are Implemented
84        Fault %(class_name)s::execute(
85            ExecContext *xc, Trace::InstRecord *traceData) const
86        {
87                //Write the resulting state to the execution context
88                %(op_wb)s;
89
90                //Call into the trap handler with the appropriate fault
91                return No_Fault;
92        }
93}};
94def format Trap(code, *flags) {{
95
96        code ='bool cond;\n' + code
97        code += 'if (cond) {\n'
98        code += 'fault = std::make_shared<TrapFault>();\n};'
99
100        iop = InstObjParams(name, Name, 'MipsStaticInst', code, flags)
101        header_output = BasicDeclare.subst(iop)
102        decoder_output = BasicConstructor.subst(iop)
103        decode_block = BasicDecode.subst(iop)
104        exec_output = BasicExecute.subst(iop)
105}};
106def format TrapImm(code, *flags) {{
107
108        code ='bool cond;\n' + code
109        code += 'if (cond) {\n'
110        code += 'fault = std::make_shared<TrapFault>();\n};'
111        iop = InstObjParams(name, Name, 'MipsStaticInst', code, flags)
112        header_output = BasicDeclare.subst(iop)
113        decoder_output = BasicConstructor.subst(iop)
114        decode_block = BasicDecode.subst(iop)
115        exec_output = BasicExecute.subst(iop)
116}};
117