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
39 execute(%(CPU_exec_context)s *, Trace::InstRecord *) const
40 {
41 panic("Execute method called when it shouldn't!");
42 M5_DUMMY_RETURN
43 }
44}};
45
46// Basic instruction class declaration template.
47def template BasicDeclare {{
48 /**
49 * Static instruction class for "%(mnemonic)s".
50 */
51 class %(class_name)s : public %(base_class)s
52 {
53 public:
54 // Constructor.
55 %(class_name)s(ExtMachInst machInst);
56 %(BasicExecDeclare)s
57 };
58}};
59
60// Basic instruction class declaration template.
61def template BasicDeclareWithMnemonic {{
62 /**
63 * Static instruction class for "%(mnemonic)s".
64 */
65 class %(class_name)s : public %(base_class)s
66 {
67 public:
68 // Constructor.
69 %(class_name)s(const char * mnemonic, ExtMachInst machInst);
70 %(BasicExecDeclare)s
71 };
72}};
73
74// Basic instruction class constructor template.
75def template BasicConstructor {{
76 inline %(class_name)s::%(class_name)s(ExtMachInst machInst)
77 : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
78 {
79 %(constructor)s;
80 }
81}};
82
83// Basic instruction class constructor template.
84def template BasicConstructorWithMnemonic {{
85 inline %(class_name)s::%(class_name)s(const char * mnemonic,
86 ExtMachInst machInst)
87 : %(base_class)s(mnemonic, machInst, %(op_class)s)
88 {
89 %(constructor)s;
90 }
91}};
92
93// Basic instruction class execute method template.
94def template BasicExecute {{
95 Fault
96 %(class_name)s::execute(%(CPU_exec_context)s *xc,
97 Trace::InstRecord *traceData) const
98 {
99 Fault fault = NoFault;
100
101 %(fp_enable_check)s;
102 %(op_decl)s;
103 %(op_rd)s;
104 %(code)s;
105
106 if (fault == NoFault) {
107 %(op_wb)s;
108 }
109 return fault;
110 }
111}};
112
113// Basic decode template.
114def template BasicDecode {{
115 return new %(class_name)s(machInst);
116}};
117
118// Basic decode template, passing mnemonic in as string arg to constructor.
119def template BasicDecodeWithMnemonic {{
120 return new %(class_name)s("%(mnemonic)s", machInst);
121}};
122
123// The most basic instruction format... used only for a few misc. insts
124def format BasicOperate(code, *flags) {{
125 code = filterDoubles(code)
126 iop = InstObjParams(name, Name, 'SparcStaticInst', code, flags)
127 header_output = BasicDeclare.subst(iop)
128 decoder_output = BasicConstructor.subst(iop)
129 decode_block = BasicDecode.subst(iop)
130 exec_output = BasicExecute.subst(iop)
131}};
132
133def format FpBasic(code, *flags) {{
134 fp_code = """
135 Fsr |= bits(Fsr,4,0) << 5;
136 Fsr = insertBits(Fsr,4,0,0);
137 int newrnd = M5_FE_TONEAREST;
138 switch (Fsr<31:30>) {
139 case 0: newrnd = M5_FE_TONEAREST; break;
140 case 1: newrnd = M5_FE_TOWARDZERO; break;
141 case 2: newrnd = M5_FE_UPWARD; break;
142 case 3: newrnd = M5_FE_DOWNWARD; break;
143 }
144 int oldrnd = m5_fegetround();
145 m5_fesetround(newrnd);
146"""
147
148 fp_code += code
149
150
151 fp_code += """
152 m5_fesetround(oldrnd);
153"""
154 fp_code = filterDoubles(fp_code)
155 iop = InstObjParams(name, Name, 'SparcStaticInst', fp_code, flags)
156 header_output = BasicDeclare.subst(iop)
157 decoder_output = BasicConstructor.subst(iop)
158 decode_block = BasicDecode.subst(iop)
159 exec_output = BasicExecute.subst(iop)
160}};