base.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2020 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.
 */
 
#ifndef __MEM_CACHE_COMPRESSORS_BASE_HH__
#define __MEM_CACHE_COMPRESSORS_BASE_HH__
 
#include <cstdint>
 
#include "base/compiler.hh"
#include "base/statistics.hh"
#include "base/types.hh"
#include "sim/sim_object.hh"
 
namespace gem5
{
 
class BaseCache;
class CacheBlk;
struct BaseCacheCompressorParams;
 
namespace compression
{
 
class Base : public SimObject
{
  public:
    class CompressionData;
 
  protected:
    typedef uint64_t Chunk;
 
    friend class Multi;
 
    const std::size_t blkSize;
 
    const unsigned chunkSizeBits;
 
    const std::size_t sizeThreshold;
 
    const Cycles compChunksPerCycle;
 
    const Cycles compExtraLatency;
 
    const Cycles decompChunksPerCycle;
 
    const Cycles decompExtraLatency;
 
    BaseCache* cache;
 
    struct BaseStats : public statistics::Group
    {
        const Base& compressor;
 
        BaseStats(Base& compressor);
 
        void regStats() override;
 
        statistics::Scalar compressions;
 
        statistics::Scalar failedCompressions;
 
        statistics::Vector compressionSize;
 
        statistics::Scalar compressionSizeBits;
 
        statistics::Formula avgCompressionSizeBits;
 
        statistics::Scalar decompressions;
    } stats;
 
    std::vector<Chunk> toChunks(const uint64_t* data) const;
 
    void fromChunks(const std::vector<Chunk>& chunks, uint64_t* data) const;
 
    virtual std::unique_ptr<CompressionData> compress(
        const std::vector<Chunk>& chunks, Cycles& comp_lat,
        Cycles& decomp_lat) = 0;
 
    virtual void decompress(const CompressionData* comp_data,
                              uint64_t* cache_line) = 0;
 
  public:
    typedef BaseCacheCompressorParams Params;
    Base(const Params &p);
    virtual ~Base() = default;
 
    virtual void setCache(BaseCache *_cache);
 
    std::unique_ptr<CompressionData>
    compress(const uint64_t* data, Cycles& comp_lat, Cycles& decomp_lat);
 
    Cycles getDecompressionLatency(const CacheBlk* blk);
 
    static void setDecompressionLatency(CacheBlk* blk, const Cycles lat);
 
    static void setSizeBits(CacheBlk* blk, const std::size_t size_bits);
};
 
class Base::CompressionData
{
  private:
    std::size_t _size;
 
  public:
    CompressionData();
 
    virtual ~CompressionData();
 
    void setSizeBits(std::size_t size);
 
    std::size_t getSizeBits() const;
 
    std::size_t getSize() const;
};
 
} // namespace compression
} // namespace gem5
 
#endif //__MEM_CACHE_COMPRESSORS_BASE_HH__