2 * Copyright (c) 2013-2014 ARM Limited
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
14 * Copyright (c) 2005 The Regents of The University of Michigan
15 * All rights reserved.
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 * Authors: Ron Dreslinski
46 * Miss and writeback queue declarations.
49 #ifndef __MEM_CACHE_PREFETCH_BASE_HH__
50 #define __MEM_CACHE_PREFETCH_BASE_HH__
54 #include "base/statistics.hh"
55 #include "base/types.hh"
56 #include "mem/packet.hh"
57 #include "mem/request.hh"
58 #include "sim/clocked_object.hh"
59 #include "sim/probe/probe.hh"
62 struct BasePrefetcherParams;
64 class BasePrefetcher : public ClockedObject
66 class PrefetchListener : public ProbeListenerArgBase<PacketPtr>
69 PrefetchListener(BasePrefetcher &_parent, ProbeManager *pm,
70 const std::string &name)
71 : ProbeListenerArgBase(pm, name),
73 void notify(const PacketPtr &pkt) override;
75 BasePrefetcher &parent;
78 std::vector<PrefetchListener *> listeners;
82 * Class containing the information needed by the prefetch to train and
83 * generate new prefetch requests.
88 /** The program counter that generated this address. */
90 /** The requestor ID that generated this address. */
92 /** Validity bit for the PC of this address. */
94 /** Whether this address targets the secure memory space. */
99 * Obtains the address value of this Prefetcher address.
100 * @return the addres value.
108 * Returns true if the address targets the secure memory space.
109 * @return true if the address targets the secure memory space.
111 bool isSecure() const
117 * Returns the program counter that generated this request.
118 * @return the pc value
127 * Returns true if the associated program counter is valid
128 * @return true if the program counter has a valid value
136 * Gets the requestor ID that generated this address
137 * @return the requestor ID that generated this address
139 MasterID getMasterId() const
146 * @param pfi PrefetchInfo to compare against
147 * @return True if this object and the provided one are equal
149 bool sameAddr(PrefetchInfo const &pfi) const
151 return this->getAddr() == pfi.getAddr() &&
152 this->isSecure() == pfi.isSecure();
156 * Constructs a PrefetchInfo using a PacketPtr.
157 * @param pkt PacketPtr used to generate the PrefetchInfo
158 * @param addr the address value of the new object
160 PrefetchInfo(PacketPtr pkt, Addr addr);
163 * Constructs a PrefetchInfo using a new address value and
164 * another PrefetchInfo as a reference.
165 * @param pfi PrefetchInfo used to generate this new object
166 * @param addr the address value of the new object
168 PrefetchInfo(PrefetchInfo const &pfi, Addr addr);
173 /** Pointr to the parent cache. */
176 /** The block size of the parent cache. */
179 /** log_2(block size of the parent cache). */
182 /** Only consult prefetcher on cache misses? */
185 /** Consult prefetcher on reads? */
188 /** Consult prefetcher on reads? */
191 /** Consult prefetcher on data accesses? */
194 /** Consult prefetcher on instruction accesses? */
197 /** Request id for prefetches */
198 const MasterID masterId;
200 const Addr pageBytes;
202 /** Prefetch on every access, not just misses */
203 const bool prefetchOnAccess;
205 /** Use Virtual Addresses for prefetching */
206 const bool useVirtualAddresses;
208 /** Determine if this access should be observed */
209 bool observeAccess(const PacketPtr &pkt) const;
211 /** Determine if address is in cache */
212 bool inCache(Addr addr, bool is_secure) const;
214 /** Determine if address is in cache miss queue */
215 bool inMissQueue(Addr addr, bool is_secure) const;
217 /** Determine if addresses are on the same page */
218 bool samePage(Addr a, Addr b) const;
219 /** Determine the address of the block in which a lays */
220 Addr blockAddress(Addr a) const;
221 /** Determine the address of a at block granularity */
222 Addr blockIndex(Addr a) const;
223 /** Determine the address of the page in which a lays */
224 Addr pageAddress(Addr a) const;
225 /** Determine the page-offset of a */
226 Addr pageOffset(Addr a) const;
227 /** Build the address of the i-th block inside the page */
228 Addr pageIthBlockAddress(Addr page, uint32_t i) const;
230 Stats::Scalar pfIssued;
234 BasePrefetcher(const BasePrefetcherParams *p);
236 virtual ~BasePrefetcher() {}
238 void setCache(BaseCache *_cache);
241 * Notify prefetcher of cache access (may be any access or just
242 * misses, depending on cache parameters.)
244 virtual void notify(const PacketPtr &pkt, const PrefetchInfo &pfi) = 0;
246 virtual PacketPtr getPacket() = 0;
248 virtual Tick nextPrefetchReadyTime() const = 0;
251 * Register local statistics.
253 void regStats() override;
256 * Register probe points for this object.
258 void regProbeListeners() override;
261 * Process a notification event from the ProbeListener.
262 * @param pkt The memory request causing the event
264 void probeNotify(const PacketPtr &pkt);
267 * Add a SimObject and a probe name to listen events from
268 * @param obj The SimObject pointer to listen from
269 * @param name The probe name
271 void addEventProbe(SimObject *obj, const char *name);
273 #endif //__MEM_CACHE_PREFETCH_BASE_HH__