base_set_assoc.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2014, 2017, 2023-2024 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.
 *
 * Copyright (c) 2003-2005,2014 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.
 */

 
#ifndef __MEM_CACHE_TAGS_BASE_SET_ASSOC_HH__
#define __MEM_CACHE_TAGS_BASE_SET_ASSOC_HH__
 
#include <cstdint>
#include <functional>
#include <string>
#include <vector>
 
#include "base/logging.hh"
#include "base/types.hh"
#include "mem/cache/cache_blk.hh"
#include "mem/cache/replacement_policies/base.hh"
#include "mem/cache/replacement_policies/replaceable_entry.hh"
#include "mem/cache/tags/base.hh"
#include "mem/cache/tags/indexing_policies/base.hh"
#include "mem/cache/tags/partitioning_policies/partition_manager.hh"
#include "mem/packet.hh"
#include "params/BaseSetAssoc.hh"
 
namespace gem5
{

class BaseSetAssoc : public BaseTags
{
  protected:
    unsigned allocAssoc;

    std::vector<CacheBlk> blks;

    const bool sequentialAccess;

    replacement_policy::Base *replacementPolicy;
 
  public:
     typedef BaseSetAssocParams Params;

    BaseSetAssoc(const Params &p);

    virtual ~BaseSetAssoc() {};

    void tagsInit() override;

    void invalidate(CacheBlk *blk) override;

    CacheBlk* accessBlock(const PacketPtr pkt, Cycles &lat) override
    {
        CacheBlk *blk = findBlock({pkt->getAddr(), pkt->isSecure()});
 
        // Access all tags in parallel, hence one in each way.  The data side
        // either accesses all blocks in parallel, or one block sequentially on
        // a hit.  Sequential access with a miss doesn't access data.
        stats.tagAccesses += allocAssoc;
        if (sequentialAccess) {
            if (blk != nullptr) {
                stats.dataAccesses += 1;
            }
        } else {
            stats.dataAccesses += allocAssoc;
        }
 
        // If a cache hit
        if (blk != nullptr) {
            // Update number of references to accessed block
            blk->increaseRefCount();
 
            // Update replacement data of accessed block
            replacementPolicy->touch(blk->replacementData, pkt);
        }
 
        // The tag lookup latency is the same for a hit or a miss
        lat = lookupLatency;
 
        return blk;
    }

    CacheBlk* findVictim(const CacheBlk::KeyType& key,
                         const std::size_t size,
                         std::vector<CacheBlk*>& evict_blks,
                         const uint64_t partition_id=0) override
    {
        // Get possible entries to be victimized
        std::vector<ReplaceableEntry*> entries =
            indexingPolicy->getPossibleEntries(key);
 
        // Filter entries based on PartitionID
        if (partitionManager) {
            partitionManager->filterByPartition(entries, partition_id);
        }
 
        // Choose replacement victim from replacement candidates
        CacheBlk* victim = entries.empty() ? nullptr :
            static_cast<CacheBlk*>(replacementPolicy->getVictim(entries));
 
        // There is only one eviction for this replacement
        evict_blks.push_back(victim);
 
        return victim;
    }

    void insertBlock(const PacketPtr pkt, CacheBlk *blk) override
    {
        // Insert block
        BaseTags::insertBlock(pkt, blk);
 
        // Increment tag counter
        stats.tagsInUse++;
 
        if (partitionManager) {
            auto partition_id = partitionManager->readPacketPartitionID(pkt);
            partitionManager->notifyAcquire(partition_id);
        }
 
        // Update replacement policy
        replacementPolicy->reset(blk->replacementData, pkt);
    }
 
    void moveBlock(CacheBlk *src_blk, CacheBlk *dest_blk) override;

    virtual void setWayAllocationMax(int ways) override
    {
        fatal_if(ways < 1, "Allocation limit must be greater than zero");
        allocAssoc = ways;
    }

    virtual int getWayAllocationMax() const override
    {
        return allocAssoc;
    }

    Addr regenerateBlkAddr(const CacheBlk* blk) const override
    {
        return indexingPolicy->regenerateAddr({blk->getTag(), false}, blk);
    }
 
    bool anyBlk(std::function<bool(CacheBlk &)> visitor) override {
        for (CacheBlk& blk : blks) {
            if (visitor(blk)) {
                return true;
            }
        }
        return false;
    }
};
 
} // namespace gem5
 
#endif //__MEM_CACHE_TAGS_BASE_SET_ASSOC_HH__