mem-cache: Make BDI a multi compressor

BDI is a compressor containing multiple sub-compressors.

Change-Id: I98411e2ef9dcc2182801a172dfc59ed7a8ee7dd4
Signed-off-by: Daniel R. Carvalho <odanrc@yahoo.com.br>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/21159
Tested-by: kokoro <noreply+kokoro@google.com>
Maintainer: Jason Lowe-Power <jason@lowepower.com>
Reviewed-by: Bobby R. Bruce <bbruce@ucdavis.edu>

4 files changed, 5 insertions, 919 deletions

diff --git a/src/mem/cache/compressors/Compressors.py b/src/mem/cache/compressors/Compressors.py
index c3fcd2317..f95824ec6 100644
--- a/src/mem/cache/compressors/Compressors.py
+++ b/src/mem/cache/compressors/Compressors.py
@@ -78,15 +78,6 @@ class Base16Delta8(BaseDictionaryCompressor):
     cxx_class = 'Base16Delta8'
     cxx_header = "mem/cache/compressors/base_delta.hh"
 
-class BDI(BaseCacheCompressor):
-    type = 'BDI'
-    cxx_class = 'BDI'
-    cxx_header = "mem/cache/compressors/bdi.hh"
-
-    use_more_compressors = Param.Bool(True, "True if should use all possible" \
-        "combinations of base and delta for the compressors. False if using" \
-        "only the lowest possible delta size for each base size.");
-
 class CPack(BaseDictionaryCompressor):
     type = 'CPack'
     cxx_class = 'CPack'
@@ -118,3 +109,8 @@ class ZeroCompressor(BaseDictionaryCompressor):
     type = 'ZeroCompressor'
     cxx_class = 'ZeroCompressor'
     cxx_header = "mem/cache/compressors/zero.hh"
+
+class BDI(MultiCompressor):
+    compressors = [ZeroCompressor(), RepeatedQwordsCompressor(),
+        Base64Delta8(), Base64Delta16(), Base64Delta32(), Base32Delta8(),
+        Base32Delta16(), Base16Delta8()]
diff --git a/src/mem/cache/compressors/SConscript b/src/mem/cache/compressors/SConscript
index c3f22b8b6..23464dd6c 100644
--- a/src/mem/cache/compressors/SConscript
+++ b/src/mem/cache/compressors/SConscript
@@ -35,7 +35,6 @@ SimObject('Compressors.py')
 Source('base.cc')
 Source('base_dictionary_compressor.cc')
 Source('base_delta.cc')
-Source('bdi.cc')
 Source('cpack.cc')
 Source('fpcd.cc')
 Source('multi.cc')
diff --git a/src/mem/cache/compressors/bdi.cc b/src/mem/cache/compressors/bdi.cc
deleted file mode 100644
index a8068c614..000000000
--- a/src/mem/cache/compressors/bdi.cc
+++ /dev/null
@@ -1,481 +0,0 @@
-/*
- * Copyright (c) 2018 Inria
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are
- * met: redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer;
- * redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution;
- * neither the name of the copyright holders nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * Authors: Daniel Carvalho
- */
-
-/** @file
- * Implementation of the BDI cache compressor.
- */
-
-#include "mem/cache/compressors/bdi.hh"
-
-#include <algorithm>
-#include <climits>
-#include <cstring>
-#include <type_traits>
-
-#include "debug/CacheComp.hh"
-#include "params/BDI.hh"
-
-// Number of bytes in a qword
-#define BYTES_PER_QWORD 8
-
-// Declare BDI encoding names
-const char* BDI::ENCODING_NAMES[] =
-    {"Zero", "Repeated_Values", "Base8_1", "Base8_2", "Base8_4", "Base4_1",
-     "Base4_2", "Base2_1", "Uncompressed"};
-
-BDI::BDICompData::BDICompData(const uint8_t encoding)
-    : CompressionData(), _encoding(encoding)
-{
-}
-
-uint8_t
-BDI::BDICompData::getEncoding() const
-{
-    return _encoding;
-}
-
-std::string
-BDI::BDICompData::getName() const
-{
-    return ENCODING_NAMES[_encoding];
-}
-
-BDI::BDICompDataZeros::BDICompDataZeros()
-    : BDICompData(ZERO)
-{
-    // Calculate compressed size
-    calculateCompressedSize();
-}
-
-uint64_t
-BDI::BDICompDataZeros::access(const int index) const
-{
-    return 0;
-}
-
-void
-BDI::BDICompDataZeros::calculateCompressedSize()
-{
-    // Number of bits used by Encoding
-    std::size_t size = encodingBits;
-
-    setSizeBits(size);
-}
-
-BDI::BDICompDataRep::BDICompDataRep(const uint64_t rep_value)
-    : BDICompData(REP_VALUES)
-{
-    // Set base value
-    base = rep_value;
-
-    // Calculate compressed size
-    calculateCompressedSize();
-}
-
-uint64_t
-BDI::BDICompDataRep::access(const int index) const
-{
-    return base;
-}
-
-void
-BDI::BDICompDataRep::calculateCompressedSize()
-{
-    // Number of bits used by Encoding
-    std::size_t size = encodingBits;
-
-    // Number of bits used by Base
-    size += sizeof(base)*CHAR_BIT;
-
-    setSizeBits(size);
-}
-
-BDI::BDICompDataUncompressed::BDICompDataUncompressed(
-    const uint64_t* data, const std::size_t blk_size)
-    : BDICompData(UNCOMPRESSED), blkSize(blk_size),
-      _data(data, data + blk_size/CHAR_BIT)
-{
-    // Calculate compressed size
-    calculateCompressedSize();
-}
-
-uint64_t
-BDI::BDICompDataUncompressed::access(const int index) const
-{
-    return _data[index];
-}
-
-void
-BDI::BDICompDataUncompressed::calculateCompressedSize()
-{
-    // Number of bits used by Encoding
-    std::size_t size = encodingBits;
-
-    // Number of bits used by uncompressed line
-    size += blkSize*CHAR_BIT;
-
-    setSizeBits(size);
-}
-
-template <class TB, class TD>
-BDI::BDICompDataBaseDelta<TB, TD>::BDICompDataBaseDelta(const uint8_t encoding,
-    const std::size_t blk_size, const std::size_t max_num_bases)
-    : BDICompData(encoding), maxNumBases(max_num_bases)
-{
-    // Reserve the maximum possible size for the vectors
-    bases.reserve(maxNumBases);
-    bitMask.reserve(blk_size/sizeof(TD));
-    deltas.reserve(blk_size/sizeof(TD));
-
-    // Push virtual base 0 to bases list
-    bases.push_back(0);
-}
-
-template <class TB, class TD>
-void
-BDI::BDICompDataBaseDelta<TB, TD>::calculateCompressedSize()
-{
-    // Number of bits used by Encoding
-    std::size_t size = encodingBits;
-
-    // Number of bits used by BitMask
-    size += bitMask.size()*std::ceil(std::log2(maxNumBases));
-
-    // Number of bits used by Bases. bases[0] is implicit in a hardware
-    // implementation, therefore its size is 0
-    size += (maxNumBases-1)*sizeof(TB)*CHAR_BIT;
-
-    // Number of bits used by Deltas
-    size += deltas.size()*sizeof(TD)*CHAR_BIT;
-
-    CompressionData::setSizeBits(size);
-}
-
-template <class TB, class TD>
-bool
-BDI::BDICompDataBaseDelta<TB, TD>::addBase(const TB base)
-{
-    // Can't add base if reached limit of number of bases
-    if (bases.size() >= maxNumBases) {
-        return false;
-    }
-
-    // Push new base to end of bases list
-    bases.push_back(base);
-
-    // New delta is 0, as it is a difference between the new base and itself
-    addDelta(bases.size() - 1, 0);
-
-    return true;
-}
-
-template <class TB, class TD>
-void
-BDI::BDICompDataBaseDelta<TB, TD>::addDelta(const std::size_t base_index,
-    const TD delta)
-{
-    // Insert new delta with respect to the given base
-    bitMask.push_back(base_index);
-
-    // Insert new delta
-    deltas.push_back(delta);
-}
-
-template <class TB, class TD> bool
-BDI::BDICompDataBaseDelta<TB, TD>::compress(const uint64_t* data,
-    const std::size_t blk_size)
-{
-    // Parse through data in a sizeof(TB) granularity
-    for (std::size_t byte_start = 0; byte_start < blk_size;
-         byte_start += sizeof(TB))
-    {
-        // Get current value
-        TB curValue;
-        std::memcpy(&curValue, ((uint8_t*)data) + byte_start,
-                    sizeof(TB));
-
-        // Iterate through all bases to search for a valid delta
-        bool foundDelta = false;
-        for (int base_index = 0; base_index < bases.size(); base_index++) {
-            // Calculate delta relative to currently parsed base
-            typename std::make_signed<TB>::type delta = curValue -
-                                                        bases[base_index];
-
-            // Check if the delta is within the limits of the delta size. If
-            // that is the case, add delta to compressed data and keep parsing
-            // the input data
-            typename std::make_signed<TB>::type limit =
-                ULLONG_MAX>>((BYTES_PER_QWORD-sizeof(TD))*CHAR_BIT+1);
-            if ((delta >= -limit) && (delta <= limit)) {
-                addDelta(base_index, delta);
-                foundDelta = true;
-                break;
-            }
-        }
-
-        // If we cannot find a base that can accommodate this new line's data,
-        // add this value as the new base and insert its respective delta of 0.
-        // If the new base can't be added, it means that we reached the base
-        // limit, so line is uncompressible using the given encoding
-        if (!foundDelta && !addBase(curValue)) {
-            return false;
-        }
-    }
-
-    // Calculate compressed size
-    calculateCompressedSize();
-
-    return true;
-}
-
-template <class TB, class TD>
-uint64_t
-BDI::BDICompDataBaseDelta<TB, TD>::access(const int index) const
-{
-    // We decompress all base-delta pairs that form the 64-bit entry
-    // corresponding to the given 64-bit-array index
-    uint64_t value = 0;
-
-    // Get relationship between the size of an uint64_t base and size of TB
-    const std::size_t size_diff = sizeof(uint64_t)/sizeof(TB);
-
-    // Mask for a base entry
-    const uint64_t mask = ULLONG_MAX>>((BYTES_PER_QWORD-sizeof(TB))*CHAR_BIT);
-
-    // Size, in bits, of a base entry. Cant be const because compiler will
-    // optimize and create a 64 bit instance, which will generate a shift size
-    // compilation error
-    int base_size_bits = sizeof(TB)*CHAR_BIT;
-
-    // Concatenate all base-delta entries until they form a 64-bit entry
-    for (int delta_index = size_diff * (index + 1) - 1;
-         delta_index >= (int)(size_diff * index); delta_index--) {
-        // Get base and delta entries corresponding to the current delta
-        assert(delta_index < deltas.size());
-        const TD delta = deltas[delta_index];
-        const int base_index = bitMask[delta_index];
-        assert(base_index < bases.size());
-        const TB base = bases[base_index];
-
-        // Concatenate decompressed value
-        value <<= base_size_bits;
-        value |= static_cast<uint64_t>((base + delta) & mask);
-    }
-
-    return value;
-}
-
-BDI::BDI(const Params *p)
-    : BaseCacheCompressor(p), useMoreCompressors(p->use_more_compressors),
-      qwordsPerCacheLine(blkSize/BYTES_PER_QWORD)
-{
-    static_assert(sizeof(ENCODING_NAMES)/sizeof(char*) == NUM_ENCODINGS,
-                  "Number of encodings doesn't match the number of names");
-}
-
-bool
-BDI::isZeroPackable(const uint64_t* data) const
-{
-    return std::all_of(data, data + qwordsPerCacheLine,
-                       [](const uint64_t entry){ return entry == 0; });
-}
-
-bool
-BDI::isSameValuePackable(const uint64_t* data) const
-{
-    // We don't want to copy the whole array to the lambda expression
-    const uint64_t rep_value = data[0];
-    return std::all_of(data, data + qwordsPerCacheLine,
-                       [rep_value](const uint64_t entry)
-                           {return entry == rep_value;});
-}
-
-template <class TB, class TD>
-std::unique_ptr<BDI::BDICompData>
-BDI::tryCompress(const uint64_t* data, const uint8_t encoding) const
-{
-    // Instantiate compressor
-    auto temp_data = std::unique_ptr<BDICompDataBaseDelta<TB, TD>>(
-        new BDICompDataBaseDelta<TB, TD>(encoding, blkSize));
-
-    // Try compressing. Return nullptr if compressor can't compress given line
-    if (temp_data->compress(data, blkSize)) {
-        return std::move(temp_data);
-    } else {
-        return std::unique_ptr<BDICompData>{};
-    }
-}
-
-void
-BDI::decompress(const BaseCacheCompressor::CompressionData* comp_data,
-                uint64_t* data)
-{
-    // Decompress and go back to host endianness
-    for (std::size_t i = 0; i < qwordsPerCacheLine; i++)
-        data[i] = static_cast<const BDICompData*>(comp_data)->access(i);
-}
-
-std::unique_ptr<BaseCacheCompressor::CompressionData>
-BDI::compress(const uint64_t* data, Cycles& comp_lat, Cycles& decomp_lat)
-{
-    std::unique_ptr<BDICompData> bdi_data;
-
-    // Check if it is a zero line
-    if (isZeroPackable(data)) {
-        bdi_data = std::unique_ptr<BDICompData>(new BDICompDataZeros());
-
-        // Set compression latency (compare 1 qword per cycle)
-        comp_lat = Cycles(qwordsPerCacheLine);
-    // Check if all values in the line are the same
-    } else if (isSameValuePackable(data)) {
-        bdi_data = std::unique_ptr<BDICompData>(new BDICompDataRep(data[0]));
-
-        // Set compression latency (compare 1 qword per cycle)
-        comp_lat = Cycles(qwordsPerCacheLine);
-    } else {
-        // Initialize compressed data as an uncompressed instance
-        bdi_data = std::unique_ptr<BDICompData>(
-                  new BDICompDataUncompressed(data, blkSize));
-
-        // Base size-delta size ratio. Used to optimize run and try to
-        // compress less combinations when their size is worse than the
-        // current best. It does not reflect the compression ratio, as
-        // it does not take the metadata into account.
-        int base_delta_ratio = 2;
-
-        // Check which base-delta size combination is the best. This is
-        // optimized by giving priority to trying the compressor that would
-        // generate the smallest compression size. This way we waste less
-        // simulation time by not doing all possible combinations
-        for (int ratio = 8; ratio >= base_delta_ratio; ratio/=2) {
-            for (int base_size = 8; base_size >= ratio; base_size/=2) {
-                // If using more compressors, parse all delta sizes from 1 to
-                // one size smaller than the base size, otherwise just parse
-                // highest possible delta. When we only instantiate one delta
-                // size per base size, we use less area and energy, at the
-                // cost of lower compression efficiency
-                const int delta_size = base_size/ratio;
-                if (!useMoreCompressors && delta_size != base_size/2) {
-                    continue;
-                }
-
-                std::unique_ptr<BDICompData> temp_bdi_data;
-
-                // Get the compression result for the current combination
-                if ((base_size == 8)&&(delta_size == 4)) {
-                    temp_bdi_data = tryCompress<uint64_t, int32_t>(data,
-                                                                   BASE8_4);
-                } else if ((base_size == 8)&&(delta_size == 2)) {
-                    temp_bdi_data = tryCompress<uint64_t, int16_t>(data,
-                                                                   BASE8_2);
-                } else if ((base_size == 8)&&(delta_size == 1)) {
-                    temp_bdi_data = tryCompress<uint64_t, int8_t>(data,
-                                                                  BASE8_1);
-                } else if ((base_size == 4)&&(delta_size == 2)) {
-                    temp_bdi_data = tryCompress<uint32_t, int16_t>(data,
-                                                                   BASE4_2);
-                } else if ((base_size == 4)&&(delta_size == 1)) {
-                    temp_bdi_data = tryCompress<uint32_t, int8_t>(data,
-                                                                  BASE4_1);
-                } else if ((base_size == 2)&&(delta_size == 1)) {
-                    temp_bdi_data = tryCompress<uint16_t, int8_t>(data,
-                                                                  BASE2_1);
-                } else {
-                    fatal("Invalid combination of base and delta sizes.");
-                }
-
-                // If compressor was successful, check if new compression
-                // improves the compression factor
-                if (temp_bdi_data &&
-                    (bdi_data->getSizeBits() > temp_bdi_data->getSizeBits()))
-                {
-                    bdi_data = std::move(temp_bdi_data);
-                    base_delta_ratio = ratio;
-                }
-
-                // Clear temp pointer
-                temp_bdi_data.reset(nullptr);
-            }
-        }
-
-        // Set compression latency. A successful compressor will stop all
-        // other compressors when it knows no other will generate a better
-        // compression. However, this requires either hard-coding, or a complex
-        // function that can calculate the exact size of every compressor for
-        // every cache line size. We decide to take a conservative
-        // optimization: assume that all compressors with a given base size
-        // delta size ratio (no-metadata ratio) must wait for each other.
-        // In the worst case scenario the data is left uncompressed, so
-        // it loses the time of the worst base size (2 bytes per cycle)
-        comp_lat = Cycles(blkSize/base_delta_ratio);
-    }
-
-    // Update stats
-    encodingStats[bdi_data->getEncoding()]++;
-
-    // Pack compression results (1 extra cycle)
-    comp_lat += Cycles(1);
-
-    // Set decompression latency (latency of an adder)
-    decomp_lat = Cycles(1);
-
-    // Print debug information
-    DPRINTF(CacheComp, "BDI: Compressed cache line to encoding %s (%d bits)\n",
-            bdi_data->getName(), bdi_data->getSizeBits());
-
-    return std::move(bdi_data);
-}
-
-void
-BDI::regStats()
-{
-    BaseCacheCompressor::regStats();
-
-    // We store the frequency of each encoding
-    encodingStats
-        .init(NUM_ENCODINGS)
-        .name(name() + ".encoding")
-        .desc("Number of data entries that were compressed to this encoding.")
-        ;
-
-    for (unsigned i = 0; i < NUM_ENCODINGS; ++i) {
-        encodingStats.subname(i, ENCODING_NAMES[i]);
-        encodingStats.subdesc(i, "Number of data entries that match " \
-                                 "encoding " + std::string(ENCODING_NAMES[i]));
-    }
-}
-
-BDI*
-BDIParams::create()
-{
-    return new BDI(this);
-}
-
-#undef BYTES_PER_QWORD
diff --git a/src/mem/cache/compressors/bdi.hh b/src/mem/cache/compressors/bdi.hh
deleted file mode 100644
index 9a145fa81..000000000
--- a/src/mem/cache/compressors/bdi.hh
+++ /dev/null
@@ -1,428 +0,0 @@
-/*
- * Copyright (c) 2018 Inria
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are
- * met: redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer;
- * redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution;
- * neither the name of the copyright holders nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * Authors: Daniel Carvalho
- */
-
-/** @file
- * Definition of "Base-Delta-Immediate Compression: Practical Data Compression
- * for On-Chip Caches".
- */
-
-#ifndef __MEM_CACHE_COMPRESSORS_BDI_HH__
-#define __MEM_CACHE_COMPRESSORS_BDI_HH__
-
-#include <cstdint>
-#include <memory>
-#include <vector>
-
-#include "base/types.hh"
-#include "mem/cache/compressors/base.hh"
-
-struct BDIParams;
-
-/**
- * Default maximum number of bases in the original BDI.
- */
-#define BDI_DEFAULT_MAX_NUM_BASES 2
-
-class BDI : public BaseCacheCompressor
-{
-  protected:
-    /**
-     * Forward declaration of comp data classes.
-     */
-    class BDICompData;
-    class BDICompDataZeros;
-    class BDICompDataRep;
-    class BDICompDataUncompressed;
-    template <class TB, class TD> class BDICompDataBaseDelta;
-
-    /**
-     * The possible encoding values. If modified, ENCODING_NAMES must be too.
-     */
-    enum ENCODING {ZERO, REP_VALUES, BASE8_1, BASE8_2, BASE8_4, BASE4_1,
-                   BASE4_2, BASE2_1, UNCOMPRESSED, NUM_ENCODINGS};
-
-    /**
-     * The respective encoding names. They are indexed by the ENCODING enum.
-     * The values are assigned in the source file, and should be modified if
-     * ENCODING is changed.
-     */
-    static const char* ENCODING_NAMES[];
-
-    /**
-     * If set, create multiple compressor instances for each possible
-     * combination of base and delta size. Otherwise, just create a
-     * compressor for each base size with the highest available delta
-     * size. This can be used to save area and power (having less
-     * compressors). True by default.
-     */
-    const bool useMoreCompressors;
-
-    /**
-     * Number of qwords in a cache line.
-     */
-    const std::size_t qwordsPerCacheLine;
-
-    /**
-     * @defgroup CompressionStats Compression specific statistics.
-     * @{
-     */
-
-    /**
-     * Number of data entries that were compressed to each encoding.
-     */
-    Stats::Vector encodingStats;
-
-    /**
-     * @}
-     */
-
-    /**
-     * Check if the cache line consists of only zero values.
-     *
-     * @param data The cache line.
-     * @return True if it is a ZERO cache line.
-     */
-    bool isZeroPackable(const uint64_t* data) const;
-
-    /**
-     * Check if the cache line consists only of same values.
-     *
-     * @param data The cache line.
-     * @return True if it is a REP_VALUES cache line.
-     */
-    bool isSameValuePackable(const uint64_t* data) const;
-
-    /**
-     * Instantiate a BaseDelta compressor with given TB and TD, and try to
-     * compress the cache line. If the compression fails, it returns a nullptr.
-     * @sa BDICompDataBaseDelta
-     *
-     * @tparam TB Type of a base entry.
-     * @tparam TD Type of a delta entry.
-     * @param data The cache line to be compressed.
-     * @param encoding Encoding value for given TB-TD combination.
-     * @return Cache line after compression or nullptr.
-     */
-    template <class TB, class TD>
-    std::unique_ptr<BDICompData> tryCompress(const uint64_t* data,
-                                             const uint8_t encoding) const;
-
-    /**
-     * Apply compression.
-     *
-     * @param data The cache line to be compressed.
-     * @param comp_lat Compression latency in number of cycles.
-     * @param decomp_lat Decompression latency in number of cycles.
-     * @param comp_size Compressed data size.
-     */
-    std::unique_ptr<BaseCacheCompressor::CompressionData> compress(
-        const uint64_t* data, Cycles& comp_lat, Cycles& decomp_lat) override;
-
-    /**
-     * Decompress data.
-     *
-     * @param comp_data Compressed cache line.
-     * @param data The cache line to be decompressed.
-     * @return Decompression latency in number of cycles.
-     */
-    void decompress(const BaseCacheCompressor::CompressionData* comp_data,
-                                           uint64_t* data) override;
-
-  public:
-    /** Convenience typedef. */
-    typedef BDIParams Params;
-
-    /**
-     * Default constructor.
-     */
-    BDI(const Params *p);
-
-    /**
-     * Default destructor.
-     */
-    ~BDI() = default;
-
-    /**
-     * Register local statistics.
-     */
-    void regStats() override;
-};
-
-/**
- * Template for the BDI compression data.
- */
-class BDI::BDICompData : public CompressionData
-{
-  private:
-    /**
-     * Data encoding.
-     * @sa BDI
-     */
-    const uint8_t _encoding;
-
-  protected:
-    /**
-     * Number of bits needed for the encoding field.
-     */
-    static const std::size_t encodingBits = 4;
-
-    /**
-     * Calculate and set compressed data size.
-     * Each BDI compressor generates compressed data with different sizes.
-    */
-    virtual void calculateCompressedSize() = 0;
-
-  public:
-    /**
-     * Default constructor.
-     *
-     * @param encoding The encoding value.
-     */
-    BDICompData(const uint8_t encoding);
-
-    /**
-     * Default destructor.
-     */
-    virtual ~BDICompData() = default;
-
-    /**
-     * Get and decompress data at given index.
-     *
-     * The index is given relative to 64-bit entries, therefore if the base
-     * size of the given compressed data is smaller than that, this function
-     * joins multiple base-delta entries to generate the respective 64-bit
-     * entry.
-     *
-     * @param index The index of the compressed data.
-     * @return Decompressed data for the given index.
-     */
-    virtual uint64_t access(const int index) const = 0;
-
-    /**
-     * Get encoding.
-     *
-     * @return The encoding.
-     */
-    uint8_t getEncoding() const;
-
-    /**
-     * Get encoding name.
-     *
-     * @return The encoding name.
-     */
-    std::string getName() const;
-};
-
-/**
- * BDI compressed data containing the ZERO encoding.
- */
-class BDI::BDICompDataZeros : public BDICompData
-{
-  protected:
-    /**
-     * Calculate compressed data size using ZERO encoding.
-     */
-    void calculateCompressedSize() override;
-
-  public:
-    /**
-     * Default constructor.
-    */
-    BDICompDataZeros();
-
-    /**
-     * Get and decompress data at given index. Must always return 0.
-     *
-     * @param index The index of the compressed data.
-     * @return Decompressed data for the given index.
-     */
-    uint64_t access(const int index) const override;
-};
-
-/**
- * BDI compressed data containing the REP_VALUES encoding.
- */
-class BDI::BDICompDataRep : public BDICompData
-{
-  private:
-    /**
-     * The repeated value.
-     */
-    uint64_t base;
-
-  protected:
-    /**
-     * Calculate compressed data size using REP_VALUES encoding.
-     */
-    void calculateCompressedSize() override;
-
-  public:
-    /**
-     * Default constructor.
-     *
-     * @param rep_value The repeated value.
-     */
-    BDICompDataRep(const uint64_t rep_value);
-
-    /**
-     * Get and decompress data at given index. Must always return the same
-     * value as data[0].
-     *
-     * @param index The index of the compressed data.
-     * @return Decompressed data for the given index.
-     */
-    uint64_t access(const int index) const override;
-};
-
-/**
- * BDI compressed data containing the UNCOMPRESSED encoding.
- */
-class BDI::BDICompDataUncompressed : public BDICompData
-{
-  private:
-    /**
-     * Uncompressed cache line size (in bytes).
-     */
-    const std::size_t blkSize;
-
-    /**
-     * The compressed data is the original cache line.
-     */
-    const std::vector<uint64_t> _data;
-
-  protected:
-    /**
-     * Calculate compressed data size using UNCOMPRESSED encoding.
-     */
-    void calculateCompressedSize() override;
-
-  public:
-    /**
-     * Default constructor.
-     *
-     * @param data The data on which compression was applied.
-     * @param blk_size Size of a cache line in bytes.
-     */
-    BDICompDataUncompressed(const uint64_t* data,
-                            const std::size_t blk_size);
-
-    /**
-     * Get and decompress data at given index. Must return the same
-     * value as _data[index].
-     *
-     * @param index The index of the compressed data.
-     * @return Decompressed data for the given index.
-     */
-    uint64_t access(const int index) const override;
-};
-
-/**
- * Template class for BDI compressed data containing all the BASE_DELTA
- * encodings. TB's size must always be greater than TD's.
- *
- * @tparam TB Type of a base entry.
- * @tparam TD Type of a delta entry.
-*/
-template <class TB, class TD>
-class BDI::BDICompDataBaseDelta : public BDICompData
-{
-  protected:
-    /**
-     * Maximum number of bases.
-     */
-    const std::size_t maxNumBases;
-
-    /**
-     * Bit mask to differentiate between the bases.
-     */
-    std::vector<uint8_t> bitMask;
-
-    /**
-     * Bases. bases[0] is 0 and is not stored in a hardware implementation.
-     */
-    std::vector<TB> bases;
-
-    /**
-     * Array of deltas (or immediate values).
-     */
-    std::vector<TD> deltas;
-
-    /**
-     * Add a base to the bases vector.
-     *
-     * @param base The base to be added.
-     * @return True on success, false if already used all base slots.
-     */
-    bool addBase(const TB base);
-
-    /**
-     * Add a delta to the deltas vector.
-     *
-     * @param base_index Base to which the delta refers.
-     * @param delta The delta value.
-     */
-    void addDelta(const std::size_t base_index, const TD delta);
-
-    /**
-     * Calculate compressed data size using number of bases, the base size and
-     * the delta size.
-     */
-    void calculateCompressedSize() override;
-
-  public:
-    /**
-     * Default constructor.
-     *
-     * @param encoding The encoding value for this compressor.
-     * @param blk_size Size of a cache line in bytes.
-     * @param max_num_bases Maximum number of bases allowed to be stored.
-     */
-    BDICompDataBaseDelta(const uint8_t encoding, const std::size_t blk_size,
-        const std::size_t max_num_bases = BDI_DEFAULT_MAX_NUM_BASES);
-
-    /**
-     * Get and decompress data at given index.
-     *
-     * @param index The index of the compressed data.
-     * @return Decompressed data for the given index.
-     */
-    uint64_t access(const int index) const override;
-
-    /**
-     * Apply base delta compression.
-     *
-     * @param data The data on which compression was applied.
-     * @param blk_size Size of a cache line in bytes.
-     * @return True on success.
-     */
-    bool compress(const uint64_t* data, const std::size_t blk_size);
-};
-
-#endif //__MEM_CACHE_COMPRESSORS_BDI_HH__