base.hh revision 12684
112600Sodanrc@yahoo.com.br/** 212600Sodanrc@yahoo.com.br * Copyright (c) 2018 Inria 312600Sodanrc@yahoo.com.br * All rights reserved. 412600Sodanrc@yahoo.com.br * 512600Sodanrc@yahoo.com.br * Redistribution and use in source and binary forms, with or without 612600Sodanrc@yahoo.com.br * modification, are permitted provided that the following conditions are 712600Sodanrc@yahoo.com.br * met: redistributions of source code must retain the above copyright 812600Sodanrc@yahoo.com.br * notice, this list of conditions and the following disclaimer; 912600Sodanrc@yahoo.com.br * redistributions in binary form must reproduce the above copyright 1012600Sodanrc@yahoo.com.br * notice, this list of conditions and the following disclaimer in the 1112600Sodanrc@yahoo.com.br * documentation and/or other materials provided with the distribution; 1212600Sodanrc@yahoo.com.br * neither the name of the copyright holders nor the names of its 1312600Sodanrc@yahoo.com.br * contributors may be used to endorse or promote products derived from 1412600Sodanrc@yahoo.com.br * this software without specific prior written permission. 1512600Sodanrc@yahoo.com.br * 1612600Sodanrc@yahoo.com.br * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1712600Sodanrc@yahoo.com.br * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1812600Sodanrc@yahoo.com.br * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1912600Sodanrc@yahoo.com.br * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2012600Sodanrc@yahoo.com.br * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2112600Sodanrc@yahoo.com.br * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2212600Sodanrc@yahoo.com.br * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2312600Sodanrc@yahoo.com.br * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2412600Sodanrc@yahoo.com.br * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2512600Sodanrc@yahoo.com.br * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2612600Sodanrc@yahoo.com.br * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2712600Sodanrc@yahoo.com.br * 2812600Sodanrc@yahoo.com.br * Authors: Daniel Carvalho 2912600Sodanrc@yahoo.com.br */ 3012600Sodanrc@yahoo.com.br 3112600Sodanrc@yahoo.com.br#ifndef __MEM_CACHE_REPLACEMENT_POLICIES_BASE_HH__ 3212600Sodanrc@yahoo.com.br#define __MEM_CACHE_REPLACEMENT_POLICIES_BASE_HH__ 3312600Sodanrc@yahoo.com.br 3412684Sodanrc@yahoo.com.br#include <memory> 3512684Sodanrc@yahoo.com.br 3612600Sodanrc@yahoo.com.br#include "params/BaseReplacementPolicy.hh" 3712600Sodanrc@yahoo.com.br#include "sim/sim_object.hh" 3812600Sodanrc@yahoo.com.br 3912600Sodanrc@yahoo.com.br/** 4012684Sodanrc@yahoo.com.br * The replacement data needed by the replacement policy. 4112684Sodanrc@yahoo.com.br * Each replacement policy should have its own replacement data. 4212684Sodanrc@yahoo.com.br */ 4312684Sodanrc@yahoo.com.brstruct ReplacementData {}; 4412684Sodanrc@yahoo.com.br 4512684Sodanrc@yahoo.com.br/** 4612684Sodanrc@yahoo.com.br * A replaceable entry is used by any table-like structure that needs to 4712684Sodanrc@yahoo.com.br * implement replacement functionality. It provides the replacement data 4812684Sodanrc@yahoo.com.br * pointer instantiated and needed by the replacement policy used. 4912684Sodanrc@yahoo.com.br * @sa Replacement Policies 5012684Sodanrc@yahoo.com.br */ 5112684Sodanrc@yahoo.com.brclass ReplaceableEntry 5212684Sodanrc@yahoo.com.br{ 5312684Sodanrc@yahoo.com.br public: 5412684Sodanrc@yahoo.com.br /** 5512684Sodanrc@yahoo.com.br * Replacement data associated to this entry. 5612684Sodanrc@yahoo.com.br * It is instantiated by the replacement policy. 5712684Sodanrc@yahoo.com.br */ 5812684Sodanrc@yahoo.com.br std::shared_ptr<ReplacementData> replacementData; 5912684Sodanrc@yahoo.com.br}; 6012684Sodanrc@yahoo.com.br 6112684Sodanrc@yahoo.com.br/** 6212600Sodanrc@yahoo.com.br * Replacement candidates as chosen by the indexing policy. 6312600Sodanrc@yahoo.com.br */ 6412684Sodanrc@yahoo.com.brtypedef std::vector<ReplaceableEntry*> ReplacementCandidates; 6512600Sodanrc@yahoo.com.br 6612600Sodanrc@yahoo.com.br/** 6712600Sodanrc@yahoo.com.br * A common base class of cache replacement policy objects. 6812600Sodanrc@yahoo.com.br */ 6912600Sodanrc@yahoo.com.brclass BaseReplacementPolicy : public SimObject 7012600Sodanrc@yahoo.com.br{ 7112600Sodanrc@yahoo.com.br public: 7212600Sodanrc@yahoo.com.br /** 7312600Sodanrc@yahoo.com.br * Convenience typedef. 7412600Sodanrc@yahoo.com.br */ 7512600Sodanrc@yahoo.com.br typedef BaseReplacementPolicyParams Params; 7612600Sodanrc@yahoo.com.br 7712600Sodanrc@yahoo.com.br /** 7812600Sodanrc@yahoo.com.br * Construct and initiliaze this replacement policy. 7912600Sodanrc@yahoo.com.br */ 8012684Sodanrc@yahoo.com.br BaseReplacementPolicy(const Params *p) : SimObject(p) {} 8112600Sodanrc@yahoo.com.br 8212600Sodanrc@yahoo.com.br /** 8312600Sodanrc@yahoo.com.br * Destructor. 8412600Sodanrc@yahoo.com.br */ 8512600Sodanrc@yahoo.com.br virtual ~BaseReplacementPolicy() {} 8612600Sodanrc@yahoo.com.br 8712600Sodanrc@yahoo.com.br /** 8812684Sodanrc@yahoo.com.br * Invalidate replacement data to set it as the next probable victim. 8912600Sodanrc@yahoo.com.br * 9012684Sodanrc@yahoo.com.br * @param replacement_data Replacement data to be invalidated. 9112600Sodanrc@yahoo.com.br */ 9212684Sodanrc@yahoo.com.br virtual void invalidate(const std::shared_ptr<ReplacementData>& 9312684Sodanrc@yahoo.com.br replacement_data) const = 0; 9412600Sodanrc@yahoo.com.br 9512600Sodanrc@yahoo.com.br /** 9612684Sodanrc@yahoo.com.br * Update replacement data. 9712600Sodanrc@yahoo.com.br * 9812684Sodanrc@yahoo.com.br * @param replacement_data Replacement data to be touched. 9912684Sodanrc@yahoo.com.br */ 10012684Sodanrc@yahoo.com.br virtual void touch(const std::shared_ptr<ReplacementData>& 10112684Sodanrc@yahoo.com.br replacement_data) const = 0; 10212684Sodanrc@yahoo.com.br 10312684Sodanrc@yahoo.com.br /** 10412684Sodanrc@yahoo.com.br * Reset replacement data. Used when it's holder is inserted/validated. 10512600Sodanrc@yahoo.com.br * 10612684Sodanrc@yahoo.com.br * @param replacement_data Replacement data to be reset. 10712600Sodanrc@yahoo.com.br */ 10812684Sodanrc@yahoo.com.br virtual void reset(const std::shared_ptr<ReplacementData>& 10912684Sodanrc@yahoo.com.br replacement_data) const = 0; 11012600Sodanrc@yahoo.com.br 11112600Sodanrc@yahoo.com.br /** 11212600Sodanrc@yahoo.com.br * Find replacement victim among candidates. 11312600Sodanrc@yahoo.com.br * 11412600Sodanrc@yahoo.com.br * @param candidates Replacement candidates, selected by indexing policy. 11512684Sodanrc@yahoo.com.br * @return Replacement entry to be replaced. 11612600Sodanrc@yahoo.com.br */ 11712684Sodanrc@yahoo.com.br virtual ReplaceableEntry* getVictim( 11812684Sodanrc@yahoo.com.br const ReplacementCandidates& candidates) const = 0; 11912684Sodanrc@yahoo.com.br 12012684Sodanrc@yahoo.com.br /** 12112684Sodanrc@yahoo.com.br * Instantiate a replacement data entry. 12212684Sodanrc@yahoo.com.br * 12312684Sodanrc@yahoo.com.br * @return A shared pointer to the new replacement data. 12412684Sodanrc@yahoo.com.br */ 12512684Sodanrc@yahoo.com.br virtual std::shared_ptr<ReplacementData> instantiateEntry() = 0; 12612600Sodanrc@yahoo.com.br}; 12712600Sodanrc@yahoo.com.br 12812600Sodanrc@yahoo.com.br#endif // __MEM_CACHE_REPLACEMENT_POLICIES_BASE_HH__ 129