2007-04-03 17:01:09 +02:00
|
|
|
// -*- mode:c++ -*-
|
|
|
|
|
|
|
|
// Copyright (c) 2007 The Hewlett-Packard Development Company
|
|
|
|
// All rights reserved.
|
|
|
|
//
|
|
|
|
// Redistribution and use of this software in source and binary forms,
|
|
|
|
// with or without modification, are permitted provided that the
|
|
|
|
// following conditions are met:
|
|
|
|
//
|
|
|
|
// The software must be used only for Non-Commercial Use which means any
|
|
|
|
// use which is NOT directed to receiving any direct monetary
|
|
|
|
// compensation for, or commercial advantage from such use. Illustrative
|
|
|
|
// examples of non-commercial use are academic research, personal study,
|
|
|
|
// teaching, education and corporate research & development.
|
|
|
|
// Illustrative examples of commercial use are distributing products for
|
|
|
|
// commercial advantage and providing services using the software for
|
|
|
|
// commercial advantage.
|
|
|
|
//
|
|
|
|
// If you wish to use this software or functionality therein that may be
|
|
|
|
// covered by patents for commercial use, please contact:
|
|
|
|
// Director of Intellectual Property Licensing
|
|
|
|
// Office of Strategy and Technology
|
|
|
|
// Hewlett-Packard Company
|
|
|
|
// 1501 Page Mill Road
|
|
|
|
// Palo Alto, California 94304
|
|
|
|
//
|
|
|
|
// Redistributions of source code must retain the above copyright notice,
|
|
|
|
// this list of conditions and the following disclaimer. Redistributions
|
|
|
|
// in binary form must reproduce the above copyright notice, this list of
|
|
|
|
// conditions and the following disclaimer in the documentation and/or
|
|
|
|
// other materials provided with the distribution. Neither the name of
|
|
|
|
// the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
|
|
|
|
// contributors may be used to endorse or promote products derived from
|
|
|
|
// this software without specific prior written permission. No right of
|
|
|
|
// sublicense is granted herewith. Derivatives of the software and
|
|
|
|
// output created using the software may be prepared, but only for
|
|
|
|
// Non-Commercial Uses. Derivatives of the software may be shared with
|
|
|
|
// others provided: (i) the others agree to abide by the list of
|
|
|
|
// conditions herein which includes the Non-Commercial Use restrictions;
|
|
|
|
// and (ii) such Derivatives of the software include the above copyright
|
|
|
|
// notice to acknowledge the contribution from this software where
|
|
|
|
// applicable, this list of conditions and the disclaimer below.
|
|
|
|
//
|
|
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
|
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
|
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
//
|
|
|
|
// Authors: Gabe Black
|
|
|
|
|
2007-04-10 19:25:15 +02:00
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
//
|
|
|
|
// Architecture independent
|
|
|
|
//
|
|
|
|
|
2007-04-06 18:00:56 +02:00
|
|
|
// Execute method for macroops.
|
|
|
|
def template MacroExecPanic {{
|
|
|
|
Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const
|
|
|
|
{
|
|
|
|
panic("Tried to execute macroop directly!");
|
2007-04-10 19:25:15 +02:00
|
|
|
return NoFault;
|
2007-04-06 18:00:56 +02:00
|
|
|
}
|
|
|
|
}};
|
2007-04-03 17:01:09 +02:00
|
|
|
|
|
|
|
output header {{
|
|
|
|
|
2007-06-08 18:09:43 +02:00
|
|
|
// Base class for combinationally generated macroops
|
2007-06-12 18:21:47 +02:00
|
|
|
class Macroop : public StaticInst
|
2007-04-03 17:01:09 +02:00
|
|
|
{
|
|
|
|
protected:
|
2007-06-12 18:21:47 +02:00
|
|
|
const uint32_t numMicroops;
|
2007-04-03 17:01:09 +02:00
|
|
|
|
|
|
|
//Constructor.
|
2007-06-12 18:21:47 +02:00
|
|
|
Macroop(const char *mnem, ExtMachInst _machInst,
|
|
|
|
uint32_t _numMicroops)
|
2007-04-06 18:00:56 +02:00
|
|
|
: StaticInst(mnem, _machInst, No_OpClass),
|
2007-06-12 18:21:47 +02:00
|
|
|
numMicroops(_numMicroops)
|
2007-04-03 17:01:09 +02:00
|
|
|
{
|
2007-06-12 18:21:47 +02:00
|
|
|
assert(numMicroops);
|
|
|
|
microops = new StaticInstPtr[numMicroops];
|
|
|
|
flags[IsMacroop] = true;
|
2007-04-03 17:01:09 +02:00
|
|
|
}
|
|
|
|
|
2007-06-12 18:21:47 +02:00
|
|
|
~Macroop()
|
2007-04-03 17:01:09 +02:00
|
|
|
{
|
2007-06-12 18:21:47 +02:00
|
|
|
delete [] microops;
|
2007-04-03 17:01:09 +02:00
|
|
|
}
|
|
|
|
|
2007-06-12 18:21:47 +02:00
|
|
|
StaticInstPtr * microops;
|
2007-04-03 17:01:09 +02:00
|
|
|
|
2007-06-12 18:21:47 +02:00
|
|
|
StaticInstPtr fetchMicroop(MicroPC microPC)
|
2007-04-03 17:01:09 +02:00
|
|
|
{
|
2007-06-12 18:21:47 +02:00
|
|
|
assert(microPC < numMicroops);
|
|
|
|
return microops[microPC];
|
2007-04-03 17:01:09 +02:00
|
|
|
}
|
|
|
|
|
2007-04-10 19:25:15 +02:00
|
|
|
std::string generateDisassembly(Addr pc,
|
|
|
|
const SymbolTable *symtab) const
|
|
|
|
{
|
|
|
|
return mnemonic;
|
|
|
|
}
|
|
|
|
|
2007-04-06 18:00:56 +02:00
|
|
|
%(MacroExecPanic)s
|
2007-04-03 17:01:09 +02:00
|
|
|
};
|
|
|
|
}};
|
|
|
|
|
2007-06-20 17:02:50 +02:00
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
//
|
|
|
|
// X86 specific
|
|
|
|
//
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
2007-04-10 19:25:15 +02:00
|
|
|
// Basic instruction class declaration template.
|
|
|
|
def template MacroDeclare {{
|
2007-06-12 18:21:47 +02:00
|
|
|
namespace X86Macroop
|
2007-04-10 19:25:15 +02:00
|
|
|
{
|
2007-06-08 18:09:43 +02:00
|
|
|
/**
|
|
|
|
* Static instruction class for "%(mnemonic)s".
|
|
|
|
*/
|
|
|
|
class %(class_name)s : public %(base_class)s
|
|
|
|
{
|
2007-08-27 05:39:55 +02:00
|
|
|
private:
|
|
|
|
%(declareLabels)s
|
2007-06-08 18:09:43 +02:00
|
|
|
public:
|
|
|
|
// Constructor.
|
2007-06-20 17:02:50 +02:00
|
|
|
%(class_name)s(ExtMachInst machInst, X86ISA::EmulEnv env);
|
2007-06-08 18:09:43 +02:00
|
|
|
};
|
2007-04-10 19:25:15 +02:00
|
|
|
};
|
|
|
|
}};
|
|
|
|
|
2007-04-03 17:01:09 +02:00
|
|
|
// Basic instruction class constructor template.
|
|
|
|
def template MacroConstructor {{
|
2007-06-20 17:02:50 +02:00
|
|
|
inline X86Macroop::%(class_name)s::%(class_name)s(
|
|
|
|
ExtMachInst machInst, EmulEnv env)
|
2007-06-12 18:21:47 +02:00
|
|
|
: %(base_class)s("%(mnemonic)s", machInst, %(num_microops)s)
|
2007-04-03 17:01:09 +02:00
|
|
|
{
|
2007-06-14 15:47:52 +02:00
|
|
|
%(adjust_env)s;
|
2007-06-20 17:02:50 +02:00
|
|
|
%(do_modrm)s;
|
2007-06-14 15:47:52 +02:00
|
|
|
%(constructor)s;
|
|
|
|
//alloc_microops is the code that sets up the microops
|
|
|
|
//array in the parent class.
|
|
|
|
%(alloc_microops)s;
|
2007-04-03 17:01:09 +02:00
|
|
|
}
|
|
|
|
}};
|
|
|
|
|
|
|
|
let {{
|
2007-06-08 18:09:43 +02:00
|
|
|
from micro_asm import Combinational_Macroop, Rom_Macroop
|
|
|
|
class X86Macroop(Combinational_Macroop):
|
2007-09-01 07:28:07 +02:00
|
|
|
def add_microop(self, mnemonic, microop):
|
|
|
|
microop.mnemonic = mnemonic
|
2007-08-27 05:39:55 +02:00
|
|
|
microop.micropc = len(self.microops)
|
|
|
|
self.microops.append(microop)
|
2007-06-14 15:47:52 +02:00
|
|
|
def setAdjustEnv(self, val):
|
|
|
|
self.adjust_env = val
|
2007-06-08 18:09:43 +02:00
|
|
|
def __init__(self, name):
|
|
|
|
super(X86Macroop, self).__init__(name)
|
|
|
|
self.directives = {
|
2007-06-14 15:47:52 +02:00
|
|
|
"adjust_env" : self.setAdjustEnv
|
2007-06-08 18:09:43 +02:00
|
|
|
}
|
|
|
|
self.declared = False
|
2007-06-14 15:47:52 +02:00
|
|
|
self.adjust_env = ""
|
2007-06-20 17:02:50 +02:00
|
|
|
self.doModRM = ""
|
2007-06-08 18:09:43 +02:00
|
|
|
def getAllocator(self, env):
|
2007-06-12 18:21:47 +02:00
|
|
|
return "new X86Macroop::%s(machInst, %s)" % (self.name, env.getAllocator())
|
2007-06-08 18:09:43 +02:00
|
|
|
def getDeclaration(self):
|
|
|
|
#FIXME This first parameter should be the mnemonic. I need to
|
|
|
|
#write some code which pulls that out
|
2007-08-27 05:39:55 +02:00
|
|
|
declareLabels = ""
|
|
|
|
for (label, microop) in self.labels.items():
|
|
|
|
declareLabels += "const static uint64_t label_%s = %d;\n" \
|
|
|
|
% (label, microop.micropc)
|
|
|
|
iop = InstObjParams(self.name, self.name, "Macroop",
|
|
|
|
{"code" : "",
|
|
|
|
"declareLabels" : declareLabels
|
|
|
|
})
|
2007-06-08 18:09:43 +02:00
|
|
|
return MacroDeclare.subst(iop);
|
|
|
|
def getDefinition(self):
|
|
|
|
#FIXME This first parameter should be the mnemonic. I need to
|
|
|
|
#write some code which pulls that out
|
|
|
|
numMicroops = len(self.microops)
|
|
|
|
allocMicroops = ''
|
|
|
|
micropc = 0
|
|
|
|
for op in self.microops:
|
|
|
|
allocMicroops += \
|
2007-06-12 18:21:47 +02:00
|
|
|
"microops[%d] = %s;\n" % \
|
2007-06-08 18:09:43 +02:00
|
|
|
(micropc, op.getAllocator(True, False,
|
|
|
|
micropc == 0,
|
|
|
|
micropc == numMicroops - 1))
|
|
|
|
micropc += 1
|
|
|
|
iop = InstObjParams(self.name, self.name, "Macroop",
|
2007-06-12 18:21:47 +02:00
|
|
|
{"code" : "", "num_microops" : numMicroops,
|
2007-06-14 15:47:52 +02:00
|
|
|
"alloc_microops" : allocMicroops,
|
2007-06-20 17:02:50 +02:00
|
|
|
"adjust_env" : self.adjust_env,
|
|
|
|
"do_modrm" : self.doModRM})
|
2007-06-08 18:09:43 +02:00
|
|
|
return MacroConstructor.subst(iop);
|
|
|
|
}};
|
|
|
|
|
|
|
|
let {{
|
|
|
|
class EmulEnv(object):
|
|
|
|
def __init__(self):
|
2007-06-12 18:21:47 +02:00
|
|
|
self.reg = "0"
|
|
|
|
self.regUsed = False
|
|
|
|
self.regm = "0"
|
|
|
|
self.regmUsed = False
|
2007-08-05 05:12:54 +02:00
|
|
|
self.seg = "SEGMENT_REG_DS"
|
2007-07-23 03:07:49 +02:00
|
|
|
self.size = None
|
2007-06-08 18:09:43 +02:00
|
|
|
self.addressSize = "ADDRSIZE"
|
|
|
|
self.dataSize = "OPSIZE"
|
2007-06-19 16:18:25 +02:00
|
|
|
self.stackSize = "STACKSIZE"
|
2007-06-20 17:02:50 +02:00
|
|
|
self.doModRM = False
|
|
|
|
|
2007-06-08 18:09:43 +02:00
|
|
|
def getAllocator(self):
|
2007-07-23 03:07:49 +02:00
|
|
|
if self.size == 'b':
|
|
|
|
self.dataSize = 1
|
|
|
|
elif self.size == 'd':
|
|
|
|
self.dataSize = 4
|
2007-09-05 08:32:18 +02:00
|
|
|
#This is for "double plus" which is normally a double word unless
|
|
|
|
#the REX W bit is set, in which case it's a quad word. It's used
|
|
|
|
#for some SSE instructions.
|
|
|
|
elif self.size == 'dp':
|
|
|
|
self.dataSize = "(REX_W ? 8 : 4)"
|
2007-07-23 03:07:49 +02:00
|
|
|
elif self.size == 'q':
|
|
|
|
self.dataSize = 8
|
|
|
|
elif self.size == 'v':
|
|
|
|
self.dataSize = "OPSIZE"
|
|
|
|
elif self.size == 'w':
|
|
|
|
self.dataSize = 2
|
|
|
|
elif self.size == 'z':
|
|
|
|
self.dataSize = "((OPSIZE == 8) ? 4 : OPSIZE)"
|
|
|
|
elif self.size:
|
|
|
|
raise Exception, "Unrecognized size type %s!" % self.size
|
2007-06-12 18:21:47 +02:00
|
|
|
return '''EmulEnv(%(reg)s,
|
|
|
|
%(regm)s,
|
2007-06-19 16:18:25 +02:00
|
|
|
%(dataSize)s,
|
2007-06-12 18:21:47 +02:00
|
|
|
%(addressSize)s,
|
2007-06-19 16:18:25 +02:00
|
|
|
%(stackSize)s)''' % \
|
2007-06-12 18:21:47 +02:00
|
|
|
self.__dict__
|
2007-07-23 03:07:49 +02:00
|
|
|
|
2007-06-12 18:21:47 +02:00
|
|
|
def addReg(self, reg):
|
|
|
|
if not self.regUsed:
|
|
|
|
self.reg = reg
|
|
|
|
self.regUsed = True
|
|
|
|
elif not self.regmUsed:
|
|
|
|
self.regm = reg
|
|
|
|
self.regmUsed = True
|
|
|
|
else:
|
|
|
|
raise Exception, "EmulEnv is out of register specialization spots."
|
2007-07-23 03:07:49 +02:00
|
|
|
def setSize(self, size):
|
|
|
|
if not self.size:
|
|
|
|
self.size = size
|
|
|
|
else:
|
2007-09-05 08:32:18 +02:00
|
|
|
if self.size != size:
|
2007-07-23 03:07:49 +02:00
|
|
|
raise Exception, "Conflicting register sizes %s and %s!" %\
|
|
|
|
(self.size, size)
|
2007-06-08 18:09:43 +02:00
|
|
|
}};
|
|
|
|
|
|
|
|
let {{
|
2007-06-20 17:02:50 +02:00
|
|
|
doModRMString = "env.doModRM(machInst);\n"
|
2007-06-08 18:09:43 +02:00
|
|
|
def genMacroop(Name, env):
|
2007-06-12 18:21:47 +02:00
|
|
|
blocks = OutputBlocks()
|
2007-06-08 18:09:43 +02:00
|
|
|
if not macroopDict.has_key(Name):
|
|
|
|
raise Exception, "Unrecognized instruction: %s" % Name
|
|
|
|
macroop = macroopDict[Name]
|
|
|
|
if not macroop.declared:
|
2007-06-20 17:02:50 +02:00
|
|
|
if env.doModRM:
|
|
|
|
macroop.doModRM = doModRMString
|
2007-06-12 18:21:47 +02:00
|
|
|
blocks.header_output = macroop.getDeclaration()
|
|
|
|
blocks.decoder_output = macroop.getDefinition()
|
|
|
|
macroop.declared = True
|
|
|
|
blocks.decode_block = "return %s;\n" % macroop.getAllocator(env)
|
|
|
|
return blocks
|
2007-04-03 17:01:09 +02:00
|
|
|
}};
|