basic.isa revision 5091:662c1d7b4795 
1// Copyright (c) 2006-2007 The Regents of The University of Michigan
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met: redistributions of source code must retain the above copyright
7// notice, this list of conditions and the following disclaimer;
8// redistributions in binary form must reproduce the above copyright
9// notice, this list of conditions and the following disclaimer in the
10// documentation and/or other materials provided with the distribution;
11// neither the name of the copyright holders nor the names of its
12// contributors may be used to endorse or promote products derived from
13// this software without specific prior written permission.
14//
15// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26//
27// Authors: Ali Saidi
28//          Gabe Black
29//          Steve Reinhardt
30
31// Declarations for execute() methods.
32def template BasicExecDeclare {{
33        Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const;
34}};
35
36// Definitions of execute methods that panic.
37def template BasicExecPanic {{
38        Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const
39        {
40            panic("Execute method called when it shouldn't!");
41            M5_DUMMY_RETURN
42        }
43}};
44
45// Basic instruction class declaration template.
46def template BasicDeclare {{
47        /**
48         * Static instruction class for "%(mnemonic)s".
49         */
50        class %(class_name)s : public %(base_class)s
51        {
52          public:
53            // Constructor.
54            %(class_name)s(ExtMachInst machInst);
55            %(BasicExecDeclare)s
56        };
57}};
58
59// Basic instruction class declaration template.
60def template BasicDeclareWithMnemonic {{
61        /**
62         * Static instruction class for "%(mnemonic)s".
63         */
64        class %(class_name)s : public %(base_class)s
65        {
66          public:
67            // Constructor.
68            %(class_name)s(const char * mnemonic, ExtMachInst machInst);
69            %(BasicExecDeclare)s
70        };
71}};
72
73// Basic instruction class constructor template.
74def template BasicConstructor {{
75        inline %(class_name)s::%(class_name)s(ExtMachInst machInst)
76            : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
77        {
78                %(constructor)s;
79        }
80}};
81
82// Basic instruction class constructor template.
83def template BasicConstructorWithMnemonic {{
84        inline %(class_name)s::%(class_name)s(const char * mnemonic,
85                ExtMachInst machInst)
86            : %(base_class)s(mnemonic, machInst, %(op_class)s)
87        {
88                %(constructor)s;
89        }
90}};
91
92// Basic instruction class execute method template.
93def template BasicExecute {{
94        Fault %(class_name)s::execute(%(CPU_exec_context)s *xc,
95                Trace::InstRecord *traceData) const
96        {
97            Fault fault = NoFault;
98
99            %(fp_enable_check)s;
100            %(op_decl)s;
101            %(op_rd)s;
102            %(code)s;
103
104            if(fault == NoFault)
105            {
106                %(op_wb)s;
107            }
108            return fault;
109        }
110}};
111
112// Basic decode template.
113def template BasicDecode {{
114        return new %(class_name)s(machInst);
115}};
116
117// Basic decode template, passing mnemonic in as string arg to constructor.
118def template BasicDecodeWithMnemonic {{
119    return new %(class_name)s("%(mnemonic)s", machInst);
120}};
121
122// The most basic instruction format... used only for a few misc. insts
123def format BasicOperate(code, *flags) {{
124        code = filterDoubles(code)
125        iop = InstObjParams(name, Name, 'SparcStaticInst', code, flags)
126        header_output = BasicDeclare.subst(iop)
127        decoder_output = BasicConstructor.subst(iop)
128        decode_block = BasicDecode.subst(iop)
129        exec_output = BasicExecute.subst(iop)
130}};
131
132def format FpBasic(code, *flags) {{
133        fp_code = """
134    Fsr |= bits(Fsr,4,0) << 5;
135    Fsr = insertBits(Fsr,4,0,0);
136    int newrnd = M5_FE_TONEAREST;
137    switch (Fsr<31:30>) {
138      case 0: newrnd = M5_FE_TONEAREST; break;
139      case 1: newrnd = M5_FE_TOWARDZERO; break;
140      case 2: newrnd = M5_FE_UPWARD; break;
141      case 3: newrnd = M5_FE_DOWNWARD; break;
142    }
143    int oldrnd = m5_fegetround();
144    m5_fesetround(newrnd);
145"""
146
147        fp_code += code
148
149
150        fp_code += """
151   m5_fesetround(oldrnd);
152"""
153        fp_code = filterDoubles(fp_code)
154        iop = InstObjParams(name, Name, 'SparcStaticInst', fp_code, flags)
155        header_output = BasicDeclare.subst(iop)
156        decoder_output = BasicConstructor.subst(iop)
157        decode_block = BasicDecode.subst(iop)
158        exec_output = BasicExecute.subst(iop)
159}};
160