regop.isa revision 6479:b9ab1b56391b
12SN/A// Copyright (c) 2007-2008 The Hewlett-Packard Development Company 21762SN/A// All rights reserved. 32SN/A// 42SN/A// Redistribution and use of this software in source and binary forms, 52SN/A// with or without modification, are permitted provided that the 62SN/A// following conditions are met: 72SN/A// 82SN/A// The software must be used only for Non-Commercial Use which means any 92SN/A// use which is NOT directed to receiving any direct monetary 102SN/A// compensation for, or commercial advantage from such use. Illustrative 112SN/A// examples of non-commercial use are academic research, personal study, 122SN/A// teaching, education and corporate research & development. 132SN/A// Illustrative examples of commercial use are distributing products for 142SN/A// commercial advantage and providing services using the software for 152SN/A// commercial advantage. 162SN/A// 172SN/A// If you wish to use this software or functionality therein that may be 182SN/A// covered by patents for commercial use, please contact: 192SN/A// Director of Intellectual Property Licensing 202SN/A// Office of Strategy and Technology 212SN/A// Hewlett-Packard Company 222SN/A// 1501 Page Mill Road 232SN/A// Palo Alto, California 94304 242SN/A// 252SN/A// Redistributions of source code must retain the above copyright notice, 262SN/A// this list of conditions and the following disclaimer. Redistributions 272665Ssaidi@eecs.umich.edu// in binary form must reproduce the above copyright notice, this list of 282665Ssaidi@eecs.umich.edu// conditions and the following disclaimer in the documentation and/or 292SN/A// other materials provided with the distribution. Neither the name of 302SN/A// the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its 316216Snate@binkert.org// contributors may be used to endorse or promote products derived from 322439SN/A// this software without specific prior written permission. No right of 336216Snate@binkert.org// sublicense is granted herewith. Derivatives of the software and 34146SN/A// output created using the software may be prepared, but only for 35146SN/A// Non-Commercial Uses. Derivatives of the software may be shared with 36146SN/A// others provided: (i) the others agree to abide by the list of 37146SN/A// conditions herein which includes the Non-Commercial Use restrictions; 38146SN/A// and (ii) such Derivatives of the software include the above copyright 39146SN/A// notice to acknowledge the contribution from this software where 401717SN/A// applicable, this list of conditions and the disclaimer below. 41146SN/A// 426216Snate@binkert.org// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 436658Snate@binkert.org// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 441717SN/A// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 45146SN/A// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 461977SN/A// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 472623SN/A// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 482683Sktlim@umich.edu// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 491717SN/A// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 50146SN/A// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 512683Sktlim@umich.edu// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 523348Sbinkertn@umich.edu// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 536105Ssteve.reinhardt@amd.com// 546216Snate@binkert.org// Authors: Gabe Black 552036SN/A 56146SN/A////////////////////////////////////////////////////////////////////////// 5756SN/A// 5856SN/A// RegOp Microop templates 59695SN/A// 602901Ssaidi@eecs.umich.edu////////////////////////////////////////////////////////////////////////// 612SN/A 621858SN/Adef template MicroRegOpExecute {{ 633565Sgblack@eecs.umich.edu Fault %(class_name)s::execute(%(CPU_exec_context)s *xc, 643565Sgblack@eecs.umich.edu Trace::InstRecord *traceData) const 652171SN/A { 662170SN/A Fault fault = NoFault; 673562Sgblack@eecs.umich.edu 68146SN/A DPRINTF(X86, "The data size is %d\n", dataSize); 692462SN/A %(op_decl)s; 70146SN/A %(op_rd)s; 712SN/A 722SN/A if(%(cond_check)s) 732449SN/A { 741355SN/A %(code)s; 755529Snate@binkert.org %(flag_code)s; 764495Sacolyte@umich.edu } 77224SN/A else 781858SN/A { 792683Sktlim@umich.edu %(else_code)s; 802420SN/A } 815529Snate@binkert.org 826331Sgblack@eecs.umich.edu //Write the resulting state to the execution context 832420SN/A if(fault == NoFault) 842SN/A { 856029Ssteve.reinhardt@amd.com %(op_wb)s; 862672Sktlim@umich.edu } 872683Sktlim@umich.edu return fault; 882SN/A } 892SN/A}}; 90334SN/A 91140SN/Adef template MicroRegOpImmExecute {{ 92334SN/A Fault %(class_name)s::execute(%(CPU_exec_context)s *xc, 932SN/A Trace::InstRecord *traceData) const 942SN/A { 952SN/A Fault fault = NoFault; 962680Sktlim@umich.edu 974377Sgblack@eecs.umich.edu %(op_decl)s; 985169Ssaidi@eecs.umich.edu %(op_rd)s; 994377Sgblack@eecs.umich.edu 1004377Sgblack@eecs.umich.edu if(%(cond_check)s) 1012SN/A { 1022SN/A %(code)s; 1032623SN/A %(flag_code)s; 1042SN/A } 1052SN/A else 1062SN/A { 107180SN/A %(else_code)s; 1082623SN/A } 109393SN/A 110393SN/A //Write the resulting state to the execution context 111393SN/A if(fault == NoFault) 112393SN/A { 113384SN/A %(op_wb)s; 114384SN/A } 115393SN/A return fault; 1162623SN/A } 117393SN/A}}; 118393SN/A 119393SN/Adef template MicroRegOpDeclare {{ 120393SN/A class %(class_name)s : public %(base_class)s 121384SN/A { 122189SN/A protected: 123189SN/A void buildMe(); 1242623SN/A 1252SN/A public: 126729SN/A %(class_name)s(ExtMachInst _machInst, 127334SN/A const char * instMnem, 1282SN/A bool isMicro, bool isDelayed, bool isFirst, bool isLast, 1292SN/A InstRegIndex _src1, InstRegIndex _src2, InstRegIndex _dest, 1302SN/A uint8_t _dataSize, uint16_t _ext); 1312SN/A 1322SN/A %(class_name)s(ExtMachInst _machInst, 1332SN/A const char * instMnem, 1342SN/A InstRegIndex _src1, InstRegIndex _src2, InstRegIndex _dest, 1352SN/A uint8_t _dataSize, uint16_t _ext); 1362SN/A 1372SN/A %(BasicExecDeclare)s 1382SN/A }; 1392SN/A}}; 1401001SN/A 1411001SN/Adef template MicroRegOpImmDeclare {{ 1421001SN/A 1431001SN/A class %(class_name)s : public %(base_class)s 1441001SN/A { 1452SN/A protected: 1462SN/A void buildMe(); 1472SN/A 1482SN/A public: 1492SN/A %(class_name)s(ExtMachInst _machInst, 1502SN/A const char * instMnem, 1512SN/A bool isMicro, bool isDelayed, bool isFirst, bool isLast, 1522SN/A InstRegIndex _src1, uint16_t _imm8, InstRegIndex _dest, 1532SN/A uint8_t _dataSize, uint16_t _ext); 1542SN/A 1552SN/A %(class_name)s(ExtMachInst _machInst, 1562SN/A const char * instMnem, 1572SN/A InstRegIndex _src1, uint16_t _imm8, InstRegIndex _dest, 1582SN/A uint8_t _dataSize, uint16_t _ext); 1592SN/A 1602SN/A %(BasicExecDeclare)s 1612SN/A }; 1622390SN/A}}; 1632390SN/A 1642390SN/Adef template MicroRegOpConstructor {{ 1652390SN/A 1662390SN/A inline void %(class_name)s::buildMe() 1672390SN/A { 1682390SN/A %(constructor)s; 1692390SN/A } 1702390SN/A 1712390SN/A inline %(class_name)s::%(class_name)s( 1722390SN/A ExtMachInst machInst, const char * instMnem, 1732390SN/A InstRegIndex _src1, InstRegIndex _src2, InstRegIndex _dest, 174385SN/A uint8_t _dataSize, uint16_t _ext) : 1752SN/A %(base_class)s(machInst, "%(mnemonic)s", instMnem, 1762SN/A false, false, false, false, 1772SN/A _src1, _src2, _dest, _dataSize, _ext, 1782623SN/A %(op_class)s) 179334SN/A { 1802361SN/A buildMe(); 1815496Ssaidi@eecs.umich.edu } 182334SN/A 183334SN/A inline %(class_name)s::%(class_name)s( 184334SN/A ExtMachInst machInst, const char * instMnem, 1852623SN/A bool isMicro, bool isDelayed, bool isFirst, bool isLast, 1862SN/A InstRegIndex _src1, InstRegIndex _src2, InstRegIndex _dest, 1875496Ssaidi@eecs.umich.edu uint8_t _dataSize, uint16_t _ext) : 188921SN/A %(base_class)s(machInst, "%(mnemonic)s", instMnem, 1892915Sktlim@umich.edu isMicro, isDelayed, isFirst, isLast, 1902915Sktlim@umich.edu _src1, _src2, _dest, _dataSize, _ext, 1912683Sktlim@umich.edu %(op_class)s) 1922SN/A { 1932SN/A buildMe(); 1942SN/A } 1952623SN/A}}; 1962SN/A 1975496Ssaidi@eecs.umich.edudef template MicroRegOpImmConstructor {{ 198921SN/A 1992915Sktlim@umich.edu inline void %(class_name)s::buildMe() 2002915Sktlim@umich.edu { 2012SN/A %(constructor)s; 2022SN/A } 2032SN/A 2046221Snate@binkert.org inline %(class_name)s::%(class_name)s( 2052SN/A ExtMachInst machInst, const char * instMnem, 2062SN/A InstRegIndex _src1, uint16_t _imm8, InstRegIndex _dest, 2072SN/A uint8_t _dataSize, uint16_t _ext) : 2087045Ssteve.reinhardt@amd.com %(base_class)s(machInst, "%(mnemonic)s", instMnem, 2097045Ssteve.reinhardt@amd.com false, false, false, false, 2107045Ssteve.reinhardt@amd.com _src1, _imm8, _dest, _dataSize, _ext, 2117045Ssteve.reinhardt@amd.com %(op_class)s) 2127045Ssteve.reinhardt@amd.com { 2137045Ssteve.reinhardt@amd.com buildMe(); 2147045Ssteve.reinhardt@amd.com } 2157045Ssteve.reinhardt@amd.com 2167045Ssteve.reinhardt@amd.com inline %(class_name)s::%(class_name)s( 2177045Ssteve.reinhardt@amd.com ExtMachInst machInst, const char * instMnem, 2187045Ssteve.reinhardt@amd.com bool isMicro, bool isDelayed, bool isFirst, bool isLast, 2197045Ssteve.reinhardt@amd.com InstRegIndex _src1, uint16_t _imm8, InstRegIndex _dest, 2207045Ssteve.reinhardt@amd.com uint8_t _dataSize, uint16_t _ext) : 2217045Ssteve.reinhardt@amd.com %(base_class)s(machInst, "%(mnemonic)s", instMnem, 2227045Ssteve.reinhardt@amd.com isMicro, isDelayed, isFirst, isLast, 2237045Ssteve.reinhardt@amd.com _src1, _imm8, _dest, _dataSize, _ext, 2247045Ssteve.reinhardt@amd.com %(op_class)s) 2257045Ssteve.reinhardt@amd.com { 2267045Ssteve.reinhardt@amd.com buildMe(); 2277045Ssteve.reinhardt@amd.com } 2287045Ssteve.reinhardt@amd.com}}; 229595SN/A 2302623SN/Aoutput header {{ 231595SN/A void 2322390SN/A divide(uint64_t dividend, uint64_t divisor, 2331080SN/A uint64_t "ient, uint64_t &remainder); 2346227Snate@binkert.org 2356227Snate@binkert.org enum SegmentSelectorCheck { 2361080SN/A SegNoCheck, SegCSCheck, SegCallGateCheck, SegIntGateCheck, 2371080SN/A SegSoftIntGateCheck, SegSSCheck, SegIretCheck, SegIntCSCheck, 2381080SN/A SegTRCheck, SegTSSCheck, SegInGDTCheck, SegLDTCheck 2391080SN/A }; 2401080SN/A 2411121SN/A enum LongModeDescriptorType { 2422107SN/A LDT64 = 2, 2431089SN/A AvailableTSS64 = 9, 2441089SN/A BusyTSS64 = 0xb, 2451080SN/A CallGate64 = 0xc, 2461080SN/A IntGate64 = 0xe, 2471080SN/A TrapGate64 = 0xf 2481080SN/A }; 249595SN/A}}; 2502623SN/A 2512683Sktlim@umich.eduoutput decoder {{ 252595SN/A void 2532090SN/A divide(uint64_t dividend, uint64_t divisor, 2542683Sktlim@umich.edu uint64_t "ient, uint64_t &remainder) 2552683Sktlim@umich.edu { 256595SN/A //Check for divide by zero. 2572205SN/A if (divisor == 0) 2582205SN/A panic("Divide by zero!\\n"); 2592683Sktlim@umich.edu //If the divisor is bigger than the dividend, don't do anything. 2602683Sktlim@umich.edu if (divisor <= dividend) { 261595SN/A //Shift the divisor so it's msb lines up with the dividend. 262595SN/A int dividendMsb = findMsbSet(dividend); 2632390SN/A int divisorMsb = findMsbSet(divisor); 2642423SN/A int shift = dividendMsb - divisorMsb; 2652390SN/A divisor <<= shift; 266595SN/A //Compute what we'll add to the quotient if the divisor isn't 267595SN/A //now larger than the dividend. 268595SN/A uint64_t quotientBit = 1; 2692623SN/A quotientBit <<= shift; 270595SN/A //If we need to step back a bit (no pun intended) because the 2712390SN/A //divisor got too to large, do that here. This is the "or two" 2721080SN/A //part of one or two bit division. 2736227Snate@binkert.org if (divisor > dividend) { 2746227Snate@binkert.org quotientBit >>= 1; 2751080SN/A divisor >>= 1; 2761080SN/A } 277595SN/A //Decrement the remainder and increment the quotient. 2782683Sktlim@umich.edu quotient += quotientBit; 2791080SN/A remainder -= divisor; 2801080SN/A } 2811080SN/A } 2821121SN/A}}; 2832107SN/A 2841089SN/Alet {{ 2851080SN/A # Make these empty strings so that concatenating onto 2861089SN/A # them will always work. 2871080SN/A header_output = "" 2881080SN/A decoder_output = "" 2891080SN/A exec_output = "" 290595SN/A 2912683Sktlim@umich.edu immTemplates = ( 2921080SN/A MicroRegOpImmDeclare, 2932090SN/A MicroRegOpImmConstructor, 2941080SN/A MicroRegOpImmExecute) 295595SN/A 2962683Sktlim@umich.edu regTemplates = ( 2972683Sktlim@umich.edu MicroRegOpDeclare, 298595SN/A MicroRegOpConstructor, 2992683Sktlim@umich.edu MicroRegOpExecute) 3001098SN/A 3011098SN/A class RegOpMeta(type): 3021098SN/A def buildCppClasses(self, name, Name, suffix, \ 3032683Sktlim@umich.edu code, flag_code, cond_check, else_code): 3041098SN/A 3051098SN/A # Globals to stick the output in 3061098SN/A global header_output 3071098SN/A global decoder_output 3081098SN/A global exec_output 309595SN/A 3102205SN/A # Stick all the code together so it can be searched at once 3112205SN/A allCode = "|".join((code, flag_code, cond_check, else_code)) 3122205SN/A 313595SN/A # If op2 is used anywhere, make register and immediate versions 3142390SN/A # of this code. 3152420SN/A matcher = re.compile("(?<!\\w)(?P<prefix>s?)op2(?P<typeQual>\\.\\w+)?") 3162423SN/A match = matcher.search(allCode) 3172390SN/A if match: 318595SN/A typeQual = "" 319595SN/A if match.group("typeQual"): 3201858SN/A typeQual = match.group("typeQual") 3212SN/A src2_name = "%spsrc2%s" % (match.group("prefix"), typeQual) 3222623SN/A self.buildCppClasses(name, Name, suffix, 3232SN/A matcher.sub(src2_name, code), 3242680Sktlim@umich.edu matcher.sub(src2_name, flag_code), 3252SN/A matcher.sub(src2_name, cond_check), 3262SN/A matcher.sub(src2_name, else_code)) 3272SN/A self.buildCppClasses(name + "i", Name, suffix + "Imm", 3281858SN/A matcher.sub("imm8", code), 3292SN/A matcher.sub("imm8", flag_code), 3305807Snate@binkert.org matcher.sub("imm8", cond_check), 3312SN/A matcher.sub("imm8", else_code)) 3325807Snate@binkert.org return 3335807Snate@binkert.org 3342SN/A # If there's something optional to do with flags, generate 3355807Snate@binkert.org # a version without it and fix up this version to use it. 3365807Snate@binkert.org if flag_code != "" or cond_check != "true": 3372SN/A self.buildCppClasses(name, Name, suffix, 3382SN/A code, "", "true", else_code) 3392SN/A suffix = "Flags" + suffix 3402SN/A 3412623SN/A # If psrc1 or psrc2 is used, we need to actually insert code to 3422SN/A # compute it. 3431858SN/A matcher = re.compile("(?<!\w)psrc1(?!\w)") 3445704Snate@binkert.org if matcher.search(allCode): 3455647Sgblack@eecs.umich.edu code = "uint64_t psrc1 = pick(SrcReg1, 0, dataSize);" + code 3462SN/A matcher = re.compile("(?<!\w)psrc2(?!\w)") 3473520Sgblack@eecs.umich.edu if matcher.search(allCode): 3485835Sgblack@eecs.umich.edu code = "uint64_t psrc2 = pick(SrcReg2, 1, dataSize);" + code 3495647Sgblack@eecs.umich.edu # Also make available versions which do sign extension 3503520Sgblack@eecs.umich.edu matcher = re.compile("(?<!\w)spsrc1(?!\w)") 3512SN/A if matcher.search(allCode): 3522SN/A code = "int64_t spsrc1 = signedPick(SrcReg1, 0, dataSize);" + code 3532SN/A matcher = re.compile("(?<!\w)spsrc2(?!\w)") 3542623SN/A if matcher.search(allCode): 3552SN/A code = "int64_t spsrc2 = signedPick(SrcReg2, 1, dataSize);" + code 3562623SN/A 3575894Sgblack@eecs.umich.edu base = "X86ISA::RegOp" 3582662Sstever@eecs.umich.edu 3592623SN/A # If imm8 shows up in the code, use the immediate templates, if 3604514Ssaidi@eecs.umich.edu # not, hopefully the register ones will be correct. 3614495Sacolyte@umich.edu templates = regTemplates 3622623SN/A matcher = re.compile("(?<!\w)imm8(?!\w)") 3633093Sksewell@umich.edu if matcher.search(allCode): 3644495Sacolyte@umich.edu base += "Imm" 3653093Sksewell@umich.edu templates = immTemplates 3663093Sksewell@umich.edu 3674564Sgblack@eecs.umich.edu # Get everything ready for the substitution 3682741Sksewell@umich.edu iop = InstObjParams(name, Name + suffix, base, 3692741Sksewell@umich.edu {"code" : code, 3702623SN/A "flag_code" : flag_code, 3714564Sgblack@eecs.umich.edu "cond_check" : cond_check, 3726105Ssteve.reinhardt@amd.com "else_code" : else_code}) 3732623SN/A 3742623SN/A # Generate the actual code (finally!) 3752623SN/A header_output += templates[0].subst(iop) 3762623SN/A decoder_output += templates[1].subst(iop) 3772623SN/A exec_output += templates[2].subst(iop) 3782623SN/A 3792SN/A 3802683Sktlim@umich.edu def __new__(mcls, Name, bases, dict): 3812427SN/A abstract = False 3822683Sktlim@umich.edu name = Name.lower() 3832427SN/A if "abstract" in dict: 3842SN/A abstract = dict['abstract'] 3852623SN/A del dict['abstract'] 3862623SN/A 3872SN/A cls = super(RegOpMeta, mcls).__new__(mcls, Name, bases, dict) 3882623SN/A if not abstract: 3892623SN/A cls.className = Name 3904377Sgblack@eecs.umich.edu cls.base_mnemonic = name 3915665Sgblack@eecs.umich.edu code = cls.code 3924377Sgblack@eecs.umich.edu flag_code = cls.flag_code 3935665Sgblack@eecs.umich.edu cond_check = cls.cond_check 3945665Sgblack@eecs.umich.edu else_code = cls.else_code 3955665Sgblack@eecs.umich.edu 3965665Sgblack@eecs.umich.edu # Set up the C++ classes 3975665Sgblack@eecs.umich.edu mcls.buildCppClasses(cls, name, Name, "", 3984181Sgblack@eecs.umich.edu code, flag_code, cond_check, else_code) 3994181Sgblack@eecs.umich.edu 4004181Sgblack@eecs.umich.edu # Hook into the microassembler dict 4014182Sgblack@eecs.umich.edu global microopClasses 4024182Sgblack@eecs.umich.edu microopClasses[name] = cls 4034182Sgblack@eecs.umich.edu 4044593Sgblack@eecs.umich.edu allCode = "|".join((code, flag_code, cond_check, else_code)) 4054593Sgblack@eecs.umich.edu 4064593Sgblack@eecs.umich.edu # If op2 is used anywhere, make register and immediate versions 4074593Sgblack@eecs.umich.edu # of this code. 4084593Sgblack@eecs.umich.edu matcher = re.compile("op2(?P<typeQual>\\.\\w+)?") 4094377Sgblack@eecs.umich.edu if matcher.search(allCode): 4104377Sgblack@eecs.umich.edu microopClasses[name + 'i'] = cls 4114377Sgblack@eecs.umich.edu return cls 4124377Sgblack@eecs.umich.edu 4134377Sgblack@eecs.umich.edu 4144377Sgblack@eecs.umich.edu class RegOp(X86Microop): 4154377Sgblack@eecs.umich.edu __metaclass__ = RegOpMeta 4164377Sgblack@eecs.umich.edu # This class itself doesn't act as a microop 4174572Sacolyte@umich.edu abstract = True 4184572Sacolyte@umich.edu 4194377Sgblack@eecs.umich.edu # Default template parameter values 4204377Sgblack@eecs.umich.edu flag_code = "" 4214377Sgblack@eecs.umich.edu cond_check = "true" 4224377Sgblack@eecs.umich.edu else_code = ";" 4234181Sgblack@eecs.umich.edu 4244181Sgblack@eecs.umich.edu def __init__(self, dest, src1, op2, flags = None, dataSize = "env.dataSize"): 4254181Sgblack@eecs.umich.edu self.dest = dest 4264539Sgblack@eecs.umich.edu self.src1 = src1 4273276Sgblack@eecs.umich.edu self.op2 = op2 4285665Sgblack@eecs.umich.edu self.flags = flags 4293280Sgblack@eecs.umich.edu self.dataSize = dataSize 4303280Sgblack@eecs.umich.edu if flags is None: 4313276Sgblack@eecs.umich.edu self.ext = 0 4323276Sgblack@eecs.umich.edu else: 4333276Sgblack@eecs.umich.edu if not isinstance(flags, (list, tuple)): 4345665Sgblack@eecs.umich.edu raise Exception, "flags must be a list or tuple of flags" 4353276Sgblack@eecs.umich.edu self.ext = " | ".join(flags) 4363276Sgblack@eecs.umich.edu self.className += "Flags" 4374181Sgblack@eecs.umich.edu 4384181Sgblack@eecs.umich.edu def getAllocator(self, *microFlags): 4394181Sgblack@eecs.umich.edu className = self.className 4404522Ssaidi@eecs.umich.edu if self.mnemonic == self.base_mnemonic + 'i': 4415784Sgblack@eecs.umich.edu className += "Imm" 4425784Sgblack@eecs.umich.edu allocator = '''new %(class_name)s(machInst, macrocodeBlock 4435784Sgblack@eecs.umich.edu %(flags)s, %(src1)s, %(op2)s, %(dest)s, 4442470SN/A %(dataSize)s, %(ext)s)''' % { 4454181Sgblack@eecs.umich.edu "class_name" : className, 4464181Sgblack@eecs.umich.edu "flags" : self.microFlagsText(microFlags), 4474522Ssaidi@eecs.umich.edu "src1" : self.src1, "op2" : self.op2, 4482623SN/A "dest" : self.dest, 4492623SN/A "dataSize" : self.dataSize, 4504181Sgblack@eecs.umich.edu "ext" : self.ext} 4512623SN/A return allocator 4524181Sgblack@eecs.umich.edu 4532623SN/A class LogicRegOp(RegOp): 4542623SN/A abstract = True 4552623SN/A flag_code = ''' 4562623SN/A //Don't have genFlags handle the OF or CF bits 4572623SN/A uint64_t mask = CFBit | ECFBit | OFBit; 4582623SN/A ccFlagBits = genFlags(ccFlagBits, ext & ~mask, DestReg, psrc1, op2); 4595086Sgblack@eecs.umich.edu //If a logic microop wants to set these, it wants to set them to 0. 4603577Sgblack@eecs.umich.edu ccFlagBits &= ~(CFBit & ext); 4612683Sktlim@umich.edu ccFlagBits &= ~(ECFBit & ext); 4625086Sgblack@eecs.umich.edu ccFlagBits &= ~(OFBit & ext); 4632623SN/A ''' 4642683Sktlim@umich.edu 4652623SN/A class FlagRegOp(RegOp): 4662420SN/A abstract = True 4672SN/A flag_code = \ 4682623SN/A "ccFlagBits = genFlags(ccFlagBits, ext, DestReg, psrc1, op2);" 4692623SN/A 4702SN/A class SubRegOp(RegOp): 4712SN/A abstract = True 4722623SN/A flag_code = \ 4732623SN/A "ccFlagBits = genFlags(ccFlagBits, ext, DestReg, psrc1, ~op2, true);" 4742623SN/A 4752623SN/A class CondRegOp(RegOp): 4762SN/A abstract = True 4775953Ssaidi@eecs.umich.edu cond_check = "checkCondition(ccFlagBits, ext)" 4785953Ssaidi@eecs.umich.edu 4795953Ssaidi@eecs.umich.edu class RdRegOp(RegOp): 4805953Ssaidi@eecs.umich.edu abstract = True 4812683Sktlim@umich.edu def __init__(self, dest, src1=None, dataSize="env.dataSize"): 4822644Sstever@eecs.umich.edu if not src1: 4832644Sstever@eecs.umich.edu src1 = dest 4844046Sbinkertn@umich.edu super(RdRegOp, self).__init__(dest, src1, \ 4854046Sbinkertn@umich.edu "InstRegIndex(NUM_INTREGS)", None, dataSize) 4864046Sbinkertn@umich.edu 4872644Sstever@eecs.umich.edu class WrRegOp(RegOp): 4882623SN/A abstract = True 4892SN/A def __init__(self, src1, src2, flags=None, dataSize="env.dataSize"): 4902SN/A super(WrRegOp, self).__init__("InstRegIndex(NUM_INTREGS)", \ 4912623SN/A src1, src2, flags, dataSize) 4922623SN/A 4932623SN/A class Add(FlagRegOp): 4944377Sgblack@eecs.umich.edu code = 'DestReg = merge(DestReg, psrc1 + op2, dataSize);' 4954377Sgblack@eecs.umich.edu 4962090SN/A class Or(LogicRegOp): 4973905Ssaidi@eecs.umich.edu code = 'DestReg = merge(DestReg, psrc1 | op2, dataSize);' 4985120Sgblack@eecs.umich.edu 4995281Sgblack@eecs.umich.edu class Adc(FlagRegOp): 5004377Sgblack@eecs.umich.edu code = ''' 5013276Sgblack@eecs.umich.edu CCFlagBits flags = ccFlagBits; 5024539Sgblack@eecs.umich.edu DestReg = merge(DestReg, psrc1 + op2 + flags.cf, dataSize); 5035665Sgblack@eecs.umich.edu ''' 5045665Sgblack@eecs.umich.edu 5055665Sgblack@eecs.umich.edu class Sbb(SubRegOp): 5063276Sgblack@eecs.umich.edu code = ''' 5073276Sgblack@eecs.umich.edu CCFlagBits flags = ccFlagBits; 5083280Sgblack@eecs.umich.edu DestReg = merge(DestReg, psrc1 - op2 - flags.cf, dataSize); 5095665Sgblack@eecs.umich.edu ''' 5105665Sgblack@eecs.umich.edu 5113276Sgblack@eecs.umich.edu class And(LogicRegOp): 5123276Sgblack@eecs.umich.edu code = 'DestReg = merge(DestReg, psrc1 & op2, dataSize)' 5135665Sgblack@eecs.umich.edu 5143276Sgblack@eecs.umich.edu class Sub(SubRegOp): 5153280Sgblack@eecs.umich.edu code = 'DestReg = merge(DestReg, psrc1 - op2, dataSize)' 5163276Sgblack@eecs.umich.edu 5173276Sgblack@eecs.umich.edu class Xor(LogicRegOp): 5183280Sgblack@eecs.umich.edu code = 'DestReg = merge(DestReg, psrc1 ^ op2, dataSize)' 5193276Sgblack@eecs.umich.edu 5203276Sgblack@eecs.umich.edu class Mul1s(WrRegOp): 5213276Sgblack@eecs.umich.edu code = ''' 5223276Sgblack@eecs.umich.edu ProdLow = psrc1 * op2; 5233276Sgblack@eecs.umich.edu int halfSize = (dataSize * 8) / 2; 5243276Sgblack@eecs.umich.edu uint64_t shifter = (1ULL << halfSize); 5253276Sgblack@eecs.umich.edu uint64_t hiResult; 5262SN/A uint64_t psrc1_h = psrc1 / shifter; 5272SN/A uint64_t psrc1_l = psrc1 & mask(halfSize); 5282SN/A uint64_t psrc2_h = (op2 / shifter) & mask(halfSize); 5295250Sksewell@umich.edu uint64_t psrc2_l = op2 & mask(halfSize); 5305222Sksewell@umich.edu hiResult = ((psrc1_l * psrc2_h + psrc1_h * psrc2_l + 5315222Sksewell@umich.edu ((psrc1_l * psrc2_l) / shifter)) /shifter) + 5325222Sksewell@umich.edu psrc1_h * psrc2_h; 5335222Sksewell@umich.edu if (bits(psrc1, dataSize * 8 - 1)) 5345222Sksewell@umich.edu hiResult -= op2; 5355222Sksewell@umich.edu if (bits(op2, dataSize * 8 - 1)) 5365222Sksewell@umich.edu hiResult -= psrc1; 5375222Sksewell@umich.edu ProdHi = hiResult; 5385222Sksewell@umich.edu ''' 5395222Sksewell@umich.edu flag_code = ''' 5405222Sksewell@umich.edu if ((-ProdHi & mask(dataSize * 8)) != 5415222Sksewell@umich.edu bits(ProdLow, dataSize * 8 - 1)) { 5425222Sksewell@umich.edu ccFlagBits = ccFlagBits | (ext & (CFBit | OFBit | ECFBit)); 5435222Sksewell@umich.edu } else { 5445222Sksewell@umich.edu ccFlagBits = ccFlagBits & ~(ext & (CFBit | OFBit | ECFBit)); 5455222Sksewell@umich.edu } 5465222Sksewell@umich.edu ''' 5475222Sksewell@umich.edu 5485222Sksewell@umich.edu class Mul1u(WrRegOp): 5495222Sksewell@umich.edu code = ''' 5505222Sksewell@umich.edu ProdLow = psrc1 * op2; 5515222Sksewell@umich.edu int halfSize = (dataSize * 8) / 2; 5525222Sksewell@umich.edu uint64_t shifter = (1ULL << halfSize); 5535222Sksewell@umich.edu uint64_t psrc1_h = psrc1 / shifter; 5545222Sksewell@umich.edu uint64_t psrc1_l = psrc1 & mask(halfSize); 5555222Sksewell@umich.edu uint64_t psrc2_h = (op2 / shifter) & mask(halfSize); 5565222Sksewell@umich.edu uint64_t psrc2_l = op2 & mask(halfSize); 5575222Sksewell@umich.edu ProdHi = ((psrc1_l * psrc2_h + psrc1_h * psrc2_l + 5585222Sksewell@umich.edu ((psrc1_l * psrc2_l) / shifter)) / shifter) + 5595222Sksewell@umich.edu psrc1_h * psrc2_h; 5605222Sksewell@umich.edu ''' 5615222Sksewell@umich.edu flag_code = ''' 5625250Sksewell@umich.edu if (ProdHi) { 563 ccFlagBits = ccFlagBits | (ext & (CFBit | OFBit | ECFBit)); 564 } else { 565 ccFlagBits = ccFlagBits & ~(ext & (CFBit | OFBit | ECFBit)); 566 } 567 ''' 568 569 class Mulel(RdRegOp): 570 code = 'DestReg = merge(SrcReg1, ProdLow, dataSize);' 571 572 class Muleh(RdRegOp): 573 def __init__(self, dest, src1=None, flags=None, dataSize="env.dataSize"): 574 if not src1: 575 src1 = dest 576 super(RdRegOp, self).__init__(dest, src1, \ 577 "InstRegIndex(NUM_INTREGS)", flags, dataSize) 578 code = 'DestReg = merge(SrcReg1, ProdHi, dataSize);' 579 580 # One or two bit divide 581 class Div1(WrRegOp): 582 code = ''' 583 //These are temporaries so that modifying them later won't make 584 //the ISA parser think they're also sources. 585 uint64_t quotient = 0; 586 uint64_t remainder = psrc1; 587 //Similarly, this is a temporary so changing it doesn't make it 588 //a source. 589 uint64_t divisor = op2; 590 //This is a temporary just for consistency and clarity. 591 uint64_t dividend = remainder; 592 //Do the division. 593 divide(dividend, divisor, quotient, remainder); 594 //Record the final results. 595 Remainder = remainder; 596 Quotient = quotient; 597 Divisor = divisor; 598 ''' 599 600 # Step divide 601 class Div2(RegOp): 602 code = ''' 603 uint64_t dividend = Remainder; 604 uint64_t divisor = Divisor; 605 uint64_t quotient = Quotient; 606 uint64_t remainder = dividend; 607 int remaining = op2; 608 //If we overshot, do nothing. This lets us unrool division loops a 609 //little. 610 if (remaining) { 611 //Shift in bits from the low order portion of the dividend 612 while(dividend < divisor && remaining) { 613 dividend = (dividend << 1) | bits(SrcReg1, remaining - 1); 614 quotient <<= 1; 615 remaining--; 616 } 617 remainder = dividend; 618 //Do the division. 619 divide(dividend, divisor, quotient, remainder); 620 } 621 //Keep track of how many bits there are still to pull in. 622 DestReg = merge(DestReg, remaining, dataSize); 623 //Record the final results 624 Remainder = remainder; 625 Quotient = quotient; 626 ''' 627 flag_code = ''' 628 if (DestReg == 0) 629 ccFlagBits = ccFlagBits | (ext & EZFBit); 630 else 631 ccFlagBits = ccFlagBits & ~(ext & EZFBit); 632 ''' 633 634 class Divq(RdRegOp): 635 code = 'DestReg = merge(SrcReg1, Quotient, dataSize);' 636 637 class Divr(RdRegOp): 638 code = 'DestReg = merge(SrcReg1, Remainder, dataSize);' 639 640 class Mov(CondRegOp): 641 code = 'DestReg = merge(SrcReg1, op2, dataSize)' 642 else_code = 'DestReg = merge(DestReg, DestReg, dataSize);' 643 644 # Shift instructions 645 646 class Sll(RegOp): 647 code = ''' 648 uint8_t shiftAmt = (op2 & ((dataSize == 8) ? mask(6) : mask(5))); 649 DestReg = merge(DestReg, psrc1 << shiftAmt, dataSize); 650 ''' 651 flag_code = ''' 652 // If the shift amount is zero, no flags should be modified. 653 if (shiftAmt) { 654 //Zero out any flags we might modify. This way we only have to 655 //worry about setting them. 656 ccFlagBits = ccFlagBits & ~(ext & (CFBit | ECFBit | OFBit)); 657 int CFBits = 0; 658 //Figure out if we -would- set the CF bits if requested. 659 if (shiftAmt <= dataSize * 8 && 660 bits(SrcReg1, dataSize * 8 - shiftAmt)) { 661 CFBits = 1; 662 } 663 //If some combination of the CF bits need to be set, set them. 664 if ((ext & (CFBit | ECFBit)) && CFBits) 665 ccFlagBits = ccFlagBits | (ext & (CFBit | ECFBit)); 666 //Figure out what the OF bit should be. 667 if ((ext & OFBit) && (CFBits ^ bits(DestReg, dataSize * 8 - 1))) 668 ccFlagBits = ccFlagBits | OFBit; 669 //Use the regular mechanisms to calculate the other flags. 670 ccFlagBits = genFlags(ccFlagBits, ext & ~(CFBit | ECFBit | OFBit), 671 DestReg, psrc1, op2); 672 } 673 ''' 674 675 class Srl(RegOp): 676 code = ''' 677 uint8_t shiftAmt = (op2 & ((dataSize == 8) ? mask(6) : mask(5))); 678 // Because what happens to the bits shift -in- on a right shift 679 // is not defined in the C/C++ standard, we have to mask them out 680 // to be sure they're zero. 681 uint64_t logicalMask = mask(dataSize * 8 - shiftAmt); 682 DestReg = merge(DestReg, (psrc1 >> shiftAmt) & logicalMask, dataSize); 683 ''' 684 flag_code = ''' 685 // If the shift amount is zero, no flags should be modified. 686 if (shiftAmt) { 687 //Zero out any flags we might modify. This way we only have to 688 //worry about setting them. 689 ccFlagBits = ccFlagBits & ~(ext & (CFBit | ECFBit | OFBit)); 690 //If some combination of the CF bits need to be set, set them. 691 if ((ext & (CFBit | ECFBit)) && 692 shiftAmt <= dataSize * 8 && 693 bits(SrcReg1, shiftAmt - 1)) { 694 ccFlagBits = ccFlagBits | (ext & (CFBit | ECFBit)); 695 } 696 //Figure out what the OF bit should be. 697 if ((ext & OFBit) && bits(SrcReg1, dataSize * 8 - 1)) 698 ccFlagBits = ccFlagBits | OFBit; 699 //Use the regular mechanisms to calculate the other flags. 700 ccFlagBits = genFlags(ccFlagBits, ext & ~(CFBit | ECFBit | OFBit), 701 DestReg, psrc1, op2); 702 } 703 ''' 704 705 class Sra(RegOp): 706 code = ''' 707 uint8_t shiftAmt = (op2 & ((dataSize == 8) ? mask(6) : mask(5))); 708 // Because what happens to the bits shift -in- on a right shift 709 // is not defined in the C/C++ standard, we have to sign extend 710 // them manually to be sure. 711 uint64_t arithMask = (shiftAmt == 0) ? 0 : 712 -bits(psrc1, dataSize * 8 - 1) << (dataSize * 8 - shiftAmt); 713 DestReg = merge(DestReg, (psrc1 >> shiftAmt) | arithMask, dataSize); 714 ''' 715 flag_code = ''' 716 // If the shift amount is zero, no flags should be modified. 717 if (shiftAmt) { 718 //Zero out any flags we might modify. This way we only have to 719 //worry about setting them. 720 ccFlagBits = ccFlagBits & ~(ext & (CFBit | ECFBit | OFBit)); 721 //If some combination of the CF bits need to be set, set them. 722 uint8_t effectiveShift = 723 (shiftAmt <= dataSize * 8) ? shiftAmt : (dataSize * 8); 724 if ((ext & (CFBit | ECFBit)) && 725 bits(SrcReg1, effectiveShift - 1)) { 726 ccFlagBits = ccFlagBits | (ext & (CFBit | ECFBit)); 727 } 728 //Use the regular mechanisms to calculate the other flags. 729 ccFlagBits = genFlags(ccFlagBits, ext & ~(CFBit | ECFBit | OFBit), 730 DestReg, psrc1, op2); 731 } 732 ''' 733 734 class Ror(RegOp): 735 code = ''' 736 uint8_t shiftAmt = 737 (op2 & ((dataSize == 8) ? mask(6) : mask(5))); 738 uint8_t realShiftAmt = shiftAmt % (dataSize * 8); 739 if(realShiftAmt) 740 { 741 uint64_t top = psrc1 << (dataSize * 8 - realShiftAmt); 742 uint64_t bottom = bits(psrc1, dataSize * 8, realShiftAmt); 743 DestReg = merge(DestReg, top | bottom, dataSize); 744 } 745 else 746 DestReg = merge(DestReg, DestReg, dataSize); 747 ''' 748 flag_code = ''' 749 // If the shift amount is zero, no flags should be modified. 750 if (shiftAmt) { 751 //Zero out any flags we might modify. This way we only have to 752 //worry about setting them. 753 ccFlagBits = ccFlagBits & ~(ext & (CFBit | ECFBit | OFBit)); 754 //Find the most and second most significant bits of the result. 755 int msb = bits(DestReg, dataSize * 8 - 1); 756 int smsb = bits(DestReg, dataSize * 8 - 2); 757 //If some combination of the CF bits need to be set, set them. 758 if ((ext & (CFBit | ECFBit)) && msb) 759 ccFlagBits = ccFlagBits | (ext & (CFBit | ECFBit)); 760 //Figure out what the OF bit should be. 761 if ((ext & OFBit) && (msb ^ smsb)) 762 ccFlagBits = ccFlagBits | OFBit; 763 //Use the regular mechanisms to calculate the other flags. 764 ccFlagBits = genFlags(ccFlagBits, ext & ~(CFBit | ECFBit | OFBit), 765 DestReg, psrc1, op2); 766 } 767 ''' 768 769 class Rcr(RegOp): 770 code = ''' 771 uint8_t shiftAmt = 772 (op2 & ((dataSize == 8) ? mask(6) : mask(5))); 773 uint8_t realShiftAmt = shiftAmt % (dataSize * 8 + 1); 774 if(realShiftAmt) 775 { 776 CCFlagBits flags = ccFlagBits; 777 uint64_t top = flags.cf << (dataSize * 8 - realShiftAmt); 778 if (realShiftAmt > 1) 779 top |= psrc1 << (dataSize * 8 - realShiftAmt + 1); 780 uint64_t bottom = bits(psrc1, dataSize * 8 - 1, realShiftAmt); 781 DestReg = merge(DestReg, top | bottom, dataSize); 782 } 783 else 784 DestReg = merge(DestReg, DestReg, dataSize); 785 ''' 786 flag_code = ''' 787 // If the shift amount is zero, no flags should be modified. 788 if (shiftAmt) { 789 int origCFBit = (ccFlagBits & CFBit) ? 1 : 0; 790 //Zero out any flags we might modify. This way we only have to 791 //worry about setting them. 792 ccFlagBits = ccFlagBits & ~(ext & (CFBit | ECFBit | OFBit)); 793 //Figure out what the OF bit should be. 794 if ((ext & OFBit) && (origCFBit ^ 795 bits(SrcReg1, dataSize * 8 - 1))) { 796 ccFlagBits = ccFlagBits | OFBit; 797 } 798 //If some combination of the CF bits need to be set, set them. 799 if ((ext & (CFBit | ECFBit)) && 800 (realShiftAmt == 0) ? origCFBit : 801 bits(SrcReg1, realShiftAmt - 1)) { 802 ccFlagBits = ccFlagBits | (ext & (CFBit | ECFBit)); 803 } 804 //Use the regular mechanisms to calculate the other flags. 805 ccFlagBits = genFlags(ccFlagBits, ext & ~(CFBit | ECFBit | OFBit), 806 DestReg, psrc1, op2); 807 } 808 ''' 809 810 class Rol(RegOp): 811 code = ''' 812 uint8_t shiftAmt = 813 (op2 & ((dataSize == 8) ? mask(6) : mask(5))); 814 uint8_t realShiftAmt = shiftAmt % (dataSize * 8); 815 if(realShiftAmt) 816 { 817 uint64_t top = psrc1 << realShiftAmt; 818 uint64_t bottom = 819 bits(psrc1, dataSize * 8 - 1, dataSize * 8 - realShiftAmt); 820 DestReg = merge(DestReg, top | bottom, dataSize); 821 } 822 else 823 DestReg = merge(DestReg, DestReg, dataSize); 824 ''' 825 flag_code = ''' 826 // If the shift amount is zero, no flags should be modified. 827 if (shiftAmt) { 828 //Zero out any flags we might modify. This way we only have to 829 //worry about setting them. 830 ccFlagBits = ccFlagBits & ~(ext & (CFBit | ECFBit | OFBit)); 831 //The CF bits, if set, would be set to the lsb of the result. 832 int lsb = DestReg & 0x1; 833 int msb = bits(DestReg, dataSize * 8 - 1); 834 //If some combination of the CF bits need to be set, set them. 835 if ((ext & (CFBit | ECFBit)) && lsb) 836 ccFlagBits = ccFlagBits | (ext & (CFBit | ECFBit)); 837 //Figure out what the OF bit should be. 838 if ((ext & OFBit) && (msb ^ lsb)) 839 ccFlagBits = ccFlagBits | OFBit; 840 //Use the regular mechanisms to calculate the other flags. 841 ccFlagBits = genFlags(ccFlagBits, ext & ~(CFBit | ECFBit | OFBit), 842 DestReg, psrc1, op2); 843 } 844 ''' 845 846 class Rcl(RegOp): 847 code = ''' 848 uint8_t shiftAmt = 849 (op2 & ((dataSize == 8) ? mask(6) : mask(5))); 850 uint8_t realShiftAmt = shiftAmt % (dataSize * 8 + 1); 851 if(realShiftAmt) 852 { 853 CCFlagBits flags = ccFlagBits; 854 uint64_t top = psrc1 << realShiftAmt; 855 uint64_t bottom = flags.cf << (realShiftAmt - 1); 856 if(shiftAmt > 1) 857 bottom |= 858 bits(psrc1, dataSize * 8 - 1, 859 dataSize * 8 - realShiftAmt + 1); 860 DestReg = merge(DestReg, top | bottom, dataSize); 861 } 862 else 863 DestReg = merge(DestReg, DestReg, dataSize); 864 ''' 865 flag_code = ''' 866 // If the shift amount is zero, no flags should be modified. 867 if (shiftAmt) { 868 int origCFBit = (ccFlagBits & CFBit) ? 1 : 0; 869 //Zero out any flags we might modify. This way we only have to 870 //worry about setting them. 871 ccFlagBits = ccFlagBits & ~(ext & (CFBit | ECFBit | OFBit)); 872 int msb = bits(DestReg, dataSize * 8 - 1); 873 int CFBits = bits(SrcReg1, dataSize * 8 - realShiftAmt); 874 //If some combination of the CF bits need to be set, set them. 875 if ((ext & (CFBit | ECFBit)) && 876 (realShiftAmt == 0) ? origCFBit : CFBits) 877 ccFlagBits = ccFlagBits | (ext & (CFBit | ECFBit)); 878 //Figure out what the OF bit should be. 879 if ((ext & OFBit) && (msb ^ CFBits)) 880 ccFlagBits = ccFlagBits | OFBit; 881 //Use the regular mechanisms to calculate the other flags. 882 ccFlagBits = genFlags(ccFlagBits, ext & ~(CFBit | ECFBit | OFBit), 883 DestReg, psrc1, op2); 884 } 885 ''' 886 887 class Sld(RegOp): 888 code = ''' 889 uint8_t shiftAmt = (op2 & ((dataSize == 8) ? mask(6) : mask(5))); 890 uint8_t dataBits = dataSize * 8; 891 uint8_t realShiftAmt = shiftAmt % (2 * dataBits); 892 uint64_t result; 893 if (realShiftAmt == 0) { 894 result = psrc1; 895 } else if (realShiftAmt < dataBits) { 896 result = (psrc1 << realShiftAmt) | 897 (DoubleBits >> (dataBits - realShiftAmt)); 898 } else { 899 result = (DoubleBits << (realShiftAmt - dataBits)) | 900 (psrc1 >> (2 * dataBits - realShiftAmt)); 901 } 902 DestReg = merge(DestReg, result, dataSize); 903 ''' 904 flag_code = ''' 905 // If the shift amount is zero, no flags should be modified. 906 if (shiftAmt) { 907 //Zero out any flags we might modify. This way we only have to 908 //worry about setting them. 909 ccFlagBits = ccFlagBits & ~(ext & (CFBit | ECFBit | OFBit)); 910 int CFBits = 0; 911 //Figure out if we -would- set the CF bits if requested. 912 if ((realShiftAmt == 0 && 913 bits(DoubleBits, 0)) || 914 (realShiftAmt <= dataBits && 915 bits(SrcReg1, dataBits - realShiftAmt)) || 916 (realShiftAmt > dataBits && 917 bits(DoubleBits, 2 * dataBits - realShiftAmt))) { 918 CFBits = 1; 919 } 920 //If some combination of the CF bits need to be set, set them. 921 if ((ext & (CFBit | ECFBit)) && CFBits) 922 ccFlagBits = ccFlagBits | (ext & (CFBit | ECFBit)); 923 //Figure out what the OF bit should be. 924 if ((ext & OFBit) && (bits(SrcReg1, dataBits - 1) ^ 925 bits(result, dataBits - 1))) 926 ccFlagBits = ccFlagBits | OFBit; 927 //Use the regular mechanisms to calculate the other flags. 928 ccFlagBits = genFlags(ccFlagBits, ext & ~(CFBit | ECFBit | OFBit), 929 DestReg, psrc1, op2); 930 } 931 ''' 932 933 class Srd(RegOp): 934 code = ''' 935 uint8_t shiftAmt = (op2 & ((dataSize == 8) ? mask(6) : mask(5))); 936 uint8_t dataBits = dataSize * 8; 937 uint8_t realShiftAmt = shiftAmt % (2 * dataBits); 938 uint64_t result; 939 if (realShiftAmt == 0) { 940 result = psrc1; 941 } else if (realShiftAmt < dataBits) { 942 // Because what happens to the bits shift -in- on a right 943 // shift is not defined in the C/C++ standard, we have to 944 // mask them out to be sure they're zero. 945 uint64_t logicalMask = mask(dataBits - realShiftAmt); 946 result = ((psrc1 >> realShiftAmt) & logicalMask) | 947 (DoubleBits << (dataBits - realShiftAmt)); 948 } else { 949 uint64_t logicalMask = mask(2 * dataBits - realShiftAmt); 950 result = ((DoubleBits >> (realShiftAmt - dataBits)) & 951 logicalMask) | 952 (psrc1 << (2 * dataBits - realShiftAmt)); 953 } 954 DestReg = merge(DestReg, result, dataSize); 955 ''' 956 flag_code = ''' 957 // If the shift amount is zero, no flags should be modified. 958 if (shiftAmt) { 959 //Zero out any flags we might modify. This way we only have to 960 //worry about setting them. 961 ccFlagBits = ccFlagBits & ~(ext & (CFBit | ECFBit | OFBit)); 962 int CFBits = 0; 963 //If some combination of the CF bits need to be set, set them. 964 if ((realShiftAmt == 0 && 965 bits(DoubleBits, dataBits - 1)) || 966 (realShiftAmt <= dataBits && 967 bits(SrcReg1, realShiftAmt - 1)) || 968 (realShiftAmt > dataBits && 969 bits(DoubleBits, realShiftAmt - dataBits - 1))) { 970 CFBits = 1; 971 } 972 //If some combination of the CF bits need to be set, set them. 973 if ((ext & (CFBit | ECFBit)) && CFBits) 974 ccFlagBits = ccFlagBits | (ext & (CFBit | ECFBit)); 975 //Figure out what the OF bit should be. 976 if ((ext & OFBit) && (bits(SrcReg1, dataBits - 1) ^ 977 bits(result, dataBits - 1))) 978 ccFlagBits = ccFlagBits | OFBit; 979 //Use the regular mechanisms to calculate the other flags. 980 ccFlagBits = genFlags(ccFlagBits, ext & ~(CFBit | ECFBit | OFBit), 981 DestReg, psrc1, op2); 982 } 983 ''' 984 985 class Mdb(WrRegOp): 986 code = 'DoubleBits = psrc1 ^ op2;' 987 988 class Wrip(WrRegOp, CondRegOp): 989 code = 'RIP = psrc1 + sop2 + CSBase' 990 else_code="RIP = RIP;" 991 992 class Wruflags(WrRegOp): 993 code = 'ccFlagBits = psrc1 ^ op2' 994 995 class Wrflags(WrRegOp): 996 code = ''' 997 MiscReg newFlags = psrc1 ^ op2; 998 MiscReg userFlagMask = 0xDD5; 999 // Get only the user flags 1000 ccFlagBits = newFlags & userFlagMask; 1001 // Get everything else 1002 nccFlagBits = newFlags & ~userFlagMask; 1003 ''' 1004 1005 class Rdip(RdRegOp): 1006 code = 'DestReg = RIP - CSBase' 1007 1008 class Ruflags(RdRegOp): 1009 code = 'DestReg = ccFlagBits' 1010 1011 class Rflags(RdRegOp): 1012 code = 'DestReg = ccFlagBits | nccFlagBits' 1013 1014 class Ruflag(RegOp): 1015 code = ''' 1016 int flag = bits(ccFlagBits, imm8); 1017 DestReg = merge(DestReg, flag, dataSize); 1018 ccFlagBits = (flag == 0) ? (ccFlagBits | EZFBit) : 1019 (ccFlagBits & ~EZFBit); 1020 ''' 1021 def __init__(self, dest, imm, flags=None, \ 1022 dataSize="env.dataSize"): 1023 super(Ruflag, self).__init__(dest, \ 1024 "InstRegIndex(NUM_INTREGS)", imm, flags, dataSize) 1025 1026 class Rflag(RegOp): 1027 code = ''' 1028 MiscReg flagMask = 0x3F7FDD5; 1029 MiscReg flags = (nccFlagBits | ccFlagBits) & flagMask; 1030 int flag = bits(flags, imm8); 1031 DestReg = merge(DestReg, flag, dataSize); 1032 ccFlagBits = (flag == 0) ? (ccFlagBits | EZFBit) : 1033 (ccFlagBits & ~EZFBit); 1034 ''' 1035 def __init__(self, dest, imm, flags=None, \ 1036 dataSize="env.dataSize"): 1037 super(Rflag, self).__init__(dest, \ 1038 "InstRegIndex(NUM_INTREGS)", imm, flags, dataSize) 1039 1040 class Sext(RegOp): 1041 code = ''' 1042 IntReg val = psrc1; 1043 // Mask the bit position so that it wraps. 1044 int bitPos = op2 & (dataSize * 8 - 1); 1045 int sign_bit = bits(val, bitPos, bitPos); 1046 uint64_t maskVal = mask(bitPos+1); 1047 val = sign_bit ? (val | ~maskVal) : (val & maskVal); 1048 DestReg = merge(DestReg, val, dataSize); 1049 ''' 1050 flag_code = ''' 1051 if (!sign_bit) 1052 ccFlagBits = ccFlagBits & 1053 ~(ext & (CFBit | ECFBit | ZFBit | EZFBit)); 1054 else 1055 ccFlagBits = ccFlagBits | 1056 (ext & (CFBit | ECFBit | ZFBit | EZFBit)); 1057 ''' 1058 1059 class Zext(RegOp): 1060 code = 'DestReg = merge(DestReg, bits(psrc1, op2, 0), dataSize);' 1061 1062 class Rddr(RegOp): 1063 def __init__(self, dest, src1, flags=None, dataSize="env.dataSize"): 1064 super(Rddr, self).__init__(dest, \ 1065 src1, "InstRegIndex(NUM_INTREGS)", flags, dataSize) 1066 code = ''' 1067 CR4 cr4 = CR4Op; 1068 DR7 dr7 = DR7Op; 1069 if ((cr4.de == 1 && (src1 == 4 || src1 == 5)) || src1 >= 8) { 1070 fault = new InvalidOpcode(); 1071 } else if (dr7.gd) { 1072 fault = new DebugException(); 1073 } else { 1074 DestReg = merge(DestReg, DebugSrc1, dataSize); 1075 } 1076 ''' 1077 1078 class Wrdr(RegOp): 1079 def __init__(self, dest, src1, flags=None, dataSize="env.dataSize"): 1080 super(Wrdr, self).__init__(dest, \ 1081 src1, "InstRegIndex(NUM_INTREGS)", flags, dataSize) 1082 code = ''' 1083 CR4 cr4 = CR4Op; 1084 DR7 dr7 = DR7Op; 1085 if ((cr4.de == 1 && (dest == 4 || dest == 5)) || dest >= 8) { 1086 fault = new InvalidOpcode(); 1087 } else if ((dest == 6 || dest == 7) && bits(psrc1, 63, 32) && 1088 machInst.mode.mode == LongMode) { 1089 fault = new GeneralProtection(0); 1090 } else if (dr7.gd) { 1091 fault = new DebugException(); 1092 } else { 1093 DebugDest = psrc1; 1094 } 1095 ''' 1096 1097 class Rdcr(RegOp): 1098 def __init__(self, dest, src1, flags=None, dataSize="env.dataSize"): 1099 super(Rdcr, self).__init__(dest, \ 1100 src1, "InstRegIndex(NUM_INTREGS)", flags, dataSize) 1101 code = ''' 1102 if (src1 == 1 || (src1 > 4 && src1 < 8) || (src1 > 8)) { 1103 fault = new InvalidOpcode(); 1104 } else { 1105 DestReg = merge(DestReg, ControlSrc1, dataSize); 1106 } 1107 ''' 1108 1109 class Wrcr(RegOp): 1110 def __init__(self, dest, src1, flags=None, dataSize="env.dataSize"): 1111 super(Wrcr, self).__init__(dest, \ 1112 src1, "InstRegIndex(NUM_INTREGS)", flags, dataSize) 1113 code = ''' 1114 if (dest == 1 || (dest > 4 && dest < 8) || (dest > 8)) { 1115 fault = new InvalidOpcode(); 1116 } else { 1117 // There are *s in the line below so it doesn't confuse the 1118 // parser. They may be unnecessary. 1119 //Mis*cReg old*Val = pick(Cont*rolDest, 0, dat*aSize); 1120 MiscReg newVal = psrc1; 1121 1122 // Check for any modifications that would cause a fault. 1123 switch(dest) { 1124 case 0: 1125 { 1126 Efer efer = EferOp; 1127 CR0 cr0 = newVal; 1128 CR4 oldCr4 = CR4Op; 1129 if (bits(newVal, 63, 32) || 1130 (!cr0.pe && cr0.pg) || 1131 (!cr0.cd && cr0.nw) || 1132 (cr0.pg && efer.lme && !oldCr4.pae)) 1133 fault = new GeneralProtection(0); 1134 } 1135 break; 1136 case 2: 1137 break; 1138 case 3: 1139 break; 1140 case 4: 1141 { 1142 CR4 cr4 = newVal; 1143 // PAE can't be disabled in long mode. 1144 if (bits(newVal, 63, 11) || 1145 (machInst.mode.mode == LongMode && !cr4.pae)) 1146 fault = new GeneralProtection(0); 1147 } 1148 break; 1149 case 8: 1150 { 1151 if (bits(newVal, 63, 4)) 1152 fault = new GeneralProtection(0); 1153 } 1154 default: 1155 panic("Unrecognized control register %d.\\n", dest); 1156 } 1157 ControlDest = newVal; 1158 } 1159 ''' 1160 1161 # Microops for manipulating segmentation registers 1162 class SegOp(CondRegOp): 1163 abstract = True 1164 def __init__(self, dest, src1, flags=None, dataSize="env.dataSize"): 1165 super(SegOp, self).__init__(dest, \ 1166 src1, "InstRegIndex(NUM_INTREGS)", flags, dataSize) 1167 1168 class Wrbase(SegOp): 1169 code = ''' 1170 SegBaseDest = psrc1; 1171 ''' 1172 1173 class Wrlimit(SegOp): 1174 code = ''' 1175 SegLimitDest = psrc1; 1176 ''' 1177 1178 class Wrsel(SegOp): 1179 code = ''' 1180 SegSelDest = psrc1; 1181 ''' 1182 1183 class WrAttr(SegOp): 1184 code = ''' 1185 SegAttrDest = psrc1; 1186 ''' 1187 1188 class Rdbase(SegOp): 1189 code = ''' 1190 DestReg = merge(DestReg, SegBaseSrc1, dataSize); 1191 ''' 1192 1193 class Rdlimit(SegOp): 1194 code = ''' 1195 DestReg = merge(DestReg, SegLimitSrc1, dataSize); 1196 ''' 1197 1198 class RdAttr(SegOp): 1199 code = ''' 1200 DestReg = merge(DestReg, SegAttrSrc1, dataSize); 1201 ''' 1202 1203 class Rdsel(SegOp): 1204 code = ''' 1205 DestReg = merge(DestReg, SegSelSrc1, dataSize); 1206 ''' 1207 1208 class Rdval(RegOp): 1209 def __init__(self, dest, src1, flags=None, dataSize="env.dataSize"): 1210 super(Rdval, self).__init__(dest, src1, \ 1211 "InstRegIndex(NUM_INTREGS)", flags, dataSize) 1212 code = ''' 1213 DestReg = MiscRegSrc1; 1214 ''' 1215 1216 class Wrval(RegOp): 1217 def __init__(self, dest, src1, flags=None, dataSize="env.dataSize"): 1218 super(Wrval, self).__init__(dest, src1, \ 1219 "InstRegIndex(NUM_INTREGS)", flags, dataSize) 1220 code = ''' 1221 MiscRegDest = SrcReg1; 1222 ''' 1223 1224 class Chks(RegOp): 1225 def __init__(self, dest, src1, src2=0, 1226 flags=None, dataSize="env.dataSize"): 1227 super(Chks, self).__init__(dest, 1228 src1, src2, flags, dataSize) 1229 code = ''' 1230 // The selector is in source 1 and can be at most 16 bits. 1231 SegSelector selector = DestReg; 1232 SegDescriptor desc = SrcReg1; 1233 HandyM5Reg m5reg = M5Reg; 1234 1235 switch (imm8) 1236 { 1237 case SegNoCheck: 1238 break; 1239 case SegCSCheck: 1240 // Make sure it's the right type 1241 if (desc.s == 0 || desc.type.codeOrData != 1) { 1242 fault = new GeneralProtection(0); 1243 } else if (m5reg.cpl != desc.dpl) { 1244 fault = new GeneralProtection(0); 1245 } 1246 break; 1247 case SegCallGateCheck: 1248 panic("CS checks for far calls/jumps through call gates" 1249 "not implemented.\\n"); 1250 break; 1251 case SegSoftIntGateCheck: 1252 // Check permissions. 1253 if (desc.dpl < m5reg.cpl) { 1254 fault = new GeneralProtection(selector); 1255 break; 1256 } 1257 // Fall through on purpose 1258 case SegIntGateCheck: 1259 // Make sure the gate's the right type. 1260 if ((m5reg.mode == LongMode && (desc.type & 0xe) != 0xe) || 1261 ((desc.type & 0x6) != 0x6)) { 1262 fault = new GeneralProtection(0); 1263 } 1264 break; 1265 case SegSSCheck: 1266 if (selector.si || selector.ti) { 1267 if (!desc.p) { 1268 fault = new StackFault(selector); 1269 } 1270 } else { 1271 if ((m5reg.submode != SixtyFourBitMode || 1272 m5reg.cpl == 3) || 1273 !(desc.s == 1 && 1274 desc.type.codeOrData == 0 && desc.type.w) || 1275 (desc.dpl != m5reg.cpl) || 1276 (selector.rpl != m5reg.cpl)) { 1277 fault = new GeneralProtection(selector); 1278 } 1279 } 1280 break; 1281 case SegIretCheck: 1282 { 1283 if ((!selector.si && !selector.ti) || 1284 (selector.rpl < m5reg.cpl) || 1285 !(desc.s == 1 && desc.type.codeOrData == 1) || 1286 (!desc.type.c && desc.dpl != selector.rpl) || 1287 (desc.type.c && desc.dpl > selector.rpl)) { 1288 fault = new GeneralProtection(selector); 1289 } else if (!desc.p) { 1290 fault = new SegmentNotPresent(selector); 1291 } 1292 break; 1293 } 1294 case SegIntCSCheck: 1295 if (m5reg.mode == LongMode) { 1296 if (desc.l != 1 || desc.d != 0) { 1297 fault = new GeneralProtection(selector); 1298 } 1299 } else { 1300 panic("Interrupt CS checks not implemented " 1301 "in legacy mode.\\n"); 1302 } 1303 break; 1304 case SegTRCheck: 1305 if (!selector.si || selector.ti) { 1306 fault = new GeneralProtection(selector); 1307 } 1308 break; 1309 case SegTSSCheck: 1310 if (!desc.p) { 1311 fault = new SegmentNotPresent(selector); 1312 } else if (!(desc.type == 0x9 || 1313 (desc.type == 1 && 1314 m5reg.mode != LongMode))) { 1315 fault = new GeneralProtection(selector); 1316 } 1317 break; 1318 case SegInGDTCheck: 1319 if (selector.ti) { 1320 fault = new GeneralProtection(selector); 1321 } 1322 break; 1323 case SegLDTCheck: 1324 if (!desc.p) { 1325 fault = new SegmentNotPresent(selector); 1326 } else if (desc.type != 0x2) { 1327 fault = new GeneralProtection(selector); 1328 } 1329 break; 1330 default: 1331 panic("Undefined segment check type.\\n"); 1332 } 1333 ''' 1334 flag_code = ''' 1335 // Check for a NULL selector and set ZF,EZF appropriately. 1336 ccFlagBits = ccFlagBits & ~(ext & (ZFBit | EZFBit)); 1337 if (!selector.si && !selector.ti) 1338 ccFlagBits = ccFlagBits | (ext & (ZFBit | EZFBit)); 1339 ''' 1340 1341 class Wrdh(RegOp): 1342 code = ''' 1343 SegDescriptor desc = SrcReg1; 1344 1345 uint64_t target = bits(SrcReg2, 31, 0) << 32; 1346 switch(desc.type) { 1347 case LDT64: 1348 case AvailableTSS64: 1349 case BusyTSS64: 1350 replaceBits(target, 23, 0, desc.baseLow); 1351 replaceBits(target, 31, 24, desc.baseHigh); 1352 break; 1353 case CallGate64: 1354 case IntGate64: 1355 case TrapGate64: 1356 replaceBits(target, 15, 0, bits(desc, 15, 0)); 1357 replaceBits(target, 31, 16, bits(desc, 63, 48)); 1358 break; 1359 default: 1360 panic("Wrdh used with wrong descriptor type!\\n"); 1361 } 1362 DestReg = target; 1363 ''' 1364 1365 class Wrtsc(WrRegOp): 1366 code = ''' 1367 TscOp = psrc1; 1368 ''' 1369 1370 class Rdtsc(RdRegOp): 1371 code = ''' 1372 DestReg = TscOp; 1373 ''' 1374 1375 class Rdm5reg(RdRegOp): 1376 code = ''' 1377 DestReg = M5Reg; 1378 ''' 1379 1380 class Wrdl(RegOp): 1381 code = ''' 1382 SegDescriptor desc = SrcReg1; 1383 SegSelector selector = SrcReg2; 1384 if (selector.si || selector.ti) { 1385 if (!desc.p) 1386 panic("Segment not present.\\n"); 1387 SegAttr attr = 0; 1388 attr.dpl = desc.dpl; 1389 attr.unusable = 0; 1390 attr.defaultSize = desc.d; 1391 attr.longMode = desc.l; 1392 attr.avl = desc.avl; 1393 attr.granularity = desc.g; 1394 attr.present = desc.p; 1395 attr.system = desc.s; 1396 attr.type = desc.type; 1397 if (!desc.s) { 1398 // The expand down bit happens to be set for gates. 1399 if (desc.type.e) { 1400 panic("Gate descriptor encountered.\\n"); 1401 } 1402 attr.readable = 1; 1403 attr.writable = 1; 1404 attr.expandDown = 0; 1405 } else { 1406 if (desc.type.codeOrData) { 1407 attr.expandDown = 0; 1408 attr.readable = desc.type.r; 1409 attr.writable = 0; 1410 } else { 1411 attr.expandDown = desc.type.e; 1412 attr.readable = 1; 1413 attr.writable = desc.type.w; 1414 } 1415 } 1416 Addr base = desc.baseLow | (desc.baseHigh << 24); 1417 Addr limit = desc.limitLow | (desc.limitHigh << 16); 1418 if (desc.g) 1419 limit = (limit << 12) | mask(12); 1420 SegBaseDest = base; 1421 SegLimitDest = limit; 1422 SegAttrDest = attr; 1423 } else { 1424 SegBaseDest = SegBaseDest; 1425 SegLimitDest = SegLimitDest; 1426 SegAttrDest = SegAttrDest; 1427 } 1428 ''' 1429}}; 1430