snoop_filter.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2013-2016,2019 ARM Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * 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.
 */
 
#ifndef __MEM_SNOOP_FILTER_HH__
#define __MEM_SNOOP_FILTER_HH__
 
#include <bitset>
#include <unordered_map>
#include <utility>
 
#include "mem/packet.hh"
#include "mem/port.hh"
#include "mem/qport.hh"
#include "params/SnoopFilter.hh"
#include "sim/sim_object.hh"
#include "sim/system.hh"
 
namespace gem5
{
 
class SnoopFilter : public SimObject
{
  public:
 
    // Change for systems with more than 256 ports tracked by this object
    static const int SNOOP_MASK_SIZE = 256;
 
    typedef std::vector<QueuedResponsePort*> SnoopList;
 
    SnoopFilter (const SnoopFilterParams &p) :
        SimObject(p), reqLookupResult(cachedLocations.end()),
        linesize(p.system->cacheLineSize()), lookupLatency(p.lookup_latency),
        maxEntryCount(p.max_capacity / p.system->cacheLineSize()),
        stats(this)
    {
    }
 
    void setCPUSidePorts(const SnoopList& _cpu_side_ports) {
        localResponsePortIds.resize(_cpu_side_ports.size(), InvalidPortID);
 
        PortID id = 0;
        for (const auto& p : _cpu_side_ports) {
            // no need to track this port if it is not snooping
            if (p->isSnooping()) {
                cpuSidePorts.push_back(p);
                localResponsePortIds[p->getId()] = id++;
            }
        }
 
        // make sure we can deal with this many ports
        fatal_if(id > SNOOP_MASK_SIZE,
                 "Snoop filter only supports %d snooping ports, got %d\n",
                 SNOOP_MASK_SIZE, id);
    }
 
    std::pair<SnoopList, Cycles> lookupRequest(const Packet* cpkt,
                                        const ResponsePort& cpu_side_port);
 
    void finishRequest(bool will_retry, Addr addr, bool is_secure);
 
    std::pair<SnoopList, Cycles> lookupSnoop(const Packet* cpkt);
 
    void updateSnoopResponse(const Packet *cpkt, const ResponsePort& rsp_port,
                             const ResponsePort& req_port);
 
    void updateSnoopForward(const Packet *cpkt, const ResponsePort& rsp_port,
                            const RequestPort& req_port);
 
    void updateResponse(const Packet *cpkt, const ResponsePort& cpu_side_port);
 
    virtual void regStats();
 
  protected:
 
    typedef std::bitset<SNOOP_MASK_SIZE> SnoopMask;
 
    struct SnoopItem
    {
        SnoopMask requested;
        SnoopMask holder;
    };
    typedef std::unordered_map<Addr, SnoopItem> SnoopFilterCache;
 
    std::pair<SnoopList, Cycles> snoopAll(Cycles latency) const
    {
        return std::make_pair(cpuSidePorts, latency);
    }
    std::pair<SnoopList, Cycles> snoopSelected(const SnoopList&
                                _cpu_side_ports, Cycles latency) const
    {
        return std::make_pair(_cpu_side_ports, latency);
    }
    std::pair<SnoopList, Cycles> snoopDown(Cycles latency) const
    {
        SnoopList empty;
        return std::make_pair(empty , latency);
    }
 
    SnoopMask portToMask(const ResponsePort& port) const;
    SnoopList maskToPortList(SnoopMask ports) const;
 
  private:
 
    void eraseIfNullEntry(SnoopFilterCache::iterator& sf_it);
 
    SnoopFilterCache cachedLocations;
 
    struct ReqLookupResult
    {
        SnoopFilterCache::iterator it;
 
        SnoopItem retryItem;
 
        ReqLookupResult(SnoopFilterCache::iterator end_it)
            : it(end_it), retryItem{0, 0}
        {
        }
        ReqLookupResult() = delete;
    } reqLookupResult;
 
    SnoopList cpuSidePorts;
    std::vector<PortID> localResponsePortIds;
    const Addr linesize;
    const Cycles lookupLatency;
    const unsigned maxEntryCount;
 
    enum LineStatus
    {
        LineSecure = 0x01,
    };
 
    struct SnoopFilterStats : public statistics::Group
    {
        SnoopFilterStats(statistics::Group *parent);
 
        statistics::Scalar totRequests;
        statistics::Scalar hitSingleRequests;
        statistics::Scalar hitMultiRequests;
 
        statistics::Scalar totSnoops;
        statistics::Scalar hitSingleSnoops;
        statistics::Scalar hitMultiSnoops;
    } stats;
};
 
inline SnoopFilter::SnoopMask
SnoopFilter::portToMask(const ResponsePort& port) const
{
    assert(port.getId() != InvalidPortID);
    // if this is not a snooping port, return a zero mask
    return !port.isSnooping() ? 0 :
        ((SnoopMask)1) << localResponsePortIds[port.getId()];
}
 
inline SnoopFilter::SnoopList
SnoopFilter::maskToPortList(SnoopMask port_mask) const
{
    SnoopList res;
    for (const auto& p : cpuSidePorts)
        if ((port_mask & portToMask(*p)).any())
            res.push_back(p);
    return res;
}
 
} // namespace gem5
 
#endif // __MEM_SNOOP_FILTER_HH__