1// -*- mode:c++ -*-
2
3// Copyright (c) 2007 The Hewlett-Packard Development Company
4// All rights reserved.
5//
6// Redistribution and use of this software in source and binary forms,
7// with or without modification, are permitted provided that the
8// following conditions are met:
9//
10// The software must be used only for Non-Commercial Use which means any
11// use which is NOT directed to receiving any direct monetary
12// compensation for, or commercial advantage from such use. Illustrative
13// examples of non-commercial use are academic research, personal study,
14// teaching, education and corporate research & development.
15// Illustrative examples of commercial use are distributing products for
16// commercial advantage and providing services using the software for
17// commercial advantage.
18//
19// If you wish to use this software or functionality therein that may be
20// covered by patents for commercial use, please contact:
21// Director of Intellectual Property Licensing
22// Office of Strategy and Technology
23// Hewlett-Packard Company
24// 1501 Page Mill Road
25// Palo Alto, California 94304
26//
27// Redistributions of source code must retain the above copyright notice,
28// this list of conditions and the following disclaimer. Redistributions
29// in binary form must reproduce the above copyright notice, this list of
30// conditions and the following disclaimer in the documentation and/or
31// other materials provided with the distribution. Neither the name of
32// the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
33// contributors may be used to endorse or promote products derived from
34// this software without specific prior written permission. No right of
35// sublicense is granted herewith. Derivatives of the software and
36// output created using the software may be prepared, but only for
37// Non-Commercial Uses. Derivatives of the software may be shared with
38// others provided: (i) the others agree to abide by the list of
39// conditions herein which includes the Non-Commercial Use restrictions;
40// and (ii) such Derivatives of the software include the above copyright
41// notice to acknowledge the contribution from this software where
42// applicable, this list of conditions and the disclaimer below.
43//
44// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
45// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
46// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
47// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
48// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
49// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
50// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
51// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
52// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
53// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
54// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55//
56// Authors: Gabe Black
57
58//////////////////////////////////////////////////////////////////////////////
59//
60// Architecture independent
61//
62
63// Execute method for macroops.
64def template MacroExecPanic {{
65 Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const
66 {
67 panic("Tried to execute macroop directly!");
68 return NoFault;
69 }
70}};
71
72output header {{
73
74 // Base class for combinationally generated macroops
75 class Macroop : public StaticInst
76 {
77 protected:
78 const uint32_t numMicroops;
79
80 //Constructor.
81 Macroop(const char *mnem, ExtMachInst _machInst,
82 uint32_t _numMicroops)
83 : StaticInst(mnem, _machInst, No_OpClass),
84 numMicroops(_numMicroops)
85 {
86 assert(numMicroops);
87 microops = new StaticInstPtr[numMicroops];
88 flags[IsMacroop] = true;
89 }
90
91 ~Macroop()
92 {
93 delete [] microops;
94 }
95
96 StaticInstPtr * microops;
97
98 StaticInstPtr fetchMicroop(MicroPC microPC)
99 {
100 assert(microPC < numMicroops);
101 return microops[microPC];
102 }
103
104 std::string generateDisassembly(Addr pc,
105 const SymbolTable *symtab) const
106 {
107 return mnemonic;
108 }
109
110 %(MacroExecPanic)s
111 };
112}};
113
114//////////////////////////////////////////////////////////////////////////////
115//
116// X86 specific
117//
118//////////////////////////////////////////////////////////////////////////////
119
120// Basic instruction class declaration template.
121def template MacroDeclare {{
122 namespace X86Macroop
123 {
124 /**
125 * Static instruction class for "%(mnemonic)s".
126 */
127 class %(class_name)s : public %(base_class)s
128 {
129 public:
130 // Constructor.
125 %(class_name)s(ExtMachInst machInst, EmulEnv env);
131 %(class_name)s(ExtMachInst machInst, X86ISA::EmulEnv env);
132 };
133 };
134}};
135
136// Basic instruction class constructor template.
137def template MacroConstructor {{
132 inline X86Macroop::%(class_name)s::%(class_name)s(ExtMachInst machInst, EmulEnv env)
138 inline X86Macroop::%(class_name)s::%(class_name)s(
139 ExtMachInst machInst, EmulEnv env)
140 : %(base_class)s("%(mnemonic)s", machInst, %(num_microops)s)
141 {
142 %(adjust_env)s;
143 %(do_modrm)s;
144 %(constructor)s;
145 //alloc_microops is the code that sets up the microops
146 //array in the parent class.
147 %(alloc_microops)s;
148 }
149}};
150
143//////////////////////////////////////////////////////////////////////////////
144//
145// X86 specific
146//
147
151let {{
152 from micro_asm import Combinational_Macroop, Rom_Macroop
153 class X86Macroop(Combinational_Macroop):
154 def setAdjustEnv(self, val):
155 self.adjust_env = val
156 def __init__(self, name):
157 super(X86Macroop, self).__init__(name)
158 self.directives = {
159 "adjust_env" : self.setAdjustEnv
160 }
161 self.declared = False
162 self.adjust_env = ""
163 self.doModRM = ""
164 def getAllocator(self, env):
165 return "new X86Macroop::%s(machInst, %s)" % (self.name, env.getAllocator())
166 def getDeclaration(self):
167 #FIXME This first parameter should be the mnemonic. I need to
168 #write some code which pulls that out
169 iop = InstObjParams(self.name, self.name, "Macroop", {"code" : ""})
170 return MacroDeclare.subst(iop);
171 def getDefinition(self):
172 #FIXME This first parameter should be the mnemonic. I need to
173 #write some code which pulls that out
174 numMicroops = len(self.microops)
175 allocMicroops = ''
176 micropc = 0
177 for op in self.microops:
178 allocMicroops += \
179 "microops[%d] = %s;\n" % \
180 (micropc, op.getAllocator(True, False,
181 micropc == 0,
182 micropc == numMicroops - 1))
183 micropc += 1
184 iop = InstObjParams(self.name, self.name, "Macroop",
185 {"code" : "", "num_microops" : numMicroops,
186 "alloc_microops" : allocMicroops,
183 "adjust_env" : self.adjust_env})
187 "adjust_env" : self.adjust_env,
188 "do_modrm" : self.doModRM})
189 return MacroConstructor.subst(iop);
190}};
191
187output header {{
188 struct EmulEnv
189 {
190 X86ISA::RegIndex reg;
191 X86ISA::RegIndex regm;
192 uint8_t scale;
193 X86ISA::RegIndex index;
194 X86ISA::RegIndex base;
195 int dataSize;
196 int addressSize;
197 int stackSize;
198
199 EmulEnv(X86ISA::RegIndex _reg, X86ISA::RegIndex _regm,
200 int _dataSize, int _addressSize, int _stackSize) :
201 reg(_reg), regm(_regm),
202 dataSize(_dataSize), addressSize(_addressSize),
203 stackSize(_stackSize)
204 {;}
205 };
206}};
207
192let {{
193 class EmulEnv(object):
194 def __init__(self):
195 self.reg = "0"
196 self.regUsed = False
197 self.regm = "0"
198 self.regmUsed = False
199 self.addressSize = "ADDRSIZE"
200 self.dataSize = "OPSIZE"
201 self.stackSize = "STACKSIZE"
202 self.doModRM = False
203
204 def getAllocator(self):
205 return '''EmulEnv(%(reg)s,
206 %(regm)s,
207 %(dataSize)s,
208 %(addressSize)s,
209 %(stackSize)s)''' % \
210 self.__dict__
211 def addReg(self, reg):
212 if not self.regUsed:
213 self.reg = reg
214 self.regUsed = True
215 elif not self.regmUsed:
216 self.regm = reg
217 self.regmUsed = True
218 else:
219 raise Exception, "EmulEnv is out of register specialization spots."
220}};
221
222let {{
223 doModRMString = "env.doModRM(machInst);\n"
224 def genMacroop(Name, env):
225 blocks = OutputBlocks()
226 if not macroopDict.has_key(Name):
227 raise Exception, "Unrecognized instruction: %s" % Name
228 macroop = macroopDict[Name]
229 if not macroop.declared:
230 if env.doModRM:
231 macroop.doModRM = doModRMString
232 blocks.header_output = macroop.getDeclaration()
233 blocks.decoder_output = macroop.getDefinition()
234 macroop.declared = True
235 blocks.decode_block = "return %s;\n" % macroop.getAllocator(env)
236 return blocks
237}};