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 // Basic instruction class declaration template.
  32 def template BasicDeclare {{
  33         /**
  34          * Static instruction class for "%(mnemonic)s".
  35          */
  36         class %(class_name)s : public %(base_class)s
  37         {
  38           private:
  39             %(reg_idx_arr_decl)s;
  40           public:
  41             /// Constructor.
  42             %(class_name)s(MachInst machInst);
  43             Fault execute(ExecContext *,
  44                           Trace::InstRecord *) const override;
  45         };
  46 }};
  47
  48 // Basic instruction class constructor template.
  49 def template BasicConstructor {{
  50         %(class_name)s::%(class_name)s(MachInst machInst) :
  51             %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
  52         {
  53             %(set_reg_idx_arr)s;
  54             %(constructor)s;
  55         }
  56 }};
  57
  58
  59 // Basic instruction class execute method template.
  60 def template BasicExecute {{
  61         Fault %(class_name)s::execute(
  62             ExecContext *xc, Trace::InstRecord *traceData) const
  63         {
  64                 Fault fault = NoFault;
  65
  66                 %(fp_enable_check)s;
  67                 %(op_decl)s;
  68                 %(op_rd)s;
  69                 if(fault == NoFault)
  70                 {
  71                   %(code)s;
  72                   if(fault == NoFault){
  73                     %(op_wb)s;
  74                   }
  75                 }
  76                 return fault;
  77         }
  78 }};
  79
  80 // Basic decode template.
  81 def template BasicDecode {{
  82         return new %(class_name)s(machInst);
  83 }};
  84
  85 // Basic decode template, passing mnemonic in as string arg to constructor.
  86 def template BasicDecodeWithMnemonic {{
  87         return new %(class_name)s("%(mnemonic)s", machInst);
  88 }};
  89
  90 // The most basic instruction format...
  91 def format BasicOp(code, *flags) {{
  92         iop = InstObjParams(name, Name, 'MipsStaticInst', code, flags)
  93         header_output = BasicDeclare.subst(iop)
  94         decoder_output = BasicConstructor.subst(iop)
  95         decode_block = BasicDecode.subst(iop)
  96         exec_output = BasicExecute.subst(iop)
  97 }};