basic.isa revision 5789
1// Copyright (c) 2007 The Regents of The University of Michigan 2// All rights reserved. 3// 4// Redistribution and use in source and binary forms, with or without 5// modification, are permitted provided that the following conditions are 6// met: redistributions of source code must retain the above copyright 7// notice, this list of conditions and the following disclaimer; 8// redistributions in binary form must reproduce the above copyright 9// notice, this list of conditions and the following disclaimer in the 10// documentation and/or other materials provided with the distribution; 11// neither the name of the copyright holders nor the names of its 12// contributors may be used to endorse or promote products derived from 13// this software without specific prior written permission. 14// 15// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 16// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 17// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 18// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 19// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 20// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 21// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 25// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26// 27// Authors: Gabe Black 28 29// Copyright (c) 2007 The Hewlett-Packard Development Company 30// All rights reserved. 31// 32// Redistribution and use of this software in source and binary forms, 33// with or without modification, are permitted provided that the 34// following conditions are met: 35// 36// The software must be used only for Non-Commercial Use which means any 37// use which is NOT directed to receiving any direct monetary 38// compensation for, or commercial advantage from such use. Illustrative 39// examples of non-commercial use are academic research, personal study, 40// teaching, education and corporate research & development. 41// Illustrative examples of commercial use are distributing products for 42// commercial advantage and providing services using the software for 43// commercial advantage. 44// 45// If you wish to use this software or functionality therein that may be 46// covered by patents for commercial use, please contact: 47// Director of Intellectual Property Licensing 48// Office of Strategy and Technology 49// Hewlett-Packard Company 50// 1501 Page Mill Road 51// Palo Alto, California 94304 52// 53// Redistributions of source code must retain the above copyright notice, 54// this list of conditions and the following disclaimer. Redistributions 55// in binary form must reproduce the above copyright notice, this list of 56// conditions and the following disclaimer in the documentation and/or 57// other materials provided with the distribution. Neither the name of 58// the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its 59// contributors may be used to endorse or promote products derived from 60// this software without specific prior written permission. No right of 61// sublicense is granted herewith. Derivatives of the software and 62// output created using the software may be prepared, but only for 63// Non-Commercial Uses. Derivatives of the software may be shared with 64// others provided: (i) the others agree to abide by the list of 65// conditions herein which includes the Non-Commercial Use restrictions; 66// and (ii) such Derivatives of the software include the above copyright 67// notice to acknowledge the contribution from this software where 68// applicable, this list of conditions and the disclaimer below. 69// 70// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 71// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 72// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 73// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 74// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 75// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 76// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 77// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 78// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 79// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 80// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 81// 82// Authors: Gabe Black 83 84// Declarations for execute() methods. 85def template BasicExecDeclare {{ 86 Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const; 87}}; 88 89// Definitions of execute methods that panic. 90def template BasicExecPanic {{ 91 Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const 92 { 93 panic("Execute method called when it shouldn't!"); 94 M5_DUMMY_RETURN 95 } 96}}; 97 98// Basic instruction class declaration template. 99def template BasicDeclare {{ 100 /** 101 * Static instruction class for "%(mnemonic)s". 102 */ 103 class %(class_name)s : public %(base_class)s 104 { 105 public: 106 // Constructor. 107 %(class_name)s(ExtMachInst machInst); 108 %(BasicExecDeclare)s 109 }; 110}}; 111 112// Basic instruction class constructor template. 113def template BasicConstructor {{ 114 inline %(class_name)s::%(class_name)s(ExtMachInst machInst) 115 : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s) 116 { 117 %(constructor)s; 118 } 119}}; 120 121// Basic instruction class execute method template. 122def template BasicExecute {{ 123 Fault %(class_name)s::execute(%(CPU_exec_context)s *xc, 124 Trace::InstRecord *traceData) const 125 { 126 Fault fault = NoFault; 127 128 %(fp_enable_check)s; 129 %(op_decl)s; 130 %(op_rd)s; 131 %(code)s; 132 133 if(fault == NoFault) 134 { 135 %(op_wb)s; 136 } 137 return fault; 138 } 139}}; 140 141// Basic decode template. 142def template BasicDecode {{ 143 return new %(class_name)s(machInst); 144}}; 145 146// Basic decode template, passing mnemonic in as string arg to constructor. 147def template BasicDecodeWithMnemonic {{ 148 return new %(class_name)s("%(mnemonic)s", machInst); 149}}; 150 151def format BasicOperate(code, *flags) {{ 152 iop = InstObjParams(name, Name, 'X86ISA::X86StaticInst', code, flags) 153 header_output = BasicDeclare.subst(iop) 154 decoder_output = BasicConstructor.subst(iop) 155 decode_block = BasicDecode.subst(iop) 156 exec_output = BasicExecute.subst(iop) 157}}; 158