2 * Copyright (c) 2012-2013, 2015-2016 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) 2002-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: Erik Hallnor
49 #ifndef __MEM_CACHE_QUEUE_ENTRY_HH__
50 #define __MEM_CACHE_QUEUE_ENTRY_HH__
52 #include "base/types.hh"
53 #include "mem/packet.hh"
58 * A queue entry base class, to be used by both the MSHRs and
59 * write-queue entries.
61 class QueueEntry : public Packet::SenderState
65 * Consider the Queue a friend to avoid making everything public
67 template <class Entry>
72 /** Tick when ready to issue */
75 /** True if the entry is uncacheable */
80 * A queue entry is holding packets that will be serviced as soon as
81 * resources are available. Since multiple references to the same
82 * address can arrive while a packet is not serviced, each packet is
83 * stored in a target containing its availability, order and other info,
84 * and the queue entry stores these similar targets in a list.
88 const Tick recvTime; //!< Time when request was received (for stats)
89 const Tick readyTime; //!< Time when request is ready to be serviced
90 const Counter order; //!< Global order (for memory consistency mgmt)
91 const PacketPtr pkt; //!< Pending request packet.
94 * Default constructor. Assigns the current tick as the arrival time
97 * @param _pkt The pending request packet.
98 * @param ready_time The tick at which the packet will be serviceable.
99 * @param _order Global order.
101 Target(PacketPtr _pkt, Tick ready_time, Counter _order)
102 : recvTime(curTick()), readyTime(ready_time), order(_order),
107 /** True if the entry has been sent downstream. */
110 /** Order number assigned to disambiguate writes and misses. */
113 /** Block aligned address. */
116 /** Block size of the cache. */
119 /** True if the entry targets the secure memory space. */
123 : readyTime(0), _isUncacheable(false),
124 inService(false), order(0), blkAddr(0), blkSize(0), isSecure(false)
127 bool isUncacheable() const { return _isUncacheable; }
130 * Check if entry corresponds to the one being looked for.
132 * @param addr Address to match against.
133 * @param is_secure Whether the target should be in secure space or not.
134 * @return True if entry matches given information.
136 virtual bool matchBlockAddr(const Addr addr, const bool is_secure)
140 * Check if entry contains a packet that corresponds to the one being
143 * @param pkt The packet to search for.
144 * @return True if any of its targets' packets matches the given one.
146 virtual bool matchBlockAddr(const PacketPtr pkt) const = 0;
149 * Check if given entry's packets conflict with this' entries packets.
151 * @param entry Other entry to compare against.
152 * @return True if entry matches given information.
154 virtual bool conflictAddr(const QueueEntry* entry) const = 0;
157 * Send this queue entry as a downstream packet, with the exact
158 * behaviour depending on the specific entry type.
160 virtual bool sendPacket(BaseCache &cache) = 0;
163 * Returns a pointer to the first target.
165 * @return A pointer to the first target.
167 virtual Target* getTarget() = 0;
170 #endif // __MEM_CACHE_QUEUE_ENTRY_HH__