unimp.isa revision 4679
14276Sgblack@eecs.umich.edu// -*- mode:c++ -*- 24276Sgblack@eecs.umich.edu 34276Sgblack@eecs.umich.edu// Copyright (c) 2007 The Hewlett-Packard Development Company 44276Sgblack@eecs.umich.edu// All rights reserved. 54276Sgblack@eecs.umich.edu// 64276Sgblack@eecs.umich.edu// Redistribution and use of this software in source and binary forms, 74276Sgblack@eecs.umich.edu// with or without modification, are permitted provided that the 84276Sgblack@eecs.umich.edu// following conditions are met: 94276Sgblack@eecs.umich.edu// 104276Sgblack@eecs.umich.edu// The software must be used only for Non-Commercial Use which means any 114276Sgblack@eecs.umich.edu// use which is NOT directed to receiving any direct monetary 124276Sgblack@eecs.umich.edu// compensation for, or commercial advantage from such use. Illustrative 134276Sgblack@eecs.umich.edu// examples of non-commercial use are academic research, personal study, 144276Sgblack@eecs.umich.edu// teaching, education and corporate research & development. 154276Sgblack@eecs.umich.edu// Illustrative examples of commercial use are distributing products for 164276Sgblack@eecs.umich.edu// commercial advantage and providing services using the software for 174276Sgblack@eecs.umich.edu// commercial advantage. 184276Sgblack@eecs.umich.edu// 194276Sgblack@eecs.umich.edu// If you wish to use this software or functionality therein that may be 204276Sgblack@eecs.umich.edu// covered by patents for commercial use, please contact: 214276Sgblack@eecs.umich.edu// Director of Intellectual Property Licensing 224276Sgblack@eecs.umich.edu// Office of Strategy and Technology 234276Sgblack@eecs.umich.edu// Hewlett-Packard Company 244276Sgblack@eecs.umich.edu// 1501 Page Mill Road 254276Sgblack@eecs.umich.edu// Palo Alto, California 94304 264276Sgblack@eecs.umich.edu// 274276Sgblack@eecs.umich.edu// Redistributions of source code must retain the above copyright notice, 284276Sgblack@eecs.umich.edu// this list of conditions and the following disclaimer. Redistributions 294276Sgblack@eecs.umich.edu// in binary form must reproduce the above copyright notice, this list of 304276Sgblack@eecs.umich.edu// conditions and the following disclaimer in the documentation and/or 314276Sgblack@eecs.umich.edu// other materials provided with the distribution. Neither the name of 324276Sgblack@eecs.umich.edu// the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its 334276Sgblack@eecs.umich.edu// contributors may be used to endorse or promote products derived from 344276Sgblack@eecs.umich.edu// this software without specific prior written permission. No right of 354276Sgblack@eecs.umich.edu// sublicense is granted herewith. Derivatives of the software and 364276Sgblack@eecs.umich.edu// output created using the software may be prepared, but only for 374276Sgblack@eecs.umich.edu// Non-Commercial Uses. Derivatives of the software may be shared with 384276Sgblack@eecs.umich.edu// others provided: (i) the others agree to abide by the list of 394276Sgblack@eecs.umich.edu// conditions herein which includes the Non-Commercial Use restrictions; 404276Sgblack@eecs.umich.edu// and (ii) such Derivatives of the software include the above copyright 414276Sgblack@eecs.umich.edu// notice to acknowledge the contribution from this software where 424276Sgblack@eecs.umich.edu// applicable, this list of conditions and the disclaimer below. 434276Sgblack@eecs.umich.edu// 444276Sgblack@eecs.umich.edu// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 454276Sgblack@eecs.umich.edu// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 464276Sgblack@eecs.umich.edu// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 474276Sgblack@eecs.umich.edu// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 484276Sgblack@eecs.umich.edu// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 494276Sgblack@eecs.umich.edu// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 504276Sgblack@eecs.umich.edu// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 514276Sgblack@eecs.umich.edu// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 524276Sgblack@eecs.umich.edu// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 534276Sgblack@eecs.umich.edu// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 544276Sgblack@eecs.umich.edu// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 554276Sgblack@eecs.umich.edu// 564276Sgblack@eecs.umich.edu// Authors: Gabe Black 574276Sgblack@eecs.umich.edu 584276Sgblack@eecs.umich.edu//////////////////////////////////////////////////////////////////// 594276Sgblack@eecs.umich.edu// 604276Sgblack@eecs.umich.edu// Unimplemented instructions 614276Sgblack@eecs.umich.edu// 624276Sgblack@eecs.umich.edu 634276Sgblack@eecs.umich.eduoutput header {{ 644276Sgblack@eecs.umich.edu /** 654276Sgblack@eecs.umich.edu * Static instruction class for unimplemented instructions that 664276Sgblack@eecs.umich.edu * cause simulator termination. Note that these are recognized 674276Sgblack@eecs.umich.edu * (legal) instructions that the simulator does not support; the 684276Sgblack@eecs.umich.edu * 'Unknown' class is used for unrecognized/illegal instructions. 694276Sgblack@eecs.umich.edu * This is a leaf class. 704276Sgblack@eecs.umich.edu */ 714679Sgblack@eecs.umich.edu class FailUnimplemented : public X86ISA::X86StaticInst 724276Sgblack@eecs.umich.edu { 734276Sgblack@eecs.umich.edu public: 744276Sgblack@eecs.umich.edu /// Constructor 754276Sgblack@eecs.umich.edu FailUnimplemented(const char *_mnemonic, ExtMachInst _machInst) 764679Sgblack@eecs.umich.edu : X86ISA::X86StaticInst(_mnemonic, _machInst, No_OpClass) 774276Sgblack@eecs.umich.edu { 784276Sgblack@eecs.umich.edu // don't call execute() (which panics) if we're on a 794276Sgblack@eecs.umich.edu // speculative path 804276Sgblack@eecs.umich.edu flags[IsNonSpeculative] = true; 814276Sgblack@eecs.umich.edu } 824276Sgblack@eecs.umich.edu 834276Sgblack@eecs.umich.edu %(BasicExecDeclare)s 844276Sgblack@eecs.umich.edu 854276Sgblack@eecs.umich.edu std::string 864276Sgblack@eecs.umich.edu generateDisassembly(Addr pc, const SymbolTable *symtab) const; 874276Sgblack@eecs.umich.edu }; 884276Sgblack@eecs.umich.edu 894276Sgblack@eecs.umich.edu /** 904276Sgblack@eecs.umich.edu * Base class for unimplemented instructions that cause a warning 914276Sgblack@eecs.umich.edu * to be printed (but do not terminate simulation). This 924276Sgblack@eecs.umich.edu * implementation is a little screwy in that it will print a 934276Sgblack@eecs.umich.edu * warning for each instance of a particular unimplemented machine 944276Sgblack@eecs.umich.edu * instruction, not just for each unimplemented opcode. Should 954276Sgblack@eecs.umich.edu * probably make the 'warned' flag a static member of the derived 964276Sgblack@eecs.umich.edu * class. 974276Sgblack@eecs.umich.edu */ 984679Sgblack@eecs.umich.edu class WarnUnimplemented : public X86ISA::X86StaticInst 994276Sgblack@eecs.umich.edu { 1004276Sgblack@eecs.umich.edu private: 1014276Sgblack@eecs.umich.edu /// Have we warned on this instruction yet? 1024276Sgblack@eecs.umich.edu mutable bool warned; 1034276Sgblack@eecs.umich.edu 1044276Sgblack@eecs.umich.edu public: 1054276Sgblack@eecs.umich.edu /// Constructor 1064276Sgblack@eecs.umich.edu WarnUnimplemented(const char *_mnemonic, ExtMachInst _machInst) 1074679Sgblack@eecs.umich.edu : X86ISA::X86StaticInst(_mnemonic, _machInst, No_OpClass), warned(false) 1084276Sgblack@eecs.umich.edu { 1094276Sgblack@eecs.umich.edu // don't call execute() (which panics) if we're on a 1104276Sgblack@eecs.umich.edu // speculative path 1114276Sgblack@eecs.umich.edu flags[IsNonSpeculative] = true; 1124276Sgblack@eecs.umich.edu } 1134276Sgblack@eecs.umich.edu 1144276Sgblack@eecs.umich.edu %(BasicExecDeclare)s 1154276Sgblack@eecs.umich.edu 1164276Sgblack@eecs.umich.edu std::string 1174276Sgblack@eecs.umich.edu generateDisassembly(Addr pc, const SymbolTable *symtab) const; 1184276Sgblack@eecs.umich.edu }; 1194276Sgblack@eecs.umich.edu}}; 1204276Sgblack@eecs.umich.edu 1214276Sgblack@eecs.umich.eduoutput decoder {{ 1224276Sgblack@eecs.umich.edu std::string 1234276Sgblack@eecs.umich.edu FailUnimplemented::generateDisassembly(Addr pc, 1244276Sgblack@eecs.umich.edu const SymbolTable *symtab) const 1254276Sgblack@eecs.umich.edu { 1264276Sgblack@eecs.umich.edu return csprintf("%-10s (unimplemented)", mnemonic); 1274276Sgblack@eecs.umich.edu } 1284276Sgblack@eecs.umich.edu 1294276Sgblack@eecs.umich.edu std::string 1304276Sgblack@eecs.umich.edu WarnUnimplemented::generateDisassembly(Addr pc, 1314276Sgblack@eecs.umich.edu const SymbolTable *symtab) const 1324276Sgblack@eecs.umich.edu { 1334276Sgblack@eecs.umich.edu#ifdef SS_COMPATIBLE_DISASSEMBLY 1344276Sgblack@eecs.umich.edu return csprintf("%-10s", mnemonic); 1354276Sgblack@eecs.umich.edu#else 1364276Sgblack@eecs.umich.edu return csprintf("%-10s (unimplemented)", mnemonic); 1374276Sgblack@eecs.umich.edu#endif 1384276Sgblack@eecs.umich.edu } 1394276Sgblack@eecs.umich.edu}}; 1404276Sgblack@eecs.umich.edu 1414276Sgblack@eecs.umich.eduoutput exec {{ 1424276Sgblack@eecs.umich.edu Fault 1434276Sgblack@eecs.umich.edu FailUnimplemented::execute(%(CPU_exec_context)s *xc, 1444276Sgblack@eecs.umich.edu Trace::InstRecord *traceData) const 1454276Sgblack@eecs.umich.edu { 1464276Sgblack@eecs.umich.edu panic("attempt to execute unimplemented instruction '%s' %s", 1474276Sgblack@eecs.umich.edu mnemonic, machInst); 1484276Sgblack@eecs.umich.edu return NoFault; 1494276Sgblack@eecs.umich.edu } 1504276Sgblack@eecs.umich.edu 1514276Sgblack@eecs.umich.edu Fault 1524276Sgblack@eecs.umich.edu WarnUnimplemented::execute(%(CPU_exec_context)s *xc, 1534276Sgblack@eecs.umich.edu Trace::InstRecord *traceData) const 1544276Sgblack@eecs.umich.edu { 1554276Sgblack@eecs.umich.edu if (!warned) { 1564276Sgblack@eecs.umich.edu warn("instruction '%s' unimplemented\n", mnemonic); 1574276Sgblack@eecs.umich.edu warned = true; 1584276Sgblack@eecs.umich.edu } 1594276Sgblack@eecs.umich.edu 1604276Sgblack@eecs.umich.edu return NoFault; 1614276Sgblack@eecs.umich.edu } 1624276Sgblack@eecs.umich.edu}}; 1634276Sgblack@eecs.umich.edu 1644276Sgblack@eecs.umich.edu 1654276Sgblack@eecs.umich.edudef format FailUnimpl() {{ 1664276Sgblack@eecs.umich.edu iop = InstObjParams(name, 'FailUnimplemented') 1674276Sgblack@eecs.umich.edu decode_block = BasicDecodeWithMnemonic.subst(iop) 1684276Sgblack@eecs.umich.edu}}; 1694276Sgblack@eecs.umich.edu 1704276Sgblack@eecs.umich.edudef format WarnUnimpl() {{ 1714276Sgblack@eecs.umich.edu iop = InstObjParams(name, 'WarnUnimplemented') 1724276Sgblack@eecs.umich.edu decode_block = BasicDecodeWithMnemonic.subst(iop) 1734276Sgblack@eecs.umich.edu}}; 1744276Sgblack@eecs.umich.edu 175