1/*
2 * Copyright (c) 2018 Inria
3 * Copyright (c) 2012-2014,2017 ARM Limited
4 * All rights reserved.
5 *
6 * The license below extends only to copyright in the software and shall
7 * not be construed as granting a license to any other intellectual
8 * property including but not limited to intellectual property relating
9 * to a hardware implementation of the functionality of the software
10 * licensed hereunder.  You may use the software subject to the license
11 * terms below provided that you ensure that this notice is replicated
12 * unmodified and in its entirety in all distributions of the software,
13 * modified or unmodified, in source code or in binary form.
14 *
15 * Copyright (c) 2003-2005,2014 The Regents of The University of Michigan
16 * All rights reserved.
17 *
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions are
20 * met: redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer;
22 * redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution;
25 * neither the name of the copyright holders nor the names of its
26 * contributors may be used to endorse or promote products derived from
27 * this software without specific prior written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Authors: Daniel Carvalho
42 *          Erik Hallnor
43 */
44
45/**
46 * @file
47 * Definitions of a common framework for indexing policies.
48 */
49
50#include "mem/cache/tags/indexing_policies/base.hh"
51
52#include <cstdlib>
53
54#include "base/intmath.hh"
55#include "base/logging.hh"
56#include "mem/cache/replacement_policies/replaceable_entry.hh"
57
58BaseIndexingPolicy::BaseIndexingPolicy(const Params *p)
59    : SimObject(p), assoc(p->assoc),
60      numSets(p->size / (p->entry_size * assoc)),
61      setShift(floorLog2(p->entry_size)), setMask(numSets - 1), sets(numSets),
62      tagShift(setShift + floorLog2(numSets))
63{
64    fatal_if(!isPowerOf2(numSets), "# of sets must be non-zero and a power " \
65             "of 2");
66    fatal_if(assoc <= 0, "associativity must be greater than zero");
67
68    // Make space for the entries
69    for (uint32_t i = 0; i < numSets; ++i) {
70        sets[i].resize(assoc);
71    }
72}
73
74ReplaceableEntry*
75BaseIndexingPolicy::getEntry(const uint32_t set, const uint32_t way) const
76{
77    return sets[set][way];
78}
79
80void
81BaseIndexingPolicy::setEntry(ReplaceableEntry* entry, const uint64_t index)
82{
83    // Calculate set and way from entry index
84    const std::lldiv_t div_result = std::div((long long)index, assoc);
85    const uint32_t set = div_result.quot;
86    const uint32_t way = div_result.rem;
87
88    // Sanity check
89    assert(set < numSets);
90
91    // Assign a free pointer
92    sets[set][way] = entry;
93
94    // Inform the entry its position
95    entry->setPosition(set, way);
96}
97
98Addr
99BaseIndexingPolicy::extractTag(const Addr addr) const
100{
101    return (addr >> tagShift);
102}
103