base.isa revision 4371
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//The operand types a microop template can be specialized with 59output header {{ 60 enum OperandType { 61 RegisterOperand, 62 ImmediateOperand 63 }; 64}}; 65 66//A class which is the base of all x86 micro ops. It provides a function to 67//set necessary flags appropriately. 68output header {{ 69 class X86MicroOpBase : public X86StaticInst 70 { 71 protected: 72 const char * instMnem; 73 uint8_t opSize; 74 uint8_t addrSize; 75 76 X86MicroOpBase(ExtMachInst _machInst, 77 const char *mnem, const char *_instMnem, 78 bool isMicro, bool isDelayed, 79 bool isFirst, bool isLast, 80 OpClass __opClass) : 81 X86StaticInst(mnem, _machInst, __opClass), 82 instMnem(_instMnem) 83 { 84 flags[IsMicroOp] = isMicro; 85 flags[IsDelayedCommit] = isDelayed; 86 flags[IsFirstMicroOp] = isFirst; 87 flags[IsLastMicroOp] = isLast; 88 } 89 90 std::string generateDisassembly(Addr pc, 91 const SymbolTable *symtab) const 92 { 93 std::stringstream ss; 94 95 ccprintf(ss, "\t%s.%s", instMnem, mnemonic); 96 97 return ss.str(); 98 } 99 }; 100}}; 101 102// This sets up a class which is templated on the type of 103// arguments a particular flavor of a microcode instruction 104// can accept. It's parameters are specialized to create polymorphic 105// behavior in microops. 106def template BaseMicroOpTemplateDeclare {{ 107 template%(signature)s 108 class %(class_name)s; 109}}; 110 111let {{ 112 def buildBaseMicroOpTemplate(Name, numParams): 113 assert(numParams > 0) 114 signature = "<" 115 signature += "int SignatureOperandTypeSpecifier0" 116 for count in xrange(1,numParams): 117 signature += \ 118 ", int SingatureOperandTypeSpecifier%d" % count 119 signature += ">" 120 subs = {"signature" : signature, "class_name" : Name} 121 return BaseMicroOpTemplateDeclare.subst(subs) 122}}; 123 124let {{ 125 def buildMicroOpTemplateDict(*params): 126 signature = "<" 127 if len(params): 128 signature += params[0] 129 if len(params) > 1: 130 for param in params[1:]: 131 signature += ", %s" % param 132 signature += ">" 133 subs = {"param_dec" : "", "param_arg_dec" : "", 134 "param_init" : "", "signature" : signature} 135 for count in xrange(len(params)): 136 subs["param_dec"] += "uint64_t param%d;\n" % count 137 subs["param_arg_dec"] += ", uint64_t _param%d" % count 138 subs["param_init"] += ", param%d(_param%d)" % (count, count) 139 return subs 140}}; 141 142// A tmeplate for building a specialized version of the microcode 143// instruction which specifies which arguments it wants 144def template MicroOpDeclare {{ 145 template<> 146 class %(class_name)s%(signature)s : public X86MicroOpBase 147 { 148 protected: 149 %(param_dec)s 150 void buildMe(); 151 152 public: 153 %(class_name)s(ExtMachInst _machInst, 154 const char * instMnem, 155 bool isMicro, bool isDelayed, 156 bool isFirst, bool isLast 157 %(param_arg_dec)s); 158 159 %(class_name)s(ExtMachInst _machInst, 160 const char * instMnem 161 %(param_arg_dec)s); 162 163 %(BasicExecDeclare)s 164 }; 165}}; 166 167def template MicroOpConstructor {{ 168 169 inline void %(class_name)s%(signature)s::buildMe() 170 { 171 %(constructor)s; 172 } 173 174 inline %(class_name)s%(signature)s::%(class_name)s( 175 ExtMachInst machInst, const char * instMnem 176 %(param_arg_dec)s) : 177 %(base_class)s(machInst, "%(mnemonic)s", instMnem, 178 false, false, false, false, %(op_class)s) 179 %(param_init)s 180 { 181 buildMe(); 182 } 183 184 inline %(class_name)s%(signature)s::%(class_name)s( 185 ExtMachInst machInst, const char * instMnem, 186 bool isMicro, bool isDelayed, bool isFirst, bool isLast 187 %(param_arg_dec)s) 188 : %(base_class)s(machInst, "%(mnemonic)s", instMnem, 189 isMicro, isDelayed, isFirst, isLast, %(op_class)s) 190 %(param_init)s 191 { 192 buildMe(); 193 } 194}}; 195