gem5  v21.1.0.2
base.hh
Go to the documentation of this file.
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 
47 #ifndef __MEM_CACHE_INDEXING_POLICIES_BASE_HH__
48 #define __MEM_CACHE_INDEXING_POLICIES_BASE_HH__
49 
50 #include <vector>
51 
52 #include "params/BaseIndexingPolicy.hh"
53 #include "sim/sim_object.hh"
54 
55 namespace gem5
56 {
57 
58 class ReplaceableEntry;
59 
67 {
68  protected:
72  const unsigned assoc;
73 
77  const uint32_t numSets;
78 
82  const int setShift;
83 
87  const unsigned setMask;
88 
93 
97  const int tagShift;
98 
99  public:
103  typedef BaseIndexingPolicyParams Params;
104 
108  BaseIndexingPolicy(const Params &p);
109 
114 
121  void setEntry(ReplaceableEntry* entry, const uint64_t index);
122 
131  ReplaceableEntry* getEntry(const uint32_t set, const uint32_t way) const;
132 
139  virtual Addr extractTag(const Addr addr) const;
140 
150  const = 0;
151 
159  virtual Addr regenerateAddr(const Addr tag, const ReplaceableEntry* entry)
160  const = 0;
161 };
162 
163 } // namespace gem5
164 
165 #endif //__MEM_CACHE_INDEXING_POLICIES_BASE_HH__
gem5::BaseIndexingPolicy
A common base class for indexing table locations.
Definition: base.hh:66
gem5::BaseIndexingPolicy::Params
BaseIndexingPolicyParams Params
Convenience typedef.
Definition: base.hh:103
gem5::BaseIndexingPolicy::setMask
const unsigned setMask
Mask out all bits that aren't part of the set index.
Definition: base.hh:87
gem5::MipsISA::index
Bitfield< 30, 0 > index
Definition: pra_constants.hh:47
std::vector
STL vector class.
Definition: stl.hh:37
gem5::BaseIndexingPolicy::BaseIndexingPolicy
BaseIndexingPolicy(const Params &p)
Construct and initialize this policy.
Definition: base.cc:58
gem5::BaseIndexingPolicy::getPossibleEntries
virtual std::vector< ReplaceableEntry * > getPossibleEntries(const Addr addr) const =0
Find all possible entries for insertion and replacement of an address.
gem5::BaseIndexingPolicy::sets
std::vector< std::vector< ReplaceableEntry * > > sets
The cache sets.
Definition: base.hh:92
sim_object.hh
gem5::BaseIndexingPolicy::assoc
const unsigned assoc
The associativity.
Definition: base.hh:72
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
gem5::BaseIndexingPolicy::~BaseIndexingPolicy
~BaseIndexingPolicy()
Destructor.
Definition: base.hh:113
gem5::BaseIndexingPolicy::tagShift
const int tagShift
The amount to shift the address to get the tag.
Definition: base.hh:97
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
gem5::Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
gem5::ReplaceableEntry
A replaceable entry is a basic entry in a 2d table-like structure that needs to have replacement func...
Definition: replaceable_entry.hh:63
gem5::BaseIndexingPolicy::setEntry
void setEntry(ReplaceableEntry *entry, const uint64_t index)
Associate a pointer to an entry to its physical counterpart.
Definition: base.cc:81
gem5::BaseIndexingPolicy::regenerateAddr
virtual Addr regenerateAddr(const Addr tag, const ReplaceableEntry *entry) const =0
Regenerate an entry's address from its tag and assigned indexing bits.
gem5::BaseIndexingPolicy::numSets
const uint32_t numSets
The number of sets in the cache.
Definition: base.hh:77
gem5::BaseIndexingPolicy::getEntry
ReplaceableEntry * getEntry(const uint32_t set, const uint32_t way) const
Get an entry based on its set and way.
Definition: base.cc:75
gem5::BaseIndexingPolicy::extractTag
virtual Addr extractTag(const Addr addr) const
Generate the tag from the given address.
Definition: base.cc:99
gem5::BaseIndexingPolicy::setShift
const int setShift
The amount to shift the address to get the set.
Definition: base.hh:82
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::X86ISA::addr
Bitfield< 3 > addr
Definition: types.hh:84

Generated on Tue Sep 21 2021 12:24:57 for gem5 by doxygen 1.8.17