src/mem/ruby/structures/AbstractReplacementPolicy.hh

   1 /*
   2  * Copyright (c) 2007 Mark D. Hill and David A. Wood
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef __MEM_RUBY_STRUCTURES_ABSTRACTREPLACEMENTPOLICY_HH__
  30 #define __MEM_RUBY_STRUCTURES_ABSTRACTREPLACEMENTPOLICY_HH__
  31
  32 #include "base/types.hh"
  33 #include "mem/ruby/common/TypeDefines.hh"
  34 #include "params/ReplacementPolicy.hh"
  35 #include "sim/sim_object.hh"
  36
  37 class AbstractReplacementPolicy : public SimObject
  38 {
  39   public:
  40     typedef ReplacementPolicyParams Params;
  41     AbstractReplacementPolicy(const Params * p);
  42     virtual ~AbstractReplacementPolicy();
  43
  44     /* touch a block. a.k.a. update timestamp */
  45     virtual void touch(int64 set, int64 way, Tick time) = 0;
  46
  47     /* returns the way to replace */
  48     virtual int64 getVictim(int64 set) const = 0;
  49
  50     /* get the time of the last access */
  51     Tick getLastAccess(int64 set, int64 way);
  52
  53     virtual bool useOccupancy() const { return false; }
  54
  55   protected:
  56     unsigned m_num_sets;       /** total number of sets */
  57     unsigned m_assoc;          /** set associativity */
  58     Tick **m_last_ref_ptr;         /** timestamp of last reference */
  59 };
  60
  61 #endif // __MEM_RUBY_STRUCTURES_ABSTRACTREPLACEMENTPOLICY_HH__