src/arch/mips/isa/formats/basic.isa

   1 // -*- mode:c++ -*-
   2
   3 // -*- mode:c++ -*-
   4
   5 // Copyright (c) 2003-2005 The Regents of The University of Michigan
   6 // All rights reserved.
   7 //
   8 // Redistribution and use in source and binary forms, with or without
   9 // modification, are permitted provided that the following conditions are
  10 // met: redistributions of source code must retain the above copyright
  11 // notice, this list of conditions and the following disclaimer;
  12 // redistributions in binary form must reproduce the above copyright
  13 // notice, this list of conditions and the following disclaimer in the
  14 // documentation and/or other materials provided with the distribution;
  15 // neither the name of the copyright holders nor the names of its
  16 // contributors may be used to endorse or promote products derived from
  17 // this software without specific prior written permission.
  18 //
  19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 //
  31 // Authors: Steve Reinhardt
  32 //          Korey Sewell
  33
  34 // Declarations for execute() methods.
  35 def template BasicExecDeclare {{
  36         Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const;
  37 }};
  38
  39 // Basic instruction class declaration template.
  40 def template BasicDeclare {{
  41         /**
  42          * Static instruction class for "%(mnemonic)s".
  43          */
  44         class %(class_name)s : public %(base_class)s
  45         {
  46           public:
  47                 /// Constructor.
  48                 %(class_name)s(MachInst machInst);
  49                 %(BasicExecDeclare)s
  50         };
  51 }};
  52
  53 // Basic instruction class constructor template.
  54 def template BasicConstructor {{
  55         inline %(class_name)s::%(class_name)s(MachInst machInst)  : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
  56         {
  57                 %(constructor)s;
  58         }
  59 }};
  60
  61
  62 // Basic instruction class execute method template.
  63 def template BasicExecute {{
  64         Fault %(class_name)s::execute(%(CPU_exec_context)s *xc, Trace::InstRecord *traceData) const
  65         {
  66                 Fault fault = NoFault;
  67
  68                 %(fp_enable_check)s;
  69                 %(op_decl)s;
  70                 %(op_rd)s;
  71                 if(fault == NoFault)
  72                 {
  73                   %(code)s;
  74                   if(fault == NoFault){
  75                     %(op_wb)s;
  76                   }
  77                 }
  78                 return fault;
  79         }
  80 }};
  81
  82 // Basic decode template.
  83 def template BasicDecode {{
  84         return new %(class_name)s(machInst);
  85 }};
  86
  87 // Basic decode template, passing mnemonic in as string arg to constructor.
  88 def template BasicDecodeWithMnemonic {{
  89         return new %(class_name)s("%(mnemonic)s", machInst);
  90 }};
  91
  92 // The most basic instruction format...
  93 def format BasicOp(code, *flags) {{
  94         iop = InstObjParams(name, Name, 'MipsStaticInst', code, flags)
  95         header_output = BasicDeclare.subst(iop)
  96         decoder_output = BasicConstructor.subst(iop)
  97         decode_block = BasicDecode.subst(iop)
  98         exec_output = BasicExecute.subst(iop)
  99 }};