src/mem/cache/replacement_policies/ReplacementPolicies.py

   1 # Copyright (c) 2018 Inria
   2 # All rights reserved.
   3 #
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions are
   6 # met: redistributions of source code must retain the above copyright
   7 # notice, this list of conditions and the following disclaimer;
   8 # redistributions in binary form must reproduce the above copyright
   9 # notice, this list of conditions and the following disclaimer in the
  10 # documentation and/or other materials provided with the distribution;
  11 # neither the name of the copyright holders nor the names of its
  12 # contributors may be used to endorse or promote products derived from
  13 # this software without specific prior written permission.
  14 #
  15 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  17 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  18 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  19 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  21 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 #
  27 # Authors: Daniel Carvalho
  28
  29 from m5.params import *
  30 from m5.proxy import *
  31 from m5.SimObject import SimObject
  32
  33 class BaseReplacementPolicy(SimObject):
  34     type = 'BaseReplacementPolicy'
  35     abstract = True
  36     cxx_header = "mem/cache/replacement_policies/base.hh"
  37
  38 class FIFORP(BaseReplacementPolicy):
  39     type = 'FIFORP'
  40     cxx_class = 'FIFORP'
  41     cxx_header = "mem/cache/replacement_policies/fifo_rp.hh"
  42
  43 class SecondChanceRP(FIFORP):
  44     type = 'SecondChanceRP'
  45     cxx_class = 'SecondChanceRP'
  46     cxx_header = "mem/cache/replacement_policies/second_chance_rp.hh"
  47
  48 class LFURP(BaseReplacementPolicy):
  49     type = 'LFURP'
  50     cxx_class = 'LFURP'
  51     cxx_header = "mem/cache/replacement_policies/lfu_rp.hh"
  52
  53 class LRURP(BaseReplacementPolicy):
  54     type = 'LRURP'
  55     cxx_class = 'LRURP'
  56     cxx_header = "mem/cache/replacement_policies/lru_rp.hh"
  57
  58 class BIPRP(LRURP):
  59     type = 'BIPRP'
  60     cxx_class = 'BIPRP'
  61     cxx_header = "mem/cache/replacement_policies/bip_rp.hh"
  62     btp = Param.Percent(3, "Percentage of blocks to be inserted as MRU")
  63
  64 class LIPRP(BIPRP):
  65     btp = 0
  66
  67 class MRURP(BaseReplacementPolicy):
  68     type = 'MRURP'
  69     cxx_class = 'MRURP'
  70     cxx_header = "mem/cache/replacement_policies/mru_rp.hh"
  71
  72 class RandomRP(BaseReplacementPolicy):
  73     type = 'RandomRP'
  74     cxx_class = 'RandomRP'
  75     cxx_header = "mem/cache/replacement_policies/random_rp.hh"
  76
  77 class BRRIPRP(BaseReplacementPolicy):
  78     type = 'BRRIPRP'
  79     cxx_class = 'BRRIPRP'
  80     cxx_header = "mem/cache/replacement_policies/brrip_rp.hh"
  81     max_RRPV = Param.Int(3, "Maximum RRPV possible")
  82     hit_priority = Param.Bool(False,
  83         "Prioritize evicting blocks that havent had a hit recently")
  84     btp = Param.Percent(3,
  85         "Percentage of blocks to be inserted with long RRPV")
  86
  87 class RRIPRP(BRRIPRP):
  88     btp = 100
  89
  90 class NRURP(BRRIPRP):
  91     btp = 100
  92     max_RRPV = 1
  93
  94 class TreePLRURP(BaseReplacementPolicy):
  95     type = 'TreePLRURP'
  96     cxx_class = 'TreePLRURP'
  97     cxx_header = "mem/cache/replacement_policies/tree_plru_rp.hh"
  98     num_leaves = Param.Int(Parent.assoc, "Number of leaves in each tree")