AbstractCacheEntry.hh revision 6145
16145Snate@binkert.org
26145Snate@binkert.org/*
36145Snate@binkert.org * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
46145Snate@binkert.org * All rights reserved.
56145Snate@binkert.org *
66145Snate@binkert.org * Redistribution and use in source and binary forms, with or without
76145Snate@binkert.org * modification, are permitted provided that the following conditions are
86145Snate@binkert.org * met: redistributions of source code must retain the above copyright
96145Snate@binkert.org * notice, this list of conditions and the following disclaimer;
106145Snate@binkert.org * redistributions in binary form must reproduce the above copyright
116145Snate@binkert.org * notice, this list of conditions and the following disclaimer in the
126145Snate@binkert.org * documentation and/or other materials provided with the distribution;
136145Snate@binkert.org * neither the name of the copyright holders nor the names of its
146145Snate@binkert.org * contributors may be used to endorse or promote products derived from
156145Snate@binkert.org * this software without specific prior written permission.
166145Snate@binkert.org *
176145Snate@binkert.org * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
186145Snate@binkert.org * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
196145Snate@binkert.org * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
206145Snate@binkert.org * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
216145Snate@binkert.org * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
226145Snate@binkert.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
236145Snate@binkert.org * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
246145Snate@binkert.org * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
256145Snate@binkert.org * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
266145Snate@binkert.org * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
276145Snate@binkert.org * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
286145Snate@binkert.org */
296145Snate@binkert.org
306145Snate@binkert.org/*
316145Snate@binkert.org * $Id$
326145Snate@binkert.org *
336145Snate@binkert.org * Description: Common base class for a machine node.
346145Snate@binkert.org *
356145Snate@binkert.org */
366145Snate@binkert.org
376145Snate@binkert.org#ifndef AbstractCacheEntry_H
386145Snate@binkert.org#define AbstractCacheEntry_H
396145Snate@binkert.org
406145Snate@binkert.org#include "Global.hh"
416145Snate@binkert.org#include "Address.hh"
426145Snate@binkert.org#include "AccessPermission.hh"
436145Snate@binkert.org
446145Snate@binkert.orgclass AbstractCacheEntry {
456145Snate@binkert.orgpublic:
466145Snate@binkert.org  // Constructors
476145Snate@binkert.org  AbstractCacheEntry();
486145Snate@binkert.org
496145Snate@binkert.org  // Destructor, prevent it from instantiation
506145Snate@binkert.org  virtual ~AbstractCacheEntry() = 0;
516145Snate@binkert.org
526145Snate@binkert.org  // Public Methods
536145Snate@binkert.org
546145Snate@binkert.org  // The methods below are those called by ruby runtime, add when it is
556145Snate@binkert.org  // absolutely necessary and should all be virtual function.
566145Snate@binkert.org
576145Snate@binkert.org
586145Snate@binkert.org  virtual void print(ostream& out) const = 0;
596145Snate@binkert.org
606145Snate@binkert.org  // Data Members (m_ prefix)
616145Snate@binkert.org  Address m_Address; // Address of this block, required by CacheMemory
626145Snate@binkert.org  Time m_LastRef; // Last time this block was referenced, required by CacheMemory
636145Snate@binkert.org  AccessPermission m_Permission; // Access permission for this block, required by CacheMemory
646145Snate@binkert.org};
656145Snate@binkert.org
666145Snate@binkert.org// Output operator declaration
676145Snate@binkert.orgostream& operator<<(ostream& out, const AbstractCacheEntry& obj);
686145Snate@binkert.org
696145Snate@binkert.org// ******************* Definitions *******************
706145Snate@binkert.org
716145Snate@binkert.org// Output operator definition
726145Snate@binkert.orgextern inline
736145Snate@binkert.orgostream& operator<<(ostream& out, const AbstractCacheEntry& obj)
746145Snate@binkert.org{
756145Snate@binkert.org  obj.print(out);
766145Snate@binkert.org  out << flush;
776145Snate@binkert.org  return out;
786145Snate@binkert.org}
796145Snate@binkert.org
806145Snate@binkert.org#endif //AbstractCacheEntry_H
816145Snate@binkert.org
82