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
37class CacheMemory;
38
39class AbstractReplacementPolicy : public SimObject
40{
41  public:
42    typedef ReplacementPolicyParams Params;
43    AbstractReplacementPolicy(const Params * p);
44    virtual ~AbstractReplacementPolicy();
45
46    /* touch a block. a.k.a. update timestamp */
47    virtual void touch(int64_t set, int64_t way, Tick time) = 0;
48
49    /* returns the way to replace */
50    virtual int64_t getVictim(int64_t set) const = 0;
51
52    /* get the time of the last access */
53    Tick getLastAccess(int64_t set, int64_t way);
54
55    virtual bool useOccupancy() const { return false; }
56
57    void setCache(CacheMemory * pCache) {m_cache = pCache;}
58    CacheMemory * m_cache;
59
60  protected:
61    unsigned m_num_sets;       /** total number of sets */
62    unsigned m_assoc;          /** set associativity */
63    Tick **m_last_ref_ptr;         /** timestamp of last reference */
64};
65
66#endif // __MEM_RUBY_STRUCTURES_ABSTRACTREPLACEMENTPOLICY_HH__
67