sector_tags.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2024 ARM Limited
 *
 * 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) 2018 Inria
 * 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_SECTOR_TAGS_HH__
#define __MEM_CACHE_TAGS_SECTOR_TAGS_HH__
 
#include <cstdint>
#include <string>
#include <vector>
 
#include "base/statistics.hh"
#include "mem/cache/tags/base.hh"
#include "mem/cache/tags/sector_blk.hh"
#include "mem/packet.hh"
#include "params/SectorTags.hh"
 
namespace gem5
{
 
namespace replacement_policy
{
    class Base;
}
class ReplaceableEntry;

class SectorTags : public BaseTags
{
  private:
    std::vector<SectorSubBlk> blks;
    std::vector<SectorBlk> secBlks;
 
  protected:
    unsigned allocAssoc;

    const bool sequentialAccess;

    replacement_policy::Base *replacementPolicy;

    const unsigned numBlocksPerSector;

    const unsigned numSectors;
 
    // Organization of an address:
    // Tag | Placement Location | Sector Offset # | Offset #
    const int sectorShift;

    const unsigned sectorMask;
 
    struct SectorTagsStats : public statistics::Group
    {
        const SectorTags& tags;
 
        SectorTagsStats(BaseTagStats &base_group, SectorTags& _tags);
 
        void regStats() override;

        statistics::Vector evictionsReplacement;
    } sectorStats;
 
  public:
     typedef SectorTagsParams Params;

    SectorTags(const Params &p);

    virtual ~SectorTags() {};

    void tagsInit() override;

    void invalidate(CacheBlk *blk) override;

    CacheBlk* accessBlock(const PacketPtr pkt, Cycles &lat) override;

    void insertBlock(const PacketPtr pkt, CacheBlk *blk) override;
 
    void moveBlock(CacheBlk *src_blk, CacheBlk *dest_blk) override;

    CacheBlk* findBlock(const CacheBlk::KeyType &key) const override;

    CacheBlk* findVictim(const CacheBlk::KeyType &key,
                         const std::size_t size,
                         std::vector<CacheBlk*>& evict_blks,
                         const uint64_t partition_id) override;

    int extractSectorOffset(Addr addr) const;

    Addr regenerateBlkAddr(const CacheBlk* blk) const override;

    bool anyBlk(std::function<bool(CacheBlk &)> visitor) override;
};
 
} // namespace gem5
 
#endif //__MEM_CACHE_TAGS_SECTOR_TAGS_HH__