1/**
2 * Copyright (c) 2018 Inria
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 * Authors: Daniel Carvalho
29 */
30
31/**
32 * @file
33 * Declaration of a Re-Reference Interval Prediction replacement policy.
34 *
35 * Not-Recently Used (NRU) is an approximation of LRU that uses a single bit
36 * to determine if an entry is going to be re-referenced in the near or distant
37 * future.
38 *
39 * Re-Reference Interval Prediction (RRIP) is an extension of NRU that uses a
40 * re-reference prediction value to determine if entries are going to be re-
41 * used in the near future or not.
42 *
43 * The higher the value of the RRPV, the more distant the entry is from its
44 * next access.
45 *
46 * Bimodal Re-Reference Interval Prediction (BRRIP) is an extension of RRIP
47 * that has a probability of not inserting entries as the LRU. This probability
48 * is controlled by the bimodal throtle parameter (btp).
49 *
50 * From the original paper, this implementation of RRIP is also called
51 * Static RRIP (SRRIP), as it always inserts entries with the same RRPV.
52 */
53
54#ifndef __MEM_CACHE_REPLACEMENT_POLICIES_BRRIP_RP_HH__
55#define __MEM_CACHE_REPLACEMENT_POLICIES_BRRIP_RP_HH__
56
57#include "mem/cache/replacement_policies/base.hh"
58
59struct BRRIPRPParams;
60
61class BRRIPRP : public BaseReplacementPolicy
62{
63 protected:
64 /** BRRIP-specific implementation of replacement data. */
65 struct BRRIPReplData : ReplacementData
66 {
67 /**
68 * Re-Reference Interval Prediction Value.
69 * A value equal to max_RRPV + 1 indicates an invalid entry.
70 */
71 int rrpv;
72
73 /**
74 * Default constructor. Invalidate data.
75 */
76 BRRIPReplData(const int max_RRPV) : rrpv(max_RRPV + 1) {}
77 };
78
79 /**
80 * Maximum Re-Reference Prediction Value possible. An entry with this
81 * value as the rrpv has the longest possible re-reference interval,
82 * that is, it is likely not to be used in the near future, and is
83 * among the best eviction candidates.
84 * A maxRRPV of 1 implies in a NRU.
85 */
86 const int maxRRPV;
87
88 /**
89 * The hit priority (HP) policy replaces entries that do not receive cache
90 * hits over any cache entry that receives a hit, while the frequency
91 * priority (FP) policy replaces infrequently re-referenced entries.
92 */
93 const bool hitPriority;
94
95 /**
96 * Bimodal throtle parameter. Value in the range [0,100] used to decide
97 * if a new entry is inserted with long or distant re-reference.
98 */
99 const unsigned btp;
100
101 public:
102 /** Convenience typedef. */
103 typedef BRRIPRPParams Params;
104
105 /**
106 * Construct and initiliaze this replacement policy.
107 */
108 BRRIPRP(const Params *p);
109
110 /**
111 * Destructor.
112 */
113 ~BRRIPRP() {}
114
115 /**
116 * Invalidate replacement data to set it as the next probable victim.
117 * Set RRPV as the the most distant re-reference.
118 *
119 * @param replacement_data Replacement data to be invalidated.
120 */
121 void invalidate(const std::shared_ptr<ReplacementData>& replacement_data)
122 const override;
123
124 /**
125 * Touch an entry to update its replacement data.
126 *
127 * @param replacement_data Replacement data to be touched.
128 */
129 void touch(const std::shared_ptr<ReplacementData>& replacement_data) const
130 override;
131
132 /**
133 * Reset replacement data. Used when an entry is inserted.
134 * Set RRPV according to the insertion policy used.
135 *
136 * @param replacement_data Replacement data to be reset.
137 */
138 void reset(const std::shared_ptr<ReplacementData>& replacement_data) const
139 override;
140
141 /**
142 * Find replacement victim using rrpv.
143 *
144 * @param cands Replacement candidates, selected by indexing policy.
145 * @return Replacement entry to be replaced.
146 */
147 ReplaceableEntry* getVictim(const ReplacementCandidates& candidates) const
148 override;
149
150 /**
151 * Instantiate a replacement data entry.
152 *
153 * @return A shared pointer to the new replacement data.
154 */
155 std::shared_ptr<ReplacementData> instantiateEntry() override;
156};
157
158#endif // __MEM_CACHE_REPLACEMENT_POLICIES_BRRIP_RP_HH__