replaceable_entry.hh revision 14117
112841Sgabeblack@google.com/** 212841Sgabeblack@google.com * Copyright (c) 2018 Inria 312841Sgabeblack@google.com * All rights reserved. 412841Sgabeblack@google.com * 512841Sgabeblack@google.com * Redistribution and use in source and binary forms, with or without 612841Sgabeblack@google.com * modification, are permitted provided that the following conditions are 712841Sgabeblack@google.com * met: redistributions of source code must retain the above copyright 812841Sgabeblack@google.com * notice, this list of conditions and the following disclaimer; 912841Sgabeblack@google.com * redistributions in binary form must reproduce the above copyright 1012841Sgabeblack@google.com * notice, this list of conditions and the following disclaimer in the 1112841Sgabeblack@google.com * documentation and/or other materials provided with the distribution; 1212841Sgabeblack@google.com * neither the name of the copyright holders nor the names of its 1312841Sgabeblack@google.com * contributors may be used to endorse or promote products derived from 1412841Sgabeblack@google.com * this software without specific prior written permission. 1512841Sgabeblack@google.com * 1612841Sgabeblack@google.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1712841Sgabeblack@google.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1812841Sgabeblack@google.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1912841Sgabeblack@google.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2012841Sgabeblack@google.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2112841Sgabeblack@google.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2212841Sgabeblack@google.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2312841Sgabeblack@google.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2412841Sgabeblack@google.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2512841Sgabeblack@google.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2612841Sgabeblack@google.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2712841Sgabeblack@google.com * 2812841Sgabeblack@google.com * Authors: Daniel Carvalho 2912841Sgabeblack@google.com */ 3012841Sgabeblack@google.com 3112841Sgabeblack@google.com#ifndef __MEM_CACHE_REPLACEMENT_POLICIES_REPLACEABLE_ENTRY_HH__ 3212841Sgabeblack@google.com#define __MEM_CACHE_REPLACEMENT_POLICIES_REPLACEABLE_ENTRY_HH__ 3312841Sgabeblack@google.com 3412841Sgabeblack@google.com#include <cstdint> 3512841Sgabeblack@google.com#include <memory> 3612841Sgabeblack@google.com 3712841Sgabeblack@google.com/** 3812841Sgabeblack@google.com * The replacement data needed by replacement policies. Each replacement policy 3912841Sgabeblack@google.com * should have its own implementation of replacement data. 4012841Sgabeblack@google.com */ 4112841Sgabeblack@google.comstruct ReplacementData {}; 4212841Sgabeblack@google.com 4312841Sgabeblack@google.com/** 4412841Sgabeblack@google.com * A replaceable entry is a basic entry in a 2d table-like structure that needs 4512841Sgabeblack@google.com * to have replacement functionality. This entry is located in a specific row 4612841Sgabeblack@google.com * and column of the table (set and way in cache nomenclature), which are 4712841Sgabeblack@google.com * stored within the entry itself. 4812841Sgabeblack@google.com * 4912841Sgabeblack@google.com * It contains the replacement data pointer, which must be instantiated by the 5012841Sgabeblack@google.com * replacement policy before being used. 5112841Sgabeblack@google.com * @sa Replacement Policies 5212841Sgabeblack@google.com */ 5312841Sgabeblack@google.comclass ReplaceableEntry 5412841Sgabeblack@google.com{ 5512841Sgabeblack@google.com private: 5612841Sgabeblack@google.com /** 5712841Sgabeblack@google.com * Set to which this entry belongs. 5812841Sgabeblack@google.com */ 5912841Sgabeblack@google.com uint32_t _set; 6012841Sgabeblack@google.com 6112878Sgabeblack@google.com /** 6212878Sgabeblack@google.com * Way (relative position within the set) to which this entry belongs. 6312878Sgabeblack@google.com */ 6412878Sgabeblack@google.com uint32_t _way; 6512841Sgabeblack@google.com 6612841Sgabeblack@google.com public: 6712841Sgabeblack@google.com /** 6812841Sgabeblack@google.com * Replacement data associated to this entry. 6912841Sgabeblack@google.com * It must be instantiated by the replacement policy before being used. 7012841Sgabeblack@google.com */ 7112841Sgabeblack@google.com std::shared_ptr<ReplacementData> replacementData; 7212841Sgabeblack@google.com 7312841Sgabeblack@google.com /** 7412841Sgabeblack@google.com * Set both the set and way. Should be called only once. 7512841Sgabeblack@google.com * 7612841Sgabeblack@google.com * @param set The set of this entry. 7712841Sgabeblack@google.com * @param way The way of this entry. 7812841Sgabeblack@google.com */ 7912841Sgabeblack@google.com virtual void 8012841Sgabeblack@google.com setPosition(const uint32_t set, const uint32_t way) 8112841Sgabeblack@google.com { 8212841Sgabeblack@google.com _set = set; 8312841Sgabeblack@google.com _way = way; 8412841Sgabeblack@google.com } 8512841Sgabeblack@google.com 8612841Sgabeblack@google.com /** 8712878Sgabeblack@google.com * Get set number. 8812878Sgabeblack@google.com * 8912878Sgabeblack@google.com * @return The set to which this entry belongs. 9012878Sgabeblack@google.com */ 9112841Sgabeblack@google.com uint32_t getSet() const { return _set; } 9212841Sgabeblack@google.com 9312841Sgabeblack@google.com /** 94 * Get way number. 95 * 96 * @return The way to which this entry belongs. 97 */ 98 uint32_t getWay() const { return _way; } 99}; 100 101#endif // __MEM_CACHE_REPLACEMENT_POLICIES_REPLACEABLE_ENTRY_HH_ 102