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

   1 // Copyright (c) 2007-2008 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     class MicroHalt : public X86ISA::X86MicroopBase
  82     {
  83       public:
  84         MicroHalt(ExtMachInst _machInst, const char * instMnem,
  85                 bool isMicro, bool isDelayed, bool isFirst, bool isLast) :
  86             X86MicroopBase(_machInst, "halt", instMnem,
  87                     isMicro, isDelayed, isFirst, isLast, No_OpClass)
  88         {
  89         }
  90
  91         MicroHalt(ExtMachInst _machInst, const char * instMnem) :
  92             X86MicroopBase(_machInst, "halt", instMnem,
  93                     false, false, false, false, No_OpClass)
  94         {
  95         }
  96
  97         %(BasicExecDeclare)s
  98
  99         std::string generateDisassembly(Addr pc,
 100                 const SymbolTable *symtab) const;
 101     };
 102 }};
 103
 104 def template MicroFaultDeclare {{
 105     class %(class_name)s : public %(base_class)s
 106     {
 107       private:
 108         void buildMe();
 109       public:
 110         %(class_name)s(ExtMachInst _machInst, const char * instMnem,
 111                 bool isMicro, bool isDelayed, bool isFirst, bool isLast,
 112                 Fault _fault, uint8_t _cc);
 113
 114         %(class_name)s(ExtMachInst _machInst, const char * instMnem,
 115                 Fault _fault, uint8_t _cc);
 116
 117         %(BasicExecDeclare)s
 118     };
 119 }};
 120
 121 def template MicroFaultExecute {{
 122         Fault %(class_name)s::execute(%(CPU_exec_context)s *xc,
 123                 Trace::InstRecord *traceData) const
 124         {
 125             %(op_decl)s;
 126             %(op_rd)s;
 127             if (%(cond_test)s) {
 128                 //Return the fault we were constructed with
 129                 return fault;
 130             } else {
 131                 return NoFault;
 132             }
 133         }
 134 }};
 135
 136 output exec {{
 137     Fault
 138     MicroHalt::execute(%(CPU_exec_context)s *xc,
 139             Trace::InstRecord * traceData) const
 140     {
 141         xc->tcBase()->suspend();
 142         return NoFault;
 143     }
 144 }};
 145
 146 output decoder {{
 147     inline MicroFaultBase::MicroFaultBase(
 148             ExtMachInst machInst, const char * instMnem,
 149             Fault _fault, uint8_t _cc) :
 150         X86MicroopBase(machInst, "fault", instMnem,
 151                 false, false, false, false, No_OpClass),
 152         fault(_fault), cc(_cc)
 153     {
 154     }
 155
 156     inline MicroFaultBase::MicroFaultBase(
 157             ExtMachInst machInst, const char * instMnem,
 158             bool isMicro, bool isDelayed, bool isFirst, bool isLast,
 159             Fault _fault, uint8_t _cc) :
 160         X86MicroopBase(machInst, "fault", instMnem,
 161                 isMicro, isDelayed, isFirst, isLast, No_OpClass),
 162                 fault(_fault), cc(_cc)
 163     {
 164     }
 165 }};
 166
 167 def template MicroFaultConstructor {{
 168
 169     inline void %(class_name)s::buildMe()
 170     {
 171         %(constructor)s;
 172     }
 173
 174     inline %(class_name)s::%(class_name)s(
 175             ExtMachInst machInst, const char * instMnem,
 176             Fault _fault, uint8_t _cc) :
 177         %(base_class)s(machInst, instMnem, _fault, _cc)
 178     {
 179         buildMe();
 180     }
 181
 182     inline %(class_name)s::%(class_name)s(
 183             ExtMachInst machInst, const char * instMnem,
 184             bool isMicro, bool isDelayed, bool isFirst, bool isLast,
 185             Fault _fault, uint8_t _cc) :
 186         %(base_class)s(machInst, instMnem,
 187                 isMicro, isDelayed, isFirst, isLast, _fault, _cc)
 188     {
 189         buildMe();
 190     }
 191 }};
 192
 193 output decoder {{
 194     std::string MicroFaultBase::generateDisassembly(Addr pc,
 195             const SymbolTable *symtab) const
 196     {
 197         std::stringstream response;
 198
 199         printMnemonic(response, instMnem, mnemonic);
 200         if(fault)
 201             response << fault->name();
 202         else
 203             response << "No Fault";
 204
 205         return response.str();
 206     }
 207
 208     std::string MicroHalt::generateDisassembly(Addr pc,
 209             const SymbolTable *symtab) const
 210     {
 211         std::stringstream response;
 212
 213         printMnemonic(response, instMnem, mnemonic);
 214
 215         return response.str();
 216     }
 217 }};
 218
 219 let {{
 220     class Fault(X86Microop):
 221         className = "MicroFault"
 222         def __init__(self, fault, flags=None):
 223             self.fault = fault
 224             if flags:
 225                 if not isinstance(flags, (list, tuple)):
 226                     raise Exception, "flags must be a list or tuple of flags"
 227                 self.cond = " | ".join(flags)
 228                 self.className += "Flags"
 229             else:
 230                 self.cond = "0"
 231
 232         def getAllocator(self, *microFlags):
 233             allocator = '''new %(class_name)s(machInst, macrocodeBlock
 234                     %(flags)s, %(fault)s, %(cc)s)''' % {
 235                 "class_name" : self.className,
 236                 "flags" : self.microFlagsText(microFlags),
 237                 "fault" : self.fault,
 238                 "cc" : self.cond}
 239             return allocator
 240
 241     iop = InstObjParams("fault", "MicroFaultFlags", "MicroFaultBase",
 242             {"code": "",
 243              "cond_test": "checkCondition(ccFlagBits, cc)"})
 244     exec_output = MicroFaultExecute.subst(iop)
 245     header_output = MicroFaultDeclare.subst(iop)
 246     decoder_output = MicroFaultConstructor.subst(iop)
 247     iop = InstObjParams("fault", "MicroFault", "MicroFaultBase",
 248             {"code": "",
 249              "cond_test": "true"})
 250     exec_output += MicroFaultExecute.subst(iop)
 251     header_output += MicroFaultDeclare.subst(iop)
 252     decoder_output += MicroFaultConstructor.subst(iop)
 253     microopClasses["fault"] = Fault
 254
 255     class Halt(X86Microop):
 256         className = "MicroHalt"
 257         def __init__(self):
 258             pass
 259
 260         def getAllocator(self, *microFlags):
 261             return "new MicroHalt(machInst, macrocodeBlock %s)" % \
 262                     self.microFlagsText(microFlags)
 263
 264     microopClasses["halt"] = Halt
 265 }};