src/arch/x86/isa/specialize.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 //  Code to "specialize" a microcode sequence to use a particular
  61 //  variety of operands
  62 //
  63
  64 let {{
  65     # This code builds up a decode block which decodes based on switchval.
  66     # vals is a dict which matches case values with what should be decoded to.
  67     # Each element of the dict is a list containing a function and then the
  68     # arguments to pass to it.
  69     def doSplitDecode(switchVal, vals, default = None):
  70         blocks = OutputBlocks()
  71         blocks.decode_block = 'switch(%s) {\n' % switchVal
  72         for (val, todo) in vals.items():
  73             new_blocks = todo[0](*todo[1:])
  74             new_blocks.decode_block = \
  75                 '\tcase %s: %s\n' % (val, new_blocks.decode_block)
  76             blocks.append(new_blocks)
  77         if default:
  78             new_blocks = default[0](*default[1:])
  79             new_blocks.decode_block = \
  80                 '\tdefault: %s\n' % new_blocks.decode_block
  81             blocks.append(new_blocks)
  82         blocks.decode_block += '}\n'
  83         return blocks
  84 }};
  85
  86 let {{
  87     def doRipRelativeDecode(Name, opTypes, env):
  88         # print "RIPing %s with opTypes %s" % (Name, opTypes)
  89         normBlocks = specializeInst(Name + "_M", copy.copy(opTypes), copy.copy(env))
  90         ripBlocks = specializeInst(Name + "_P", copy.copy(opTypes), copy.copy(env))
  91
  92         blocks = OutputBlocks()
  93         blocks.append(normBlocks)
  94         blocks.append(ripBlocks)
  95
  96         blocks.decode_block = '''
  97         if(machInst.modRM.mod == 0 &&
  98           machInst.modRM.rm == 5 &&
  99           machInst.mode.submode == SixtyFourBitMode)
 100         { %s }
 101         else
 102         { %s }''' % \
 103          (ripBlocks.decode_block, normBlocks.decode_block)
 104         return blocks
 105 }};
 106
 107 let {{
 108     class OpType(object):
 109         parser = re.compile(r"(?P<tag>[A-Z]+)(?P<size>[a-z]*)|(r(?P<reg>[A-Z0-9]+)(?P<rsize>[a-z]*))")
 110         def __init__(self, opTypeString):
 111             match = OpType.parser.search(opTypeString)
 112             if match == None:
 113                 raise Exception, "Problem parsing operand type %s" % opTypeString
 114             self.reg = match.group("reg")
 115             self.tag = match.group("tag")
 116             self.size = match.group("size")
 117             self.rsize = match.group("rsize")
 118
 119     ModRMRegIndex = "(MODRM_REG | (REX_R << 3))"
 120     ModRMRMIndex = "(MODRM_RM | (REX_B << 3))"
 121     InstRegIndex = "(OPCODE_OP_BOTTOM3 | (REX_B << 3))"
 122
 123     # This function specializes the given piece of code to use a particular
 124     # set of argument types described by "opTypes".
 125     def specializeInst(Name, opTypes, env):
 126         # print "Specializing %s with opTypes %s" % (Name, opTypes)
 127         while len(opTypes):
 128             # Parse the operand type string we're working with
 129             opType = OpType(opTypes[0])
 130             opTypes.pop(0)
 131
 132             if opType.reg:
 133                 #Figure out what to do with fixed register operands
 134                 #This is the index to use, so we should stick it some place.
 135                 if opType.reg in ("A", "B", "C", "D"):
 136                     env.addReg("INTREG_R%sX | (REX_B << 3)" % opType.reg)
 137                 else:
 138                     env.addReg("INTREG_R%s | (REX_B << 3)" % opType.reg)
 139                 if opType.size:
 140                     if opType.rsize in ("l", "h", "b"):
 141                         print "byte"
 142                     elif opType.rsize == "x":
 143                         print "word"
 144                     else:
 145                         print "Didn't recognize fixed register size %s!" % opType.rsize
 146                 Name += "_R"
 147             elif opType.tag == "B":
 148                 # This refers to registers whose index is encoded as part of the opcode
 149                 Name += "_R"
 150                 env.addReg(InstRegIndex)
 151             elif opType.tag == "M":
 152                 # This refers to memory. The macroop constructor sets up modrm
 153                 # addressing. Non memory modrm settings should cause an error.
 154                 Name += "_M"
 155                 env.doModRM = True
 156             elif opType.tag == None or opType.size == None:
 157                 raise Exception, "Problem parsing operand tag: %s" % opType.tag
 158             elif opType.tag in ("C", "D", "G", "P", "S", "T", "V"):
 159                 # Use the "reg" field of the ModRM byte to select the register
 160                 env.addReg(ModRMRegIndex)
 161                 Name += "_R"
 162             elif opType.tag in ("E", "Q", "W"):
 163                 # This might refer to memory or to a register. We need to
 164                 # divide it up farther.
 165                 regEnv = copy.copy(env)
 166                 regEnv.addReg(ModRMRMIndex)
 167                 # This refers to memory. The macroop constructor should set up
 168                 # modrm addressing.
 169                 memEnv = copy.copy(env)
 170                 memEnv.doModRM = True
 171                 return doSplitDecode("MODRM_MOD",
 172                     {"3" : (specializeInst, Name + "_R", copy.copy(opTypes), regEnv)},
 173                            (doRipRelativeDecode, Name, copy.copy(opTypes), memEnv))
 174             elif opType.tag in ("I", "J"):
 175                 # Immediates
 176                 Name += "_I"
 177             elif opType.tag in ("PR", "R", "VR"):
 178                 # Non register modrm settings should cause an error
 179                 env.addReg(ModRMRMIndex)
 180                 Name += "_R"
 181             else:
 182                 raise Exception, "Unrecognized tag %s." % opType.tag
 183
 184         # Generate code to return a macroop of the given name which will
 185         # operate in the "emulation environment" env
 186         return genMacroop(Name, env)
 187 }};