macroop.isa revision 7087:fb8d5786ff30
1// -*- mode:c++ -*- 2 3// Copyright (c) 2007 The Hewlett-Packard Development Company 4// All rights reserved. 5// 6// The license below extends only to copyright in the software and shall 7// not be construed as granting a license to any other intellectual 8// property including but not limited to intellectual property relating 9// to a hardware implementation of the functionality of the software 10// licensed hereunder. You may use the software subject to the license 11// terms below provided that you ensure that this notice is replicated 12// unmodified and in its entirety in all distributions of the software, 13// modified or unmodified, in source code or in binary form. 14// 15// Redistribution and use in source and binary forms, with or without 16// modification, are permitted provided that the following conditions are 17// met: redistributions of source code must retain the above copyright 18// notice, this list of conditions and the following disclaimer; 19// redistributions in binary form must reproduce the above copyright 20// notice, this list of conditions and the following disclaimer in the 21// documentation and/or other materials provided with the distribution; 22// neither the name of the copyright holders nor the names of its 23// contributors may be used to endorse or promote products derived from 24// this software without specific prior written permission. 25// 26// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 27// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 28// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 29// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 30// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 31// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 32// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 33// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 34// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 35// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 36// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 37// 38// Authors: Gabe Black 39 40////////////////////////////////////////////////////////////////////////////// 41// 42// Architecture independent 43// 44 45// Execute method for macroops. 46def template MacroExecPanic {{ 47 Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const 48 { 49 panic("Tried to execute macroop directly!"); 50 return NoFault; 51 } 52}}; 53 54output header {{ 55 56 // Base class for combinationally generated macroops 57 class Macroop : public X86ISA::MacroopBase 58 { 59 public: 60 Macroop(const char *mnem, ExtMachInst _machInst, 61 uint32_t _numMicroops, X86ISA::EmulEnv _env) 62 : MacroopBase(mnem, _machInst, _numMicroops, _env) 63 {} 64 %(MacroExecPanic)s 65 }; 66}}; 67 68////////////////////////////////////////////////////////////////////////////// 69// 70// X86 specific 71// 72////////////////////////////////////////////////////////////////////////////// 73 74// Basic instruction class declaration template. 75def template MacroDeclare {{ 76 namespace X86Macroop 77 { 78 /** 79 * Static instruction class for "%(mnemonic)s". 80 */ 81 class %(class_name)s : public %(base_class)s 82 { 83 private: 84 %(declareLabels)s 85 public: 86 // Constructor. 87 %(class_name)s(ExtMachInst machInst, X86ISA::EmulEnv _env); 88 89 std::string 90 generateDisassembly(Addr pc, const SymbolTable *symtab) const; 91 }; 92 }; 93}}; 94 95def template MacroDisassembly {{ 96 std::string 97 X86Macroop::%(class_name)s::generateDisassembly(Addr pc, 98 const SymbolTable *symtab) const 99 { 100 std::stringstream out; 101 out << mnemonic << "\t"; 102 103 int regSize = %(regSize)s; 104 %(disassembly)s 105 // Shut up gcc. 106 regSize = regSize; 107 return out.str(); 108 } 109}}; 110 111// Basic instruction class constructor template. 112def template MacroConstructor {{ 113 inline X86Macroop::%(class_name)s::%(class_name)s( 114 ExtMachInst machInst, EmulEnv _env) 115 : %(base_class)s("%(mnemonic)s", machInst, %(num_microops)s, _env) 116 { 117 %(adjust_env)s; 118 %(adjust_imm)s; 119 %(adjust_disp)s; 120 %(init_env)s; 121 %(constructor)s; 122 const char *macrocodeBlock = "%(class_name)s"; 123 //alloc_microops is the code that sets up the microops 124 //array in the parent class. 125 %(alloc_microops)s; 126 } 127}}; 128 129let {{ 130 from micro_asm import Combinational_Macroop, Rom_Macroop 131 class X86Macroop(Combinational_Macroop): 132 def add_microop(self, mnemonic, microop): 133 microop.mnemonic = mnemonic 134 microop.micropc = len(self.microops) 135 self.microops.append(microop) 136 def setAdjustEnv(self, val): 137 self.adjust_env = val 138 def adjustImm(self, val): 139 self.adjust_imm += val 140 def adjustDisp(self, val): 141 self.adjust_disp += val 142 def __init__(self, name): 143 super(X86Macroop, self).__init__(name) 144 self.directives = { 145 "adjust_env" : self.setAdjustEnv, 146 "adjust_imm" : self.adjustImm, 147 "adjust_disp" : self.adjustDisp 148 } 149 self.declared = False 150 self.adjust_env = "" 151 self.init_env = "" 152 self.adjust_imm = ''' 153 uint64_t adjustedImm = IMMEDIATE; 154 //This is to pacify gcc in case the immediate isn't used. 155 adjustedImm = adjustedImm; 156 ''' 157 self.adjust_disp = ''' 158 uint64_t adjustedDisp = DISPLACEMENT; 159 //This is to pacify gcc in case the displacement isn't used. 160 adjustedDisp = adjustedDisp; 161 ''' 162 def getAllocator(self, env): 163 return "new X86Macroop::%s(machInst, %s)" % \ 164 (self.name, env.getAllocator()) 165 def getMnemonic(self): 166 mnemonic = self.name.lower() 167 mnemonic = re.match(r'[^_]*', mnemonic).group(0) 168 return mnemonic 169 def getDeclaration(self): 170 #FIXME This first parameter should be the mnemonic. I need to 171 #write some code which pulls that out 172 declareLabels = "" 173 for (label, microop) in self.labels.items(): 174 declareLabels += "const static uint64_t label_%s = %d;\n" \ 175 % (label, microop.micropc) 176 iop = InstObjParams(self.getMnemonic(), self.name, "Macroop", 177 {"code" : "", 178 "declareLabels" : declareLabels 179 }) 180 return MacroDeclare.subst(iop); 181 def getDefinition(self, env): 182 #FIXME This first parameter should be the mnemonic. I need to 183 #write some code which pulls that out 184 numMicroops = len(self.microops) 185 allocMicroops = '' 186 micropc = 0 187 for op in self.microops: 188 isLast = (micropc == numMicroops - 1) 189 allocMicroops += \ 190 "microops[%d] = %s;\n" % \ 191 (micropc, op.getAllocator(True, not isLast, 192 micropc == 0, isLast)) 193 micropc += 1 194 if env.useStackSize: 195 useStackSize = "true" 196 else: 197 useStackSize = "false" 198 if env.memoryInst: 199 memoryInst = "true" 200 else: 201 memoryInst = "false" 202 regSize = '''(%s || (env.base == INTREG_RSP && %s) ? 203 env.stackSize : 204 env.dataSize)''' % (useStackSize, memoryInst) 205 iop = InstObjParams(self.getMnemonic(), self.name, "Macroop", 206 {"code" : "", "num_microops" : numMicroops, 207 "alloc_microops" : allocMicroops, 208 "adjust_env" : self.adjust_env, 209 "adjust_imm" : self.adjust_imm, 210 "adjust_disp" : self.adjust_disp, 211 "disassembly" : env.disassembly, 212 "regSize" : regSize, 213 "init_env" : self.initEnv}) 214 return MacroConstructor.subst(iop) + \ 215 MacroDisassembly.subst(iop); 216}}; 217 218let {{ 219 class EmulEnv(object): 220 def __init__(self): 221 self.reg = "0" 222 self.regUsed = False 223 self.regm = "0" 224 self.regmUsed = False 225 self.seg = "SEGMENT_REG_DS" 226 self.size = None 227 self.addressSize = "ADDRSIZE" 228 self.dataSize = "OPSIZE" 229 self.stackSize = "STACKSIZE" 230 self.doModRM = False 231 self.disassembly = "" 232 self.firstArgument = True 233 self.useStackSize = False 234 self.memoryInst = False 235 236 def addToDisassembly(self, code): 237 if not self.firstArgument: 238 self.disassembly += "out << \", \";\n" 239 self.firstArgument = False 240 self.disassembly += code 241 242 def getAllocator(self): 243 if self.size == 'b': 244 self.dataSize = 1 245 elif self.size == 'd': 246 self.dataSize = 4 247 #This is for "double plus" which is normally a double word unless 248 #the REX W bit is set, in which case it's a quad word. It's used 249 #for some SSE instructions. 250 elif self.size == 'dp': 251 self.dataSize = "(REX_W ? 8 : 4)" 252 elif self.size == 'q': 253 self.dataSize = 8 254 elif self.size == 'v': 255 self.dataSize = "OPSIZE" 256 elif self.size == 'w': 257 self.dataSize = 2 258 elif self.size == 'z': 259 self.dataSize = "((OPSIZE == 8) ? 4 : OPSIZE)" 260 elif self.size: 261 raise Exception, "Unrecognized size type %s!" % self.size 262 return '''EmulEnv(%(reg)s, 263 %(regm)s, 264 %(dataSize)s, 265 %(addressSize)s, 266 %(stackSize)s)''' % \ 267 self.__dict__ 268 269 def addReg(self, reg): 270 if not self.regUsed: 271 self.reg = reg 272 self.regUsed = True 273 elif not self.regmUsed: 274 self.regm = reg 275 self.regmUsed = True 276 else: 277 raise Exception, "EmulEnv is out of register specialization spots." 278 def setSize(self, size): 279 if not self.size: 280 self.size = size 281 else: 282 if self.size != size: 283 raise Exception, "Conflicting register sizes %s and %s!" %\ 284 (self.size, size) 285}}; 286 287let {{ 288 doModRMString = "env.doModRM(machInst);\n" 289 noModRMString = "env.setSeg(machInst);\n" 290 def genMacroop(Name, env): 291 blocks = OutputBlocks() 292 if not macroopDict.has_key(Name): 293 raise Exception, "Unrecognized instruction: %s" % Name 294 macroop = macroopDict[Name] 295 if not macroop.declared: 296 if env.doModRM: 297 macroop.initEnv = doModRMString 298 else: 299 macroop.initEnv = noModRMString 300 blocks.header_output = macroop.getDeclaration() 301 blocks.decoder_output = macroop.getDefinition(env) 302 macroop.declared = True 303 blocks.decode_block = "return %s;\n" % macroop.getAllocator(env) 304 return blocks 305}}; 306