src/arch/x86/isa/macroop.isa

   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.
  64 def 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
  72 output 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.
 121 def 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               private:
 130                 %(declareLabels)s
 131               public:
 132                 // Constructor.
 133                 %(class_name)s(ExtMachInst machInst, X86ISA::EmulEnv env);
 134             };
 135         };
 136 }};
 137
 138 // Basic instruction class constructor template.
 139 def template MacroConstructor {{
 140         inline X86Macroop::%(class_name)s::%(class_name)s(
 141                 ExtMachInst machInst, EmulEnv env)
 142             : %(base_class)s("%(mnemonic)s", machInst, %(num_microops)s)
 143         {
 144             %(adjust_env)s;
 145             %(adjust_imm)s;
 146             %(adjust_disp)s;
 147             %(do_modrm)s;
 148             %(constructor)s;
 149             //alloc_microops is the code that sets up the microops
 150             //array in the parent class.
 151             %(alloc_microops)s;
 152         }
 153 }};
 154
 155 let {{
 156     from micro_asm import Combinational_Macroop, Rom_Macroop
 157     class X86Macroop(Combinational_Macroop):
 158         def add_microop(self, mnemonic, microop):
 159             microop.mnemonic = mnemonic
 160             microop.micropc = len(self.microops)
 161             self.microops.append(microop)
 162         def setAdjustEnv(self, val):
 163             self.adjust_env = val
 164         def adjustImm(self, val):
 165             self.adjust_imm += val
 166         def adjustDisp(self, val):
 167             self.adjust_disp += val
 168         def __init__(self, name):
 169             super(X86Macroop, self).__init__(name)
 170             self.directives = {
 171                 "adjust_env" : self.setAdjustEnv,
 172                 "adjust_imm" : self.adjustImm,
 173                 "adjust_disp" : self.adjustDisp
 174             }
 175             self.declared = False
 176             self.adjust_env = ""
 177             self.doModRM = ""
 178             self.adjust_imm = '''
 179                 uint64_t adjustedImm = IMMEDIATE;
 180                 //This is to pacify gcc in case the immediate isn't used.
 181                 adjustedImm = adjustedImm;
 182             '''
 183             self.adjust_disp = '''
 184                 uint64_t adjustedDisp = DISPLACEMENT;
 185                 //This is to pacify gcc in case the displacement isn't used.
 186                 adjustedDisp = adjustedDisp;
 187             '''
 188         def getAllocator(self, env):
 189             return "new X86Macroop::%s(machInst, %s)" % (self.name, env.getAllocator())
 190         def getDeclaration(self):
 191             #FIXME This first parameter should be the mnemonic. I need to
 192             #write some code which pulls that out
 193             declareLabels = ""
 194             for (label, microop) in self.labels.items():
 195                 declareLabels += "const static uint64_t label_%s = %d;\n" \
 196                                   % (label, microop.micropc)
 197             iop = InstObjParams(self.name, self.name, "Macroop",
 198                     {"code" : "",
 199                      "declareLabels" : declareLabels
 200                     })
 201             return MacroDeclare.subst(iop);
 202         def getDefinition(self):
 203             #FIXME This first parameter should be the mnemonic. I need to
 204             #write some code which pulls that out
 205             numMicroops = len(self.microops)
 206             allocMicroops = ''
 207             micropc = 0
 208             for op in self.microops:
 209                 allocMicroops += \
 210                     "microops[%d] = %s;\n" % \
 211                     (micropc, op.getAllocator(True, False,
 212                                               micropc == 0,
 213                                               micropc == numMicroops - 1))
 214                 micropc += 1
 215             iop = InstObjParams(self.name, self.name, "Macroop",
 216                                 {"code" : "", "num_microops" : numMicroops,
 217                                  "alloc_microops" : allocMicroops,
 218                                  "adjust_env" : self.adjust_env,
 219                                  "adjust_imm" : self.adjust_imm,
 220                                  "adjust_disp" : self.adjust_disp,
 221                                  "do_modrm" : self.doModRM})
 222             return MacroConstructor.subst(iop);
 223 }};
 224
 225 let {{
 226     class EmulEnv(object):
 227         def __init__(self):
 228             self.reg = "0"
 229             self.regUsed = False
 230             self.regm = "0"
 231             self.regmUsed = False
 232             self.seg = "SEGMENT_REG_DS"
 233             self.size = None
 234             self.addressSize = "ADDRSIZE"
 235             self.dataSize = "OPSIZE"
 236             self.stackSize = "STACKSIZE"
 237             self.doModRM = False
 238
 239         def getAllocator(self):
 240             if self.size == 'b':
 241                 self.dataSize = 1
 242             elif self.size == 'd':
 243                 self.dataSize = 4
 244             #This is for "double plus" which is normally a double word unless
 245             #the REX W bit is set, in which case it's a quad word. It's used
 246             #for some SSE instructions.
 247             elif self.size == 'dp':
 248                 self.dataSize = "(REX_W ? 8 : 4)"
 249             elif self.size == 'q':
 250                 self.dataSize = 8
 251             elif self.size == 'v':
 252                 self.dataSize = "OPSIZE"
 253             elif self.size == 'w':
 254                 self.dataSize = 2
 255             elif self.size == 'z':
 256                 self.dataSize = "((OPSIZE == 8) ? 4 : OPSIZE)"
 257             elif self.size:
 258                 raise Exception, "Unrecognized size type %s!" % self.size
 259             return '''EmulEnv(%(reg)s,
 260                               %(regm)s,
 261                               %(dataSize)s,
 262                               %(addressSize)s,
 263                               %(stackSize)s)''' % \
 264                 self.__dict__
 265
 266         def addReg(self, reg):
 267             if not self.regUsed:
 268                 self.reg = reg
 269                 self.regUsed = True
 270             elif not self.regmUsed:
 271                 self.regm = reg
 272                 self.regmUsed = True
 273             else:
 274                 raise Exception, "EmulEnv is out of register specialization spots."
 275         def setSize(self, size):
 276             if not self.size:
 277                 self.size = size
 278             else:
 279                 if self.size != size:
 280                     raise Exception, "Conflicting register sizes %s and %s!" %\
 281                         (self.size, size)
 282 }};
 283
 284 let {{
 285     doModRMString = "env.doModRM(machInst);\n"
 286     def genMacroop(Name, env):
 287         blocks = OutputBlocks()
 288         if not macroopDict.has_key(Name):
 289             raise Exception, "Unrecognized instruction: %s" % Name
 290         macroop = macroopDict[Name]
 291         if not macroop.declared:
 292             if env.doModRM:
 293                 macroop.doModRM = doModRMString
 294             blocks.header_output = macroop.getDeclaration()
 295             blocks.decoder_output = macroop.getDefinition()
 296             macroop.declared = True
 297         blocks.decode_block = "return %s;\n" % macroop.getAllocator(env)
 298         return blocks
 299 }};