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#include "mem/cache/replacement_policies/random_rp.hh"
32
33#include <cassert>
34#include <memory>
35
36#include "base/random.hh"
37#include "params/RandomRP.hh"
38
39RandomRP::RandomRP(const Params *p)
40    : BaseReplacementPolicy(p)
41{
42}
43
44void
45RandomRP::invalidate(const std::shared_ptr<ReplacementData>& replacement_data)
46const
47{
48    // Unprioritize replacement data victimization
49    std::static_pointer_cast<RandomReplData>(
50        replacement_data)->valid = false;
51}
52
53void
54RandomRP::touch(const std::shared_ptr<ReplacementData>& replacement_data) const
55{
56}
57
58void
59RandomRP::reset(const std::shared_ptr<ReplacementData>& replacement_data) const
60{
61    // Unprioritize replacement data victimization
62    std::static_pointer_cast<RandomReplData>(
63        replacement_data)->valid = true;
64}
65
66ReplaceableEntry*
67RandomRP::getVictim(const ReplacementCandidates& candidates) const
68{
69    // There must be at least one replacement candidate
70    assert(candidates.size() > 0);
71
72    // Choose one candidate at random
73    ReplaceableEntry* victim = candidates[random_mt.random<unsigned>(0,
74                                    candidates.size() - 1)];
75
76    // Visit all candidates to search for an invalid entry. If one is found,
77    // its eviction is prioritized
78    for (const auto& candidate : candidates) {
79        if (!std::static_pointer_cast<RandomReplData>(
80                    candidate->replacementData)->valid) {
81            victim = candidate;
82            break;
83        }
84    }
85
86    return victim;
87}
88
89std::shared_ptr<ReplacementData>
90RandomRP::instantiateEntry()
91{
92    return std::shared_ptr<ReplacementData>(new RandomReplData());
93}
94
95RandomRP*
96RandomRPParams::create()
97{
98    return new RandomRP(this);
99}
100