src/mem/cache/compressors/Compressors.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 BaseCacheCompressor(SimObject):
  34     type = 'BaseCacheCompressor'
  35     abstract = True
  36     cxx_header = "mem/cache/compressors/base.hh"
  37
  38     block_size = Param.Int(Parent.cache_line_size, "Block size in bytes")
  39     size_threshold = Param.Unsigned(Parent.cache_line_size, "Minimum size, "
  40         "in bytes, in which a block must be compressed to. Otherwise it is "
  41         "stored in its uncompressed state")
  42
  43 class BDI(BaseCacheCompressor):
  44     type = 'BDI'
  45     cxx_class = 'BDI'
  46     cxx_header = "mem/cache/compressors/bdi.hh"
  47
  48     use_more_compressors = Param.Bool(True, "True if should use all possible" \
  49         "combinations of base and delta for the compressors. False if using" \
  50         "only the lowest possible delta size for each base size.");
  51
  52 class CPack(BaseCacheCompressor):
  53     type = 'CPack'
  54     cxx_class = 'CPack'
  55     cxx_header = "mem/cache/compressors/cpack.hh"