macroop.isa revision 12236:126ac9da6050
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(ExecContext *, 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
65            Fault
66            execute(ExecContext *, Trace::InstRecord *) const
67            {
68                panic("Tried to execute macroop directly!");
69            }
70        };
71}};
72
73//////////////////////////////////////////////////////////////////////////////
74//
75//  X86 specific
76//
77//////////////////////////////////////////////////////////////////////////////
78
79// Basic instruction class declaration template.
80def template MacroDeclare {{
81        namespace X86Macroop
82        {
83            /**
84             * Static instruction class for "%(mnemonic)s".
85             */
86            class %(class_name)s : public %(base_class)s
87            {
88              private:
89                %(declareLabels)s
90              public:
91                // Constructor.
92                %(class_name)s(ExtMachInst machInst, X86ISA::EmulEnv _env);
93
94                std::string
95                generateDisassembly(Addr pc, const SymbolTable *symtab) const;
96            };
97        }
98}};
99
100def template MacroDisassembly {{
101    std::string
102    X86Macroop::%(class_name)s::generateDisassembly(Addr pc,
103            const SymbolTable *symtab) const
104    {
105        std::stringstream out;
106        out << mnemonic << "\t";
107
108        int regSize = %(regSize)s;
109        %(disassembly)s
110        // Shut up gcc.
111        regSize = regSize;
112        return out.str();
113    }
114}};
115
116// Basic instruction class constructor template.
117def template MacroConstructor {{
118        X86Macroop::%(class_name)s::%(class_name)s(
119                ExtMachInst machInst, EmulEnv _env)
120            : %(base_class)s("%(mnemonic)s", machInst, %(num_microops)s, _env)
121        {
122            %(adjust_env)s;
123            %(adjust_imm)s;
124            %(adjust_disp)s;
125            %(init_env)s;
126            %(constructor)s;
127            const char *macrocodeBlock = "%(class_name)s";
128            //alloc_microops is the code that sets up the microops
129            //array in the parent class.
130            %(alloc_microops)s;
131        }
132}};
133
134let {{
135    from micro_asm import Combinational_Macroop, Rom_Macroop
136    class X86Macroop(Combinational_Macroop):
137        def add_microop(self, mnemonic, microop):
138            microop.mnemonic = mnemonic
139            microop.micropc = len(self.microops)
140            self.microops.append(microop)
141        def setAdjustEnv(self, val):
142            self.adjust_env = val
143        def adjustImm(self, val):
144            self.adjust_imm += val
145        def adjustDisp(self, val):
146            self.adjust_disp += val
147        def serializing(self):
148            self.serializing = True
149
150        def function_call(self):
151            self.function_call = True
152        def function_return(self):
153            self.function_return = True
154
155        def __init__(self, name):
156            super(X86Macroop, self).__init__(name)
157            self.directives = {
158                "adjust_env" : self.setAdjustEnv,
159                "adjust_imm" : self.adjustImm,
160                "adjust_disp" : self.adjustDisp,
161                "serializing" : self.serializing,
162                "function_call" : self.function_call,
163                "function_return" : self.function_return
164            }
165            self.declared = False
166            self.adjust_env = ""
167            self.init_env = ""
168            self.adjust_imm = '''
169                uint64_t adjustedImm = IMMEDIATE;
170                //This is to pacify gcc in case the immediate isn't used.
171                adjustedImm = adjustedImm;
172            '''
173            self.adjust_disp = '''
174                uint64_t adjustedDisp = DISPLACEMENT;
175                //This is to pacify gcc in case the displacement isn't used.
176                adjustedDisp = adjustedDisp;
177            '''
178            self.serializing = False
179            self.function_call = False
180            self.function_return = False
181
182        def getAllocator(self, env):
183            return "new X86Macroop::%s(machInst, %s)" % \
184                    (self.name, env.getAllocator())
185        def getMnemonic(self):
186            mnemonic = self.name.lower()
187            mnemonic = re.match(r'[^_]*', mnemonic).group(0)
188            return mnemonic
189        def getDeclaration(self):
190            #FIXME This first parameter should be the mnemonic. I need to
191            #write some code which pulls that out
192            declareLabels = ""
193            for (label, microop) in self.labels.items():
194                declareLabels += "const static uint64_t label_%s = %d;\n" \
195                                  % (label, microop.micropc)
196            iop = InstObjParams(self.getMnemonic(), self.name, "Macroop",
197                    {"code" : "",
198                     "declareLabels" : declareLabels
199                    })
200            return MacroDeclare.subst(iop);
201        def getDefinition(self, env):
202            #FIXME This first parameter should be the mnemonic. I need to
203            #write some code which pulls that out
204            numMicroops = len(self.microops)
205            allocMicroops = ''
206            micropc = 0
207            for op in self.microops:
208                flags = ["IsMicroop"]
209                if micropc == numMicroops - 1:
210                    flags.append("IsLastMicroop")
211
212                    if self.serializing:
213                        flags.append("IsSerializing")
214                        flags.append("IsSerializeAfter")
215
216                    if self.function_call:
217                        flags.append("IsCall")
218                    if self.function_return:
219                        flags.append("IsReturn")
220                else:
221                    flags.append("IsDelayedCommit")
222                if micropc == 0:
223                    flags.append("IsFirstMicroop")
224                allocMicroops += \
225                    "microops[%d] = %s;\n" % \
226                    (micropc, op.getAllocator(flags))
227                micropc += 1
228            if env.useStackSize:
229                useStackSize = "true"
230            else:
231                useStackSize = "false"
232            if env.memoryInst:
233                memoryInst = "true"
234            else:
235                memoryInst = "false"
236            regSize = '''(%s || (env.base == INTREG_RSP && %s) ?
237                         env.stackSize :
238                         env.dataSize)''' % (useStackSize, memoryInst)
239            iop = InstObjParams(self.getMnemonic(), self.name, "Macroop",
240                                {"code" : "", "num_microops" : numMicroops,
241                                 "alloc_microops" : allocMicroops,
242                                 "adjust_env" : self.adjust_env,
243                                 "adjust_imm" : self.adjust_imm,
244                                 "adjust_disp" : self.adjust_disp,
245                                 "disassembly" : env.disassembly,
246                                 "regSize" : regSize,
247                                 "init_env" : self.initEnv})
248            return MacroConstructor.subst(iop) + \
249                   MacroDisassembly.subst(iop);
250}};
251
252let {{
253    class EmulEnv(object):
254        def __init__(self):
255            self.reg = "0"
256            self.regUsed = False
257            self.regm = "0"
258            self.regmUsed = False
259            self.seg = "SEGMENT_REG_DS"
260            self.size = None
261            self.addressSize = "ADDRSIZE"
262            self.dataSize = "OPSIZE"
263            self.stackSize = "STACKSIZE"
264            self.doModRM = False
265            self.disassembly = ""
266            self.firstArgument = True
267            self.useStackSize = False
268            self.memoryInst = False
269
270        def addToDisassembly(self, code):
271            if not self.firstArgument:
272                self.disassembly += "out << \", \";\n"
273            self.firstArgument = False
274            self.disassembly += code
275
276        def getAllocator(self):
277            if self.size == 'b':
278                self.dataSize = 1
279            elif self.size == 'd':
280                self.dataSize = 4
281            #This is for "double plus" which is normally a double word unless
282            #the REX W bit is set, in which case it's a quad word. It's used
283            #for some SSE instructions.
284            elif self.size == 'dp':
285                self.dataSize = "(REX_W ? 8 : 4)"
286            elif self.size == 'q':
287                self.dataSize = 8
288            elif self.size == 'v':
289                self.dataSize = "OPSIZE"
290            elif self.size == 'w':
291                self.dataSize = 2
292            elif self.size == 'z':
293                self.dataSize = "((OPSIZE == 8) ? 4 : OPSIZE)"
294            elif self.size:
295                raise Exception, "Unrecognized size type %s!" % self.size
296            return '''EmulEnv(%(reg)s,
297                              %(regm)s,
298                              %(dataSize)s,
299                              %(addressSize)s,
300                              %(stackSize)s)''' % \
301                self.__dict__
302
303        def addReg(self, reg):
304            if not self.regUsed:
305                self.reg = reg
306                self.regUsed = True
307            elif not self.regmUsed:
308                self.regm = reg
309                self.regmUsed = True
310            else:
311                raise Exception, "EmulEnv is out of register specialization spots."
312        def setSize(self, size):
313            if not self.size:
314                self.size = size
315            else:
316                if self.size != size:
317                    raise Exception, "Conflicting register sizes %s and %s!" %\
318                        (self.size, size)
319}};
320
321let {{
322    doModRMString = "env.doModRM(machInst);\n"
323    noModRMString = "env.setSeg(machInst);\n"
324    def genMacroop(Name, env):
325        blocks = OutputBlocks()
326        if not macroopDict.has_key(Name):
327            raise Exception, "Unrecognized instruction: %s" % Name
328        macroop = macroopDict[Name]
329        if not macroop.declared:
330            if env.doModRM:
331                macroop.initEnv = doModRMString
332            else:
333                macroop.initEnv = noModRMString
334            blocks.header_output = macroop.getDeclaration()
335            blocks.decoder_output = macroop.getDefinition(env)
336            macroop.declared = True
337        blocks.decode_block = "return %s;\n" % macroop.getAllocator(env)
338        return blocks
339}};
340