src/arch/x86/isa/microops/specop.isa

   1 // Copyright (c) 2007 The Hewlett-Packard Development Company
   2 // All rights reserved.
   3 //
   4 // Redistribution and use of this software in source and binary forms,
   5 // with or without modification, are permitted provided that the
   6 // following conditions are met:
   7 //
   8 // The software must be used only for Non-Commercial Use which means any
   9 // use which is NOT directed to receiving any direct monetary
  10 // compensation for, or commercial advantage from such use.  Illustrative
  11 // examples of non-commercial use are academic research, personal study,
  12 // teaching, education and corporate research & development.
  13 // Illustrative examples of commercial use are distributing products for
  14 // commercial advantage and providing services using the software for
  15 // commercial advantage.
  16 //
  17 // If you wish to use this software or functionality therein that may be
  18 // covered by patents for commercial use, please contact:
  19 //     Director of Intellectual Property Licensing
  20 //     Office of Strategy and Technology
  21 //     Hewlett-Packard Company
  22 //     1501 Page Mill Road
  23 //     Palo Alto, California  94304
  24 //
  25 // Redistributions of source code must retain the above copyright notice,
  26 // this list of conditions and the following disclaimer.  Redistributions
  27 // in binary form must reproduce the above copyright notice, this list of
  28 // conditions and the following disclaimer in the documentation and/or
  29 // other materials provided with the distribution.  Neither the name of
  30 // the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
  31 // contributors may be used to endorse or promote products derived from
  32 // this software without specific prior written permission.  No right of
  33 // sublicense is granted herewith.  Derivatives of the software and
  34 // output created using the software may be prepared, but only for
  35 // Non-Commercial Uses.  Derivatives of the software may be shared with
  36 // others provided: (i) the others agree to abide by the list of
  37 // conditions herein which includes the Non-Commercial Use restrictions;
  38 // and (ii) such Derivatives of the software include the above copyright
  39 // notice to acknowledge the contribution from this software where
  40 // applicable, this list of conditions and the disclaimer below.
  41 //
  42 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  43 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  44 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  45 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  46 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  47 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  48 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  49 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  50 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  51 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  52 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  53 //
  54 // Authors: Gabe Black
  55
  56 //////////////////////////////////////////////////////////////////////////
  57 //
  58 // Fault Microop
  59 //
  60 //////////////////////////////////////////////////////////////////////////
  61
  62 output header {{
  63     class MicroFaultBase : public X86ISA::X86MicroopBase
  64     {
  65       protected:
  66         Fault fault;
  67         uint8_t cc;
  68
  69       public:
  70         MicroFaultBase(ExtMachInst _machInst, const char * instMnem,
  71                 bool isMicro, bool isDelayed, bool isFirst, bool isLast,
  72                 Fault _fault, uint8_t _cc);
  73
  74         MicroFaultBase(ExtMachInst _machInst, const char * instMnem,
  75                 Fault _fault, uint8_t _cc);
  76
  77         std::string generateDisassembly(Addr pc,
  78                 const SymbolTable *symtab) const;
  79     };
  80 }};
  81
  82 def template MicroFaultDeclare {{
  83     class %(class_name)s : public %(base_class)s
  84     {
  85       private:
  86         void buildMe();
  87       public:
  88         %(class_name)s(ExtMachInst _machInst, const char * instMnem,
  89                 bool isMicro, bool isDelayed, bool isFirst, bool isLast,
  90                 Fault _fault, uint8_t _cc);
  91
  92         %(class_name)s(ExtMachInst _machInst, const char * instMnem,
  93                 Fault _fault, uint8_t _cc);
  94
  95         %(BasicExecDeclare)s
  96     };
  97 }};
  98
  99 def template MicroFaultExecute {{
 100         Fault %(class_name)s::execute(%(CPU_exec_context)s *xc,
 101                 Trace::InstRecord *traceData) const
 102         {
 103             %(op_decl)s;
 104             %(op_rd)s;
 105             if (%(cond_test)s) {
 106                 //Return the fault we were constructed with
 107                 return fault;
 108             } else {
 109                 return NoFault;
 110             }
 111         }
 112 }};
 113
 114 output decoder {{
 115     inline MicroFaultBase::MicroFaultBase(
 116             ExtMachInst machInst, const char * instMnem,
 117             Fault _fault, uint8_t _cc) :
 118         X86MicroopBase(machInst, "fault", instMnem,
 119                 false, false, false, false, No_OpClass),
 120         fault(_fault), cc(_cc)
 121     {
 122     }
 123
 124     inline MicroFaultBase::MicroFaultBase(
 125             ExtMachInst machInst, const char * instMnem,
 126             bool isMicro, bool isDelayed, bool isFirst, bool isLast,
 127             Fault _fault, uint8_t _cc) :
 128         X86MicroopBase(machInst, "fault", instMnem,
 129                 isMicro, isDelayed, isFirst, isLast, No_OpClass),
 130                 fault(_fault), cc(_cc)
 131     {
 132     }
 133 }};
 134
 135 def template MicroFaultConstructor {{
 136
 137     inline void %(class_name)s::buildMe()
 138     {
 139         %(constructor)s;
 140     }
 141
 142     inline %(class_name)s::%(class_name)s(
 143             ExtMachInst machInst, const char * instMnem,
 144             Fault _fault, uint8_t _cc) :
 145         %(base_class)s(machInst, instMnem, _fault, _cc)
 146     {
 147         buildMe();
 148     }
 149
 150     inline %(class_name)s::%(class_name)s(
 151             ExtMachInst machInst, const char * instMnem,
 152             bool isMicro, bool isDelayed, bool isFirst, bool isLast,
 153             Fault _fault, uint8_t _cc) :
 154         %(base_class)s(machInst, instMnem,
 155                 isMicro, isDelayed, isFirst, isLast, _fault, _cc)
 156     {
 157         buildMe();
 158     }
 159 }};
 160
 161 output decoder {{
 162     std::string MicroFaultBase::generateDisassembly(Addr pc,
 163             const SymbolTable *symtab) const
 164     {
 165         std::stringstream response;
 166
 167         printMnemonic(response, instMnem, mnemonic);
 168         if(fault)
 169             response << fault->name();
 170         else
 171             response << "No Fault";
 172
 173         return response.str();
 174     }
 175 }};
 176
 177 let {{
 178     class Fault(X86Microop):
 179         className = "MicroFault"
 180         def __init__(self, fault, flags=None):
 181             self.fault = fault
 182             if flags:
 183                 if not isinstance(flags, (list, tuple)):
 184                     raise Exception, "flags must be a list or tuple of flags"
 185                 self.cond = " | ".join(flags)
 186                 self.className += "Flags"
 187             else:
 188                 self.cond = "0"
 189
 190         def getAllocator(self, *microFlags):
 191             allocator = '''new %(class_name)s(machInst, mnemonic
 192                     %(flags)s, %(fault)s, %(cc)s)''' % {
 193                 "class_name" : self.className,
 194                 "flags" : self.microFlagsText(microFlags),
 195                 "fault" : self.fault,
 196                 "cc" : self.cond}
 197             return allocator
 198
 199     iop = InstObjParams("fault", "MicroFault", "MicroFaultBase",
 200             {"code": "",
 201              "cond_test": "checkCondition(ccFlagBits, cc)"})
 202     exec_output = MicroFaultExecute.subst(iop)
 203     header_output = MicroFaultDeclare.subst(iop)
 204     decoder_output = MicroFaultConstructor.subst(iop)
 205     iop = InstObjParams("fault", "MicroFaultFlags", "MicroFaultBase",
 206             {"code": "",
 207              "cond_test": "true"})
 208     exec_output += MicroFaultExecute.subst(iop)
 209     header_output += MicroFaultDeclare.subst(iop)
 210     decoder_output += MicroFaultConstructor.subst(iop)
 211     microopClasses["fault"] = Fault
 212 }};