1/*
2 * Copyright (c) 2012-2013, 2015-2016, 2018 ARM Limited
3 * All rights reserved.
4 *
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.
13 *
14 * Copyright (c) 2003-2005 The Regents of The University of Michigan
15 * All rights reserved.
16 *
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.
27 *
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.
39 *
40 * Authors: Erik Hallnor
41 *          Andreas Sandberg
42 */
43
44/** @file
45 * Definition of MSHRQueue class functions.
46 */
47
48#include "mem/cache/mshr_queue.hh"
49
50#include <cassert>
51
52#include "mem/cache/mshr.hh"
53
54MSHRQueue::MSHRQueue(const std::string &_label,
55                     int num_entries, int reserve, int demand_reserve)
56    : Queue<MSHR>(_label, num_entries, reserve),
57      demandReserve(demand_reserve)
58{}
59
60MSHR *
61MSHRQueue::allocate(Addr blk_addr, unsigned blk_size, PacketPtr pkt,
62                    Tick when_ready, Counter order, bool alloc_on_fill)
63{
64    assert(!freeList.empty());
65    MSHR *mshr = freeList.front();
66    assert(mshr->getNumTargets() == 0);
67    freeList.pop_front();
68
69    mshr->allocate(blk_addr, blk_size, pkt, when_ready, order, alloc_on_fill);
70    mshr->allocIter = allocatedList.insert(allocatedList.end(), mshr);
71    mshr->readyIter = addToReadyList(mshr);
72
73    allocated += 1;
74    return mshr;
75}
76
77void
78MSHRQueue::moveToFront(MSHR *mshr)
79{
80    if (!mshr->inService) {
81        assert(mshr == *(mshr->readyIter));
82        readyList.erase(mshr->readyIter);
83        mshr->readyIter = readyList.insert(readyList.begin(), mshr);
84    }
85}
86
87void
88MSHRQueue::delay(MSHR *mshr, Tick delay_ticks)
89{
90    mshr->delay(delay_ticks);
91    auto it = std::find_if(mshr->readyIter, readyList.end(),
92                            [mshr] (const MSHR* _mshr) {
93                                return mshr->readyTime >= _mshr->readyTime;
94                            });
95    readyList.splice(it, readyList, mshr->readyIter);
96}
97
98void
99MSHRQueue::markInService(MSHR *mshr, bool pending_modified_resp)
100{
101    mshr->markInService(pending_modified_resp);
102    readyList.erase(mshr->readyIter);
103    _numInService += 1;
104}
105
106void
107MSHRQueue::markPending(MSHR *mshr)
108{
109    assert(mshr->inService);
110    mshr->inService = false;
111    --_numInService;
112    /**
113     * @ todo might want to add rerequests to front of pending list for
114     * performance.
115     */
116    mshr->readyIter = addToReadyList(mshr);
117}
118
119bool
120MSHRQueue::forceDeallocateTarget(MSHR *mshr)
121{
122    bool was_full = isFull();
123    assert(mshr->hasTargets());
124    // Pop the prefetch off of the target list
125    mshr->popTarget();
126    // Delete mshr if no remaining targets
127    if (!mshr->hasTargets() && !mshr->promoteDeferredTargets()) {
128        deallocate(mshr);
129    }
130
131    // Notify if MSHR queue no longer full
132    return was_full && !isFull();
133}
134