fa_lru.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2013,2016 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.
 *
 * Authors: Erik Hallnor
 */

#ifndef __MEM_CACHE_TAGS_FA_LRU_HH__
#define __MEM_CACHE_TAGS_FA_LRU_HH__

#include <list>
#include <unordered_map>

#include "mem/cache/base.hh"
#include "mem/cache/blk.hh"
#include "mem/cache/tags/base.hh"
#include "mem/packet.hh"
#include "params/FALRU.hh"

class FALRUBlk : public CacheBlk
{
public:
    FALRUBlk *prev;
    FALRUBlk *next;
    bool isTouched;

    int inCache;
};

class FALRU : public BaseTags
{
  public:
    typedef FALRUBlk BlkType;

  protected:
    FALRUBlk **cacheBoundaries;
    int cacheMask;
    unsigned numCaches;

    FALRUBlk *blks;

    FALRUBlk *head;
    FALRUBlk *tail;

    typedef std::unordered_map<Addr, FALRUBlk *, std::hash<Addr> > hash_t;
    typedef hash_t::const_iterator tagIterator;

    hash_t tagHash;

    FALRUBlk * hashLookup(Addr addr) const;

    void moveToHead(FALRUBlk *blk);

    bool check();

    Stats::Vector hits;
    Stats::Vector misses;
    Stats::Scalar accesses;

public:

    typedef FALRUParams Params;

    FALRU(const Params *p);
    ~FALRU();

    void regStats() override;

    void invalidate(CacheBlk *blk) override;

    CacheBlk* accessBlock(Addr addr, bool is_secure, Cycles &lat,
                          int *inCache);

    CacheBlk* accessBlock(Addr addr, bool is_secure, Cycles &lat) override;

    CacheBlk* findBlock(Addr addr, bool is_secure) const override;

    CacheBlk* findVictim(Addr addr) override;

    void insertBlock(PacketPtr pkt, CacheBlk *blk) override;

    CacheBlk* findBlockBySetAndWay(int set, int way) const override;

    Addr extractTag(Addr addr) const override
    {
        return blkAlign(addr);
    }

    int extractSet(Addr addr) const override
    {
        return 0;
    }

    Addr regenerateBlkAddr(Addr tag, unsigned set) const override
    {
        return (tag);
    }

    virtual std::string print() const override { return ""; }

    void forEachBlk(CacheBlkVisitor &visitor) override {
        for (int i = 0; i < numBlocks; i++) {
            if (!visitor(blks[i]))
                return;
        }
    }

};

#endif // __MEM_CACHE_TAGS_FA_LRU_HH__