gem5  v21.1.0.2
multi.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-2020 Inria
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met: redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer;
9  * redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution;
12  * neither the name of the copyright holders nor the names of its
13  * contributors may be used to endorse or promote products derived from
14  * this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
34 #ifndef __MEM_CACHE_COMPRESSORS_MULTI_HH__
35 #define __MEM_CACHE_COMPRESSORS_MULTI_HH__
36 
37 #include <cstdint>
38 #include <vector>
39 
40 #include "base/statistics.hh"
41 #include "base/types.hh"
43 
44 namespace gem5
45 {
46 
47 struct MultiCompressorParams;
48 
49 GEM5_DEPRECATED_NAMESPACE(Compressor, compression);
50 namespace compression
51 {
52 
53 class Multi : public Base
54 {
55  protected:
62 
65 
81  const std::size_t numEncodingBits;
82 
89 
90  struct MultiStats : public statistics::Group
91  {
92  const Multi& compressor;
93 
94  MultiStats(BaseStats &base_group, Multi& _compressor);
95 
96  void regStats() override;
97 
102  } multiStats;
103 
104  public:
105  typedef MultiCompressorParams Params;
106  Multi(const Params &p);
107  ~Multi();
108 
109  void setCache(BaseCache *_cache) override;
110 
111  std::unique_ptr<Base::CompressionData> compress(
112  const std::vector<Base::Chunk>& chunks,
113  Cycles& comp_lat, Cycles& decomp_lat) override;
114 
115  void decompress(const CompressionData* comp_data, uint64_t* data) override;
116 };
117 
119 {
120  private:
122  const uint8_t index;
123 
124  public:
126  std::unique_ptr<Base::CompressionData> compData;
127 
134  MultiCompData(unsigned index,
135  std::unique_ptr<Base::CompressionData> comp_data);
136 
138  ~MultiCompData() = default;
139 
141  uint8_t getIndex() const;
142 };
143 
144 } // namespace compression
145 } // namespace gem5
146 
147 #endif //__MEM_CACHE_COMPRESSORS_MULTI_HH__
gem5::compression::Base::CompressionData
Definition: base.hh:246
data
const char data[]
Definition: circlebuf.test.cc:48
gem5::compression::Multi::compressors
std::vector< Base * > compressors
List of sub-compressors.
Definition: multi.hh:61
gem5::compression::Multi::MultiCompData::index
const uint8_t index
Index of the compressor that provided these compression results.
Definition: multi.hh:122
gem5::compression::Multi::MultiCompData::compData
std::unique_ptr< Base::CompressionData > compData
Compression data of the best compressor.
Definition: multi.hh:126
base.hh
gem5::statistics::Vector2d
A 2-Dimensional vecto of scalar stats.
Definition: statistics.hh:2055
gem5::compression::Base::Params
BaseCacheCompressorParams Params
Definition: base.hh:202
gem5::compression::Multi::MultiStats
Definition: multi.hh:90
std::vector
STL vector class.
Definition: stl.hh:37
gem5::compression::Multi::numEncodingBits
const std::size_t numEncodingBits
An encoding is associated to each sub-compressor to inform which sub-compressor to use when decompres...
Definition: multi.hh:81
gem5::compression::Multi::decompress
void decompress(const CompressionData *comp_data, uint64_t *data) override
Apply the decompression process to the compressed data.
Definition: multi.cc:185
gem5::Cycles
Cycles is a wrapper class for representing cycle counts, i.e.
Definition: types.hh:78
gem5::compression::Multi::MultiCompData::MultiCompData
MultiCompData(unsigned index, std::unique_ptr< Base::CompressionData > comp_data)
Default constructor.
Definition: multi.cc:52
gem5::compression::Multi::Params
MultiCompressorParams Params
Definition: multi.hh:105
gem5::BaseCache
A basic cache interface.
Definition: base.hh:95
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
statistics.hh
gem5::compression::Base
Base cache compressor interface.
Definition: base.hh:65
gem5::compression::Multi::MultiStats::ranks
statistics::Vector2d ranks
Number of times each compressor provided the nth best compression.
Definition: multi.hh:101
gem5::compression::Multi::extraDecompressionLatency
const Cycles extraDecompressionLatency
Extra decompression latency to be added to the sub-compressor's decompression latency.
Definition: multi.hh:88
gem5::compression::Multi::MultiCompData::~MultiCompData
~MultiCompData()=default
Default destructor.
gem5::GEM5_DEPRECATED_NAMESPACE
GEM5_DEPRECATED_NAMESPACE(GuestABI, guest_abi)
gem5::compression::Multi::MultiStats::regStats
void regStats() override
Callback to set stat parameters.
Definition: multi.cc:202
gem5::compression::Multi::setCache
void setCache(BaseCache *_cache) override
The cache can only be set once.
Definition: multi.cc:82
gem5::compression::Base::Multi
friend class Multi
This compressor must be able to access the protected functions of its sub-compressors.
Definition: base.hh:89
gem5::compression::Multi::MultiStats::MultiStats
MultiStats(BaseStats &base_group, Multi &_compressor)
Definition: multi.cc:194
types.hh
gem5::compression::Multi::multiStats
gem5::compression::Multi::MultiStats multiStats
gem5::compression::Multi::compress
std::unique_ptr< Base::CompressionData > compress(const std::vector< Base::Chunk > &chunks, Cycles &comp_lat, Cycles &decomp_lat) override
Apply the compression process to the cache line.
Definition: multi.cc:91
gem5::statistics::Group
Statistics container.
Definition: group.hh:93
gem5::compression::Multi::MultiStats::compressor
const Multi & compressor
Definition: multi.hh:92
gem5::compression::Multi::~Multi
~Multi()
Definition: multi.cc:74
gem5::compression::Multi::MultiCompData
Definition: multi.hh:118
gem5::compression::Multi::MultiCompData::getIndex
uint8_t getIndex() const
Get the index of the best compressor.
Definition: multi.cc:60
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::compression::Multi
Definition: multi.hh:53
gem5::compression::Base::BaseStats
Definition: base.hh:132

Generated on Tue Sep 21 2021 12:25:29 for gem5 by doxygen 1.8.17