AbstractCacheEntry.hh revision 6285
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 406154Snate@binkert.org#include "mem/ruby/common/Global.hh" 416154Snate@binkert.org#include "mem/ruby/common/Address.hh" 426154Snate@binkert.org#include "mem/protocol/AccessPermission.hh" 436145Snate@binkert.org 446285Snate@binkert.orgclass DataBlock; 456285Snate@binkert.org 466145Snate@binkert.orgclass AbstractCacheEntry { 476145Snate@binkert.orgpublic: 486145Snate@binkert.org // Constructors 496145Snate@binkert.org AbstractCacheEntry(); 506145Snate@binkert.org 516145Snate@binkert.org // Destructor, prevent it from instantiation 526145Snate@binkert.org virtual ~AbstractCacheEntry() = 0; 536145Snate@binkert.org 546145Snate@binkert.org // Public Methods 556145Snate@binkert.org 566145Snate@binkert.org // The methods below are those called by ruby runtime, add when it is 576145Snate@binkert.org // absolutely necessary and should all be virtual function. 586285Snate@binkert.org virtual DataBlock& getDataBlk() = 0; 596145Snate@binkert.org 606145Snate@binkert.org 616145Snate@binkert.org virtual void print(ostream& out) const = 0; 626145Snate@binkert.org 636145Snate@binkert.org // Data Members (m_ prefix) 646145Snate@binkert.org Address m_Address; // Address of this block, required by CacheMemory 656145Snate@binkert.org Time m_LastRef; // Last time this block was referenced, required by CacheMemory 666145Snate@binkert.org AccessPermission m_Permission; // Access permission for this block, required by CacheMemory 676145Snate@binkert.org}; 686145Snate@binkert.org 696145Snate@binkert.org// Output operator declaration 706145Snate@binkert.orgostream& operator<<(ostream& out, const AbstractCacheEntry& obj); 716145Snate@binkert.org 726145Snate@binkert.org// ******************* Definitions ******************* 736145Snate@binkert.org 746145Snate@binkert.org// Output operator definition 756145Snate@binkert.orgextern inline 766145Snate@binkert.orgostream& operator<<(ostream& out, const AbstractCacheEntry& obj) 776145Snate@binkert.org{ 786145Snate@binkert.org obj.print(out); 796145Snate@binkert.org out << flush; 806145Snate@binkert.org return out; 816145Snate@binkert.org} 826145Snate@binkert.org 836145Snate@binkert.org#endif //AbstractCacheEntry_H 846145Snate@binkert.org 85