src/mem/ruby/slicc_interface/AbstractCacheEntry.hh

   1
   2 /*
   3  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are
   8  * met: redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer;
  10  * redistributions in binary form must reproduce the above copyright
  11  * notice, this list of conditions and the following disclaimer in the
  12  * documentation and/or other materials provided with the distribution;
  13  * neither the name of the copyright holders nor the names of its
  14  * contributors may be used to endorse or promote products derived from
  15  * this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 /*
  31  * $Id$
  32  *
  33  * Description: Common base class for a machine node.
  34  *
  35  */
  36
  37 #ifndef AbstractCacheEntry_H
  38 #define AbstractCacheEntry_H
  39
  40 #include "mem/ruby/common/Global.hh"
  41 #include "mem/ruby/common/Address.hh"
  42 #include "mem/protocol/AccessPermission.hh"
  43
  44 class DataBlock;
  45
  46 class AbstractCacheEntry {
  47 public:
  48   // Constructors
  49   AbstractCacheEntry();
  50
  51   // Destructor, prevent it from instantiation
  52   virtual ~AbstractCacheEntry() = 0;
  53
  54   // Public Methods
  55
  56   // The methods below are those called by ruby runtime, add when it is
  57   // absolutely necessary and should all be virtual function.
  58   virtual DataBlock& getDataBlk() = 0;
  59
  60
  61   virtual void print(ostream& out) const = 0;
  62
  63   // Data Members (m_ prefix)
  64   Address m_Address; // Address of this block, required by CacheMemory
  65   Time m_LastRef; // Last time this block was referenced, required by CacheMemory
  66   AccessPermission m_Permission; // Access permission for this block, required by CacheMemory
  67 };
  68
  69 // Output operator declaration
  70 ostream& operator<<(ostream& out, const AbstractCacheEntry& obj);
  71
  72 // ******************* Definitions *******************
  73
  74 // Output operator definition
  75 extern inline
  76 ostream& operator<<(ostream& out, const AbstractCacheEntry& obj)
  77 {
  78   obj.print(out);
  79   out << flush;
  80   return out;
  81 }
  82
  83 #endif //AbstractCacheEntry_H
  84