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     # builder is called on the exploded contents of "vals" values to generate
  68     # whatever code should be used.
  69     def doSplitDecode(Name, builder, 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 = builder(Name, *todo)
  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 = builder(Name, *default)
  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     class OpType(object):
  88         parser = re.compile(r"(?P<tag>[A-Z][A-Z]*)(?P<size>[a-z][a-z]*)|(r(?P<reg>[A-Z0-9])(?P<rsize>[a-z]*))")
  89         def __init__(self, opTypeString):
  90             match = OpType.parser.search(opTypeString)
  91             if match == None:
  92                 raise Exception, "Problem parsing operand type %s" % opTypeString
  93             self.reg = match.group("reg")
  94             self.tag = match.group("tag")
  95             self.size = match.group("size")
  96             self.rsize = match.group("rsize")
  97
  98     ModRMRegIndex = "(MODRM_REG | (REX_R << 3))"
  99     ModRMRMIndex = "(MODRM_RM | (REX_B << 3))"
 100
 101     # This function specializes the given piece of code to use a particular
 102     # set of argument types described by "opTypes".
 103     def specializeInst(Name, opTypes, env):
 104         print "Specializing %s with opTypes %s" % (Name, opTypes)
 105         while len(opTypes):
 106             # Parse the operand type string we're working with
 107             opType = OpType(opTypes[0])
 108
 109             if opType.reg:
 110                 #Figure out what to do with fixed register operands
 111                 #This is the index to use, so we should stick it some place.
 112                 if opType.reg in ("A", "B", "C", "D"):
 113                     env.addReg("INTREG_R%sX" % opType.reg)
 114                 else:
 115                     env.addReg("INTREG_R%s" % opType.reg)
 116                 if opType.size:
 117                     if opType.rsize in ("l", "h", "b"):
 118                         print "byte"
 119                     elif opType.rsize == "x":
 120                         print "word"
 121                     else:
 122                         print "Didn't recognize fixed register size %s!" % opType.rsize
 123             elif opType.tag == None or opType.size == None:
 124                 raise Exception, "Problem parsing operand tag: %s" % opType.tag
 125             elif opType.tag in ("C", "D", "G", "P", "S", "T", "V"):
 126                 # Use the "reg" field of the ModRM byte to select the register
 127                 env.addReg(ModRMRegIndex)
 128             elif opType.tag in ("E", "Q", "W"):
 129                 # This might refer to memory or to a register. We need to
 130                 # divide it up farther.
 131                 regTypes = copy.copy(opTypes)
 132                 regTypes.pop(0)
 133                 regEnv = copy.copy(env)
 134                 regEnv.addReg(ModRMRMIndex)
 135                 # This needs to refer to memory, but we'll fill in the details
 136                 # later. It needs to take into account unaligned memory
 137                 # addresses.
 138                 memTypes = copy.copy(opTypes)
 139                 memTypes.pop(0)
 140                 memEnv = copy.copy(env)
 141                 print "%0"
 142                 return doSplitDecode(Name, specializeInst, "MODRM_MOD",
 143                     {"3" : (regTypes, regEnv)}, (memTypes, memEnv))
 144             elif opType.tag in ("I", "J"):
 145                 # Immediates
 146                 print "IMMEDIATE"
 147             elif opType.tag == "M":
 148                 # This needs to refer to memory, but we'll fill in the details
 149                 # later. It needs to take into account unaligned memory
 150                 # addresses.
 151                 print "%0"
 152             elif opType.tag in ("PR", "R", "VR"):
 153                 # There should probably be a check here to verify that mod
 154                 # is equal to 11b
 155                 env.addReg(ModRMRMIndex)
 156             else:
 157                 raise Exception, "Unrecognized tag %s." % opType.tag
 158             opTypes.pop(0)
 159
 160         # Generate code to return a macroop of the given name which will
 161         # operate in the "emulation environment" env
 162         return genMacroop(Name, env)
 163 }};