summaryrefslogtreecommitdiff
path: root/src/mem/cache/coherence/simple_coherence.hh
blob: a1fd3308017f637111bb36a99ad0479d715a8427 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/*
 * Copyright (c) 2003-2005 The Regents of The University of Michigan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: Erik Hallnor
 *          Ron Dreslinski
 */

/**
 * @file
 * Declaration of a simple coherence policy.
 */

#ifndef __SIMPLE_COHERENCE_HH__
#define __SIMPLE_COHERENCE_HH__

#include <string>

#include "mem/packet.hh"
#include "mem/cache/cache_blk.hh"
#include "mem/cache/miss/mshr_queue.hh"
#include "mem/cache/coherence/coherence_protocol.hh"

class BaseCache;

/**
 * A simple MP coherence policy. This policy assumes an atomic bus and only one
 * level of cache.
 */
class SimpleCoherence
{
  protected:
    /** Pointer to the parent cache. */
    BaseCache *cache;
    /** Pointer to the coherence protocol. */
    CoherenceProtocol *protocol;

  public:
    /**
     * Construct and initialize this coherence policy.
     * @param _protocol The coherence protocol to use.
     */
    SimpleCoherence(CoherenceProtocol *_protocol)
        : protocol(_protocol)
    {
    }

    /**
     * Set the pointer to the parent cache.
     * @param _cache The parent cache.
     */
    void setCache(BaseCache *_cache)
    {
        cache = _cache;
    }

    /**
     * Register statistics.
     * @param name The name to prepend to stat descriptions.
     */
    void regStats(const std::string &name)
    {
    }

    /**
     * This policy does not forward invalidates, return NULL.
     * @return NULL.
     */
    PacketPtr getPacket()
    {
        return NULL;
    }

    /**
     * Was the CSHR request was sent successfully?
     * @param pkt The request.
     * @param success True if the request was sent successfully.
     */
    void sendResult(PacketPtr &pkt, MSHR* cshr, bool success)
    {
        //Don't do coherence
        return;
    }


    /**
     * Return the proper state given the current state and the bus response.
     * @param pkt The bus response.
     * @param current The current block state.
     * @return The new state.
     */
    CacheBlk::State getNewState(PacketPtr &pkt, CacheBlk::State current)
    {
        return protocol->getNewState(pkt, current);
    }

    /**
     * Handle snooped bus requests.
     * @param pkt The snooped bus request.
     * @param blk The cache block corresponding to the request, if any.
     * @param mshr The MSHR corresponding to the request, if any.
     * @param new_state Return the new state for the block.
     */
    bool handleBusRequest(PacketPtr &pkt, CacheBlk *blk, MSHR *mshr,
                          CacheBlk::State &new_state)
    {
//	assert(mshr == NULL);
//Got rid of, there could be an MSHR, but it can't be in service
        if (blk != NULL)
        {
            if (pkt->cmd != Packet::Writeback) {
                return protocol->handleBusRequest(cache, pkt, blk, mshr,
                                              new_state);
            }
            else { //It is a writeback, must be ownership protocol, just keep state
                new_state = blk->status;
            }
        }
        return false;
    }

    /**
     * Get the proper bus command for the given command and status.
     * @param cmd The request's command.
     * @param state The current state of the cache block.
     * @return The proper bus command, as determined by the protocol.
     */
    Packet::Command getBusCmd(Packet::Command &cmd, CacheBlk::State state)
    {
        if (cmd == Packet::Writeback) return Packet::Writeback;
        return protocol->getBusCmd(cmd, state);
    }

    /**
     * Return true if this coherence policy can handle fast cache writes.
     */
    bool allowFastWrites() { return false; }

    bool hasProtocol() { return true; }

    bool propogateInvalidate(PacketPtr pkt, bool isTiming)
    {
        //For now we do nothing, asssumes simple coherence is top level of cache
        return false;
    }
};

#endif //__SIMPLE_COHERENCE_HH__