CPIBasedPartitionedLRUPolicy.java

/**
 * ****************************************************************************
 * Copyright (c) 2010-2016 by Min Cai (min.cai.china@gmail.com).
 * <p>
 * This file is part of the Archimulator multicore architectural simulator.
 * <p>
 * Archimulator is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * <p>
 * Archimulator is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * <p>
 * You should have received a copy of the GNU General Public License
 * along with Archimulator. If not, see <http://www.gnu.org/licenses/>.
 * ****************************************************************************
 */
package archimulator.uncore.cache.replacement.partitioned.cpiBased;

import archimulator.common.report.ReportNode;
import archimulator.uncore.cache.EvictableCache;
import archimulator.uncore.cache.partitioning.cpiBased.CPIBasedCachePartitioningHelper;
import archimulator.uncore.cache.replacement.partitioned.PartitionedLRUPolicy;

import java.io.Serializable;
import java.util.List;

/**
 * CPI based partitioned least recently used (LRU) policy.
 *
 * @param <StateT> the state type of the parent evictable cache
 * @author Min Cai
 */
public class CPIBasedPartitionedLRUPolicy<StateT extends Serializable> extends PartitionedLRUPolicy<StateT> {
    private CPIBasedCachePartitioningHelper cpiBasedCachePartitioningHelper;

    /**
     * Create a CPI based partitioned least recently used (LRU) policy for the specified evictable cache.
     *
     * @param cache the parent evictable cache
     */
    public CPIBasedPartitionedLRUPolicy(EvictableCache<StateT> cache) {
        super(cache);

        this.cpiBasedCachePartitioningHelper = new CPIBasedCachePartitioningHelper(cache);
        this.cpiBasedCachePartitioningHelper.setShouldIncludePredicate(set -> true);
    }

    @Override
    protected List<Integer> getPartition(int set) {
        return getCpiBasedCachePartitioningHelper().getPartition();
    }

    @Override
    public void dumpStats(ReportNode reportNode) {
        for (int way : getNumPartitionsPerWay().keySet()) {
            reportNode.getChildren().add(new ReportNode(reportNode, "numPartitionsPerWay[" + way + "]", getNumPartitionsPerWay().get(way) + ""));
        }
        getCpiBasedCachePartitioningHelper().dumpStats(reportNode);
    }

    /**
     * Get the CPI based cache partitioning helper.
     *
     * @return the CPI based cache partitioning helper
     */
    public CPIBasedCachePartitioningHelper getCpiBasedCachePartitioningHelper() {
        return cpiBasedCachePartitioningHelper;
    }
}