1// Copyright (c) 2008 The Hewlett-Packard Development Company
2// All rights reserved.
3//
4// The license below extends only to copyright in the software and shall
5// not be construed as granting a license to any other intellectual
6// property including but not limited to intellectual property relating
7// to a hardware implementation of the functionality of the software
8// licensed hereunder. You may use the software subject to the license
9// terms below provided that you ensure that this notice is replicated
10// unmodified and in its entirety in all distributions of the software,
11// modified or unmodified, in source code or in binary form.
12//
13// Redistribution and use in source and binary forms, with or without
14// modification, are permitted provided that the following conditions are
15// met: redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer;
17// redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution;
20// neither the name of the copyright holders nor the names of its
21// contributors may be used to endorse or promote products derived from
22// this software without specific prior written permission.
23//
24// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35//
36// Authors: Gabe Black
37
38output header {{
39 class SeqOpBase : public X86ISA::X86MicroopBase
40 {
41 protected:
42 uint16_t target;
43 uint8_t cc;
44
45 public:
46 SeqOpBase(ExtMachInst _machInst, const char * instMnem,
47 const char * mnemonic, uint64_t setFlags,
48 uint16_t _target, uint8_t _cc);
49
50 SeqOpBase(ExtMachInst _machInst, const char * instMnem,
51 const char * mnemonic,
52 uint16_t _target, uint8_t _cc);
53
54 std::string generateDisassembly(Addr pc,
55 const SymbolTable *symtab) const;
56 };
57}};
58
59def template SeqOpDeclare {{
60 class %(class_name)s : public %(base_class)s
61 {
62 private:
63 void buildMe();
64 public:
65 %(class_name)s(ExtMachInst _machInst, const char * instMnem,
66 uint64_t setFlags, uint16_t _target, uint8_t _cc);
67
68 %(class_name)s(ExtMachInst _machInst, const char * instMnem,
69 uint16_t _target, uint8_t _cc);
70
71 %(BasicExecDeclare)s
72 };
73}};
74
75def template SeqOpExecute {{
76 Fault %(class_name)s::execute(%(CPU_exec_context)s *xc,
77 Trace::InstRecord *traceData) const
78 {
79 %(op_decl)s;
80 %(op_rd)s;
81 if (%(cond_test)s) {
82 %(code)s;
83 } else {
84 %(else_code)s;
85 }
86 %(op_wb)s;
87 return NoFault;
88 }
89}};
90
91output decoder {{
92 inline SeqOpBase::SeqOpBase(
93 ExtMachInst machInst, const char * mnemonic, const char * instMnem,
94 uint16_t _target, uint8_t _cc) :
95 X86MicroopBase(machInst, mnemonic, instMnem, 0, No_OpClass),
96 target(_target), cc(_cc)
97 {
98 }
99
100 inline SeqOpBase::SeqOpBase(
101 ExtMachInst machInst, const char * mnemonic, const char * instMnem,
102 uint64_t setFlags, uint16_t _target, uint8_t _cc) :
103 X86MicroopBase(machInst, mnemonic, instMnem, setFlags, No_OpClass),
104 target(_target), cc(_cc)
105 {
106 }
107}};
108
109def template SeqOpConstructor {{
110
111 inline void %(class_name)s::buildMe()
112 {
113 %(constructor)s;
114 }
115
116 inline %(class_name)s::%(class_name)s(
117 ExtMachInst machInst, const char * instMnem,
118 uint16_t _target, uint8_t _cc) :
119 %(base_class)s(machInst, "%(mnemonic)s", instMnem, _target, _cc)
120 {
121 buildMe();
122 }
123
124 inline %(class_name)s::%(class_name)s(
125 ExtMachInst machInst, const char * instMnem,
126 uint64_t setFlags, uint16_t _target, uint8_t _cc) :
127 %(base_class)s(machInst, "%(mnemonic)s", instMnem,
128 setFlags, _target, _cc)
129 {
130 buildMe();
131 }
132}};
133
134output decoder {{
135 std::string SeqOpBase::generateDisassembly(Addr pc,
136 const SymbolTable *symtab) const
137 {
138 std::stringstream response;
139
140 printMnemonic(response, instMnem, mnemonic);
141 ccprintf(response, "%#x", target);
142
143 return response.str();
144 }
145}};
146
147let {{
148 class SeqOp(X86Microop):
149 def __init__(self, target, flags=None):
150 self.target = target
151 if flags:
152 if not isinstance(flags, (list, tuple)):
153 raise Exception, "flags must be a list or tuple of flags"
154 self.cond = " | ".join(flags)
155 self.className += "Flags"
156 else:
157 self.cond = "0"
158
159 def getAllocator(self, microFlags):
160 allocator = '''new %(class_name)s(machInst, macrocodeBlock,
161 %(flags)s, %(target)s, %(cc)s)''' % {
162 "class_name" : self.className,
163 "flags" : self.microFlagsText(microFlags),
164 "target" : self.target,
165 "cc" : self.cond}
166 return allocator
167
168 class Br(SeqOp):
169 className = "MicroBranch"
170
171 def getAllocator(self, microFlags):
172 if "IsLastMicroop" in microFlags:
173 microFlags.remove("IsLastMicroop")
174 if not "IsDelayedCommit" in microFlags:
175 microFlags.append("IsDelayedCommit")
176 return super(Br, self).getAllocator(microFlags)
177
178 class Eret(SeqOp):
179 target = "normalMicroPC(0)"
180 className = "Eret"
181
182 def __init__(self, flags=None):
183 if flags:
184 if not isinstance(flags, (list, tuple)):
185 raise Exception, "flags must be a list or tuple of flags"
186 self.cond = " | ".join(flags)
187 self.className += "Flags"
188 else:
189 self.cond = "0"
190
191 def getAllocator(self, microFlags):
192 if not "IsLastMicroop" in microFlags:
193 microFlags.append("IsLastMicroop")
194 if "IsDelayedCommit" in microFlags:
195 microFlags.remove("IsDelayedCommit")
196 return super(Eret, self).getAllocator(microFlags)
197
198 iop = InstObjParams("br", "MicroBranchFlags", "SeqOpBase",
199 {"code": "nuIP = target",
200 "else_code": "nuIP = nuIP",
201 "cond_test": "checkCondition(ccFlagBits, cc)"})
202 exec_output += SeqOpExecute.subst(iop)
203 header_output += SeqOpDeclare.subst(iop)
204 decoder_output += SeqOpConstructor.subst(iop)
205 iop = InstObjParams("br", "MicroBranch", "SeqOpBase",
206 {"code": "nuIP = target",
207 "else_code": "nuIP = nuIP",
208 "cond_test": "true"})
209 exec_output += SeqOpExecute.subst(iop)
210 header_output += SeqOpDeclare.subst(iop)
211 decoder_output += SeqOpConstructor.subst(iop)
212 microopClasses["br"] = Br
213
214 iop = InstObjParams("eret", "EretFlags", "SeqOpBase",
215 {"code": "", "else_code": "",
216 "cond_test": "checkCondition(ccFlagBits, cc)"})
217 exec_output += SeqOpExecute.subst(iop)
218 header_output += SeqOpDeclare.subst(iop)
219 decoder_output += SeqOpConstructor.subst(iop)
220 iop = InstObjParams("eret", "Eret", "SeqOpBase",
221 {"code": "", "else_code": "",
222 "cond_test": "true"})
223 exec_output += SeqOpExecute.subst(iop)
224 header_output += SeqOpDeclare.subst(iop)
225 decoder_output += SeqOpConstructor.subst(iop)
226 microopClasses["eret"] = Eret
227}};