base.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Inria
 * Copyright (c) 2012-2014,2017 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_INDEXING_POLICIES_BASE_HH__
#define __MEM_CACHE_INDEXING_POLICIES_BASE_HH__
 
#include <vector>
 
#include "params/BaseIndexingPolicy.hh"
#include "sim/sim_object.hh"
 
namespace gem5
{
 
class ReplaceableEntry;
 
class BaseIndexingPolicy : public SimObject
{
  protected:
    const unsigned assoc;
 
    const uint32_t numSets;
 
    const int setShift;
 
    const unsigned setMask;
 
    std::vector<std::vector<ReplaceableEntry*>> sets;
 
    const int tagShift;
 
  public:
    typedef BaseIndexingPolicyParams Params;
 
    BaseIndexingPolicy(const Params &p);
 
    ~BaseIndexingPolicy() {};
 
    void setEntry(ReplaceableEntry* entry, const uint64_t index);
 
    ReplaceableEntry* getEntry(const uint32_t set, const uint32_t way) const;
 
    virtual Addr extractTag(const Addr addr) const;
 
    virtual std::vector<ReplaceableEntry*> getPossibleEntries(const Addr addr)
                                                                    const = 0;
 
    virtual Addr regenerateAddr(const Addr tag, const ReplaceableEntry* entry)
                                                                    const = 0;
};
 
} // namespace gem5
 
#endif //__MEM_CACHE_INDEXING_POLICIES_BASE_HH__