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