base.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2014, 2016-2019, 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 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_HH__
#define __MEM_CACHE_TAGS_BASE_HH__
 
#include <cassert>
#include <cstdint>
#include <functional>
#include <string>
 
#include "base/callback.hh"
#include "base/logging.hh"
#include "base/statistics.hh"
#include "base/types.hh"
#include "mem/cache/cache_blk.hh"
#include "mem/packet.hh"
#include "params/BaseTags.hh"
#include "sim/clocked_object.hh"
 
namespace gem5
{
 
class System;
class IndexingPolicy;
class ReplaceableEntry;
 
class BaseTags : public ClockedObject
{
  protected:
    const unsigned blkSize;
    const Addr blkMask;
    const unsigned size;
    const Cycles lookupLatency;
 
    System *system;
 
    BaseIndexingPolicy *indexingPolicy;
 
    partitioning_policy::PartitionManager *partitionManager;
 
    const unsigned warmupBound;
    bool warmedUp;
 
    const unsigned numBlocks;
 
    std::unique_ptr<uint8_t[]> dataBlks;
 
    struct BaseTagStats : public statistics::Group
    {
        BaseTagStats(BaseTags &tags);
 
        void regStats() override;
        void preDumpStats() override;
 
        BaseTags &tags;
 
        statistics::Average tagsInUse;
 
        statistics::Scalar totalRefs;
 
        statistics::Scalar sampledRefs;
 
        statistics::Formula avgRefs;
 
        statistics::Scalar warmupTick;
 
        statistics::AverageVector occupancies;
 
        statistics::Formula avgOccs;
 
        statistics::Vector occupanciesTaskId;
 
        statistics::Vector2d ageTaskId;
 
        statistics::Formula ratioOccsTaskId;
 
        statistics::Scalar tagAccesses;
        statistics::Scalar dataAccesses;
    } stats;
 
  public:
    typedef BaseTagsParams Params;
    BaseTags(const Params &p);
 
    virtual ~BaseTags() {}
 
    virtual void tagsInit() = 0;
 
    void cleanupRefs();
 
    void computeStats();
 
    std::string print();
 
    virtual CacheBlk *findBlock(Addr addr, bool is_secure) const;
 
    virtual ReplaceableEntry* findBlockBySetAndWay(int set, int way) const;
 
    Addr blkAlign(Addr addr) const
    {
        return addr & ~blkMask;
    }
 
    int extractBlkOffset(Addr addr) const
    {
        return (addr & blkMask);
    }
 
    virtual void setWayAllocationMax(int ways)
    {
        panic("This tag class does not implement way allocation limit!\n");
    }
 
    virtual int getWayAllocationMax() const
    {
        panic("This tag class does not implement way allocation limit!\n");
        return -1;
    }
 
    virtual void invalidate(CacheBlk *blk)
    {
        assert(blk);
        assert(blk->isValid());
 
        stats.occupancies[blk->getSrcRequestorId()]--;
        stats.totalRefs += blk->getRefCount();
        stats.sampledRefs++;
 
        blk->invalidate();
    }
 
    virtual CacheBlk* findVictim(Addr addr, const bool is_secure,
                                 const std::size_t size,
                                 std::vector<CacheBlk*>& evict_blks,
                                 const uint64_t partition_id=0) = 0;
 
    virtual CacheBlk* accessBlock(const PacketPtr pkt, Cycles &lat) = 0;
 
    virtual Addr extractTag(const Addr addr) const;
 
    virtual void insertBlock(const PacketPtr pkt, CacheBlk *blk);
 
    virtual void moveBlock(CacheBlk *src_blk, CacheBlk *dest_blk);
 
    virtual Addr regenerateBlkAddr(const CacheBlk* blk) const = 0;
 
    void forEachBlk(std::function<void(CacheBlk &)> visitor);
 
    virtual bool anyBlk(std::function<bool(CacheBlk &)> visitor) = 0;
 
  private:
    void cleanupRefsVisitor(CacheBlk &blk);
 
    void computeStatsVisitor(CacheBlk &blk);
};
 
} // namespace gem5
 
#endif //__MEM_CACHE_TAGS_BASE_HH__