xref: /gem5/src/mem/ruby/slicc_interface/AbstractCacheEntry.hh

/*
 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * $Id$
 *
 * Description: Common base class for a machine node.
 *
 */

#ifndef AbstractCacheEntry_H
#define AbstractCacheEntry_H

#include "Global.hh"
#include "Address.hh"
#include "AccessPermission.hh"

class AbstractCacheEntry {
public:
  // Constructors
  AbstractCacheEntry();

  // Destructor, prevent it from instantiation
  virtual ~AbstractCacheEntry() = 0;

  // Public Methods

  // The methods below are those called by ruby runtime, add when it is
  // absolutely necessary and should all be virtual function.


  virtual void print(ostream& out) const = 0;

  // Data Members (m_ prefix)
  Address m_Address; // Address of this block, required by CacheMemory
  Time m_LastRef; // Last time this block was referenced, required by CacheMemory
  AccessPermission m_Permission; // Access permission for this block, required by CacheMemory
};

// Output operator declaration
ostream& operator<<(ostream& out, const AbstractCacheEntry& obj);

// ******************* Definitions *******************

// Output operator definition
extern inline
ostream& operator<<(ostream& out, const AbstractCacheEntry& obj)
{
  obj.print(out);
  out << flush;
  return out;
}

#endif //AbstractCacheEntry_H