specialize.isa revision 4865:4f4a7fe48b5b
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
64let {{
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
86let {{
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
107let {{
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            if not self.size:
118                self.size = match.group("rsize")
119
120    ModRMRegIndex = "(MODRM_REG | (REX_R << 3))"
121    ModRMRMIndex = "(MODRM_RM | (REX_B << 3))"
122    InstRegIndex = "(OPCODE_OP_BOTTOM3 | (REX_B << 3))"
123
124    # This function specializes the given piece of code to use a particular
125    # set of argument types described by "opTypes".
126    def specializeInst(Name, opTypes, env):
127        # print "Specializing %s with opTypes %s" % (Name, opTypes)
128        while len(opTypes):
129            # Parse the operand type string we're working with
130            opType = OpType(opTypes[0])
131            opTypes.pop(0)
132
133            if opType.tag not in ("I", "J"):
134                if opType.size:
135                    env.setSize(opType.size)
136
137            if opType.reg:
138                #Figure out what to do with fixed register operands
139                #This is the index to use, so we should stick it some place.
140                if opType.reg in ("A", "B", "C", "D"):
141                    env.addReg("INTREG_R%sX" % opType.reg)
142                else:
143                    env.addReg("INTREG_R%s" % opType.reg)
144                Name += "_R"
145            elif opType.tag == "B":
146                # This refers to registers whose index is encoded as part of the opcode
147                Name += "_R"
148                env.addReg(InstRegIndex)
149            elif opType.tag == "M":
150                # This refers to memory. The macroop constructor sets up modrm
151                # addressing. Non memory modrm settings should cause an error.
152                env.doModRM = True
153                return doRipRelativeDecode(Name, opTypes, env)
154            elif opType.tag == None or opType.size == None:
155                raise Exception, "Problem parsing operand tag: %s" % opType.tag
156            elif opType.tag in ("C", "D", "G", "P", "S", "T", "V"):
157                # Use the "reg" field of the ModRM byte to select the register
158                env.addReg(ModRMRegIndex)
159                Name += "_R"
160            elif opType.tag in ("E", "Q", "W"):
161                # This might refer to memory or to a register. We need to
162                # divide it up farther.
163                regEnv = copy.copy(env)
164                regEnv.addReg(ModRMRMIndex)
165                # This refers to memory. The macroop constructor should set up
166                # modrm addressing.
167                memEnv = copy.copy(env)
168                memEnv.doModRM = True
169                return doSplitDecode("MODRM_MOD",
170                    {"3" : (specializeInst, Name + "_R", copy.copy(opTypes), regEnv)},
171                           (doRipRelativeDecode, Name, copy.copy(opTypes), memEnv))
172            elif opType.tag in ("I", "J"):
173                # Immediates
174                Name += "_I"
175            elif opType.tag in ("PR", "R", "VR"):
176                # Non register modrm settings should cause an error
177                env.addReg(ModRMRMIndex)
178                Name += "_R"
179            else:
180                raise Exception, "Unrecognized tag %s." % opType.tag
181
182        # Generate code to return a macroop of the given name which will
183        # operate in the "emulation environment" env
184        return genMacroop(Name, env)
185}};
186