|
gem5 [DEVELOP-FOR-25.0]
|
A pattern that compares masked values against dictionary entries. More...
#include <dictionary_compressor.hh>
Public Types | |
| typedef BaseDictionaryCompressorParams | Params |
Public Types inherited from gem5::compression::BaseDictionaryCompressor | |
| typedef BaseDictionaryCompressorParams | Params |
Public Types inherited from gem5::compression::Base | |
| typedef BaseCacheCompressorParams | Params |
Public Types inherited from gem5::SimObject | |
| typedef SimObjectParams | Params |
Public Types inherited from gem5::compression::DictionaryCompressor< T >::Pattern | |
| typedef BaseDictionaryCompressorParams | Params |
Public Member Functions | |
| MaskedPattern (const int number, const uint64_t code, const uint64_t metadata_length, const int match_location, const DictionaryEntry bytes, const bool allocate=true) | |
| DictionaryEntry | decompress (const DictionaryEntry dict_bytes) const override |
| Decompress the pattern. | |
| DictionaryCompressor (const Params &p) | |
| ~DictionaryCompressor ()=default | |
Public Member Functions inherited from gem5::compression::BaseDictionaryCompressor | |
| BaseDictionaryCompressor (const Params &p) | |
| ~BaseDictionaryCompressor ()=default | |
Public Member Functions inherited from gem5::compression::Base | |
| Base (const Params &p) | |
| virtual | ~Base ()=default |
| virtual void | setCache (BaseCache *_cache) |
| The cache can only be set once. | |
| std::unique_ptr< CompressionData > | compress (const uint64_t *data, Cycles &comp_lat, Cycles &decomp_lat) |
| Apply the compression process to the cache line. | |
| Cycles | getDecompressionLatency (const CacheBlk *blk) |
| Get the decompression latency if the block is compressed. | |
Public Member Functions inherited from gem5::SimObject | |
| const Params & | params () const |
| SimObject (const Params &p) | |
| virtual | ~SimObject () |
| virtual void | init () |
| init() is called after all C++ SimObjects have been created and all ports are connected. | |
| virtual void | loadState (CheckpointIn &cp) |
| loadState() is called on each SimObject when restoring from a checkpoint. | |
| virtual void | initState () |
| initState() is called on each SimObject when not restoring from a checkpoint. | |
| virtual void | regProbePoints () |
| Register probe points for this object. | |
| virtual void | regProbeListeners () |
| Register probe listeners for this object. | |
| ProbeManager * | getProbeManager () |
| Get the probe manager for this object. | |
| virtual Port & | getPort (const std::string &if_name, PortID idx=InvalidPortID) |
| Get a port with a given name and index. | |
| virtual void | startup () |
| startup() is the final initialization call before simulation. | |
| DrainState | drain () override |
| Provide a default implementation of the drain interface for objects that don't need draining. | |
| virtual void | memWriteback () |
| Write back dirty buffers to memory using functional writes. | |
| virtual void | memInvalidate () |
| Invalidate the contents of memory buffers. | |
| void | serialize (CheckpointOut &cp) const override |
| Serialize an object. | |
| void | unserialize (CheckpointIn &cp) override |
| Unserialize an object. | |
Public Member Functions inherited from gem5::EventManager | |
| EventQueue * | eventQueue () const |
| void | schedule (Event &event, Tick when) |
| void | deschedule (Event &event) |
| void | reschedule (Event &event, Tick when, bool always=false) |
| void | schedule (Event *event, Tick when) |
| void | deschedule (Event *event) |
| void | reschedule (Event *event, Tick when, bool always=false) |
| void | wakeupEventQueue (Tick when=(Tick) -1) |
| This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers. | |
| void | setCurTick (Tick newVal) |
| EventManager (EventManager &em) | |
| Event manger manages events in the event queue. | |
| EventManager (EventManager *em) | |
| EventManager (EventQueue *eq) | |
Public Member Functions inherited from gem5::Serializable | |
| Serializable () | |
| virtual | ~Serializable () |
| void | serializeSection (CheckpointOut &cp, const char *name) const |
| Serialize an object into a new section. | |
| void | serializeSection (CheckpointOut &cp, const std::string &name) const |
| void | unserializeSection (CheckpointIn &cp, const char *name) |
| Unserialize an a child object. | |
| void | unserializeSection (CheckpointIn &cp, const std::string &name) |
Public Member Functions inherited from gem5::Drainable | |
| DrainState | drainState () const |
| Return the current drain state of an object. | |
| virtual void | notifyFork () |
| Notify a child process of a fork. | |
Public Member Functions inherited from gem5::statistics::Group | |
| Group (Group *parent, const char *name=nullptr) | |
| Construct a new statistics group. | |
| virtual | ~Group () |
| virtual void | regStats () |
| Callback to set stat parameters. | |
| virtual void | resetStats () |
| Callback to reset stats. | |
| virtual void | preDumpStats () |
| Callback before stats are dumped. | |
| void | addStat (statistics::Info *info) |
| Register a stat with this group. | |
| const std::map< std::string, Group * > & | getStatGroups () const |
| Get all child groups associated with this object. | |
| const std::vector< Info * > & | getStats () const |
| Get all stats associated with this object. | |
| void | addStatGroup (const char *name, Group *block) |
| Add a stat block as a child of this block. | |
| const Info * | resolveStat (std::string name) const |
| Resolve a stat by its name within this group. | |
| void | mergeStatGroup (Group *block) |
| Merge the contents (stats & children) of a block to this block. | |
| Group ()=delete | |
| Group (const Group &)=delete | |
| Group & | operator= (const Group &)=delete |
Public Member Functions inherited from gem5::Named | |
| Named (std::string_view name_) | |
| virtual | ~Named ()=default |
| virtual std::string | name () const |
Public Member Functions inherited from gem5::compression::DictionaryCompressor< T >::Pattern | |
| Pattern (const int number, const uint64_t code, const uint64_t metadata_length, const uint64_t num_unmatched_bits, const int match_location, const bool allocate=true) | |
| Default constructor. | |
| virtual | ~Pattern ()=default |
| Default destructor. | |
| int | getPatternNumber () const |
| Get enum number associated to this pattern. | |
| uint8_t | getCode () const |
| Get code of this pattern. | |
| uint8_t | getMatchLocation () const |
| Get the index of the dictionary match location. | |
| virtual std::size_t | getSizeBits () const |
| Get size, in bits, of the pattern (excluding prefix). | |
| bool | shouldAllocate () const |
| Determine if pattern allocates a dictionary entry. | |
| std::string | print () const |
| Extract pattern's information to a string. | |
| DictionaryCompressor (const Params &p) | |
| ~DictionaryCompressor ()=default | |
Static Public Member Functions | |
| static bool | isPattern (const DictionaryEntry &bytes, const DictionaryEntry &dict_bytes, const int match_location) |
Static Public Member Functions inherited from gem5::compression::Base | |
| static void | setDecompressionLatency (CacheBlk *blk, const Cycles lat) |
| Set the decompression latency of compressed block. | |
| static void | setSizeBits (CacheBlk *blk, const std::size_t size_bits) |
| Set the size of the compressed block, in bits. | |
Static Public Member Functions inherited from gem5::SimObject | |
| static void | serializeAll (const std::string &cpt_dir) |
| Create a checkpoint by serializing all SimObjects in the system. | |
| static SimObject * | find (const char *name) |
| Find the SimObject with the given name and return a pointer to it. | |
| static void | setSimObjectResolver (SimObjectResolver *resolver) |
| There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. | |
| static SimObjectResolver * | getSimObjectResolver () |
| There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. | |
Static Public Member Functions inherited from gem5::Serializable | |
| static const std::string & | currentSection () |
| Gets the fully-qualified name of the active section. | |
| static void | generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream) |
| Generate a checkpoint file so that the serialization can be routed to it. | |
Protected Types | |
| typedef std::array< uint8_t, sizeof(T)> | DictionaryEntry |
| Convenience typedef for a dictionary entry. | |
Protected Types inherited from gem5::compression::Base | |
| typedef uint64_t | Chunk |
| A chunk is a basic lexical unit. | |
Protected Types inherited from gem5::compression::DictionaryCompressor< T >::Pattern | |
| typedef std::array< uint8_t, sizeof(T)> | DictionaryEntry |
| Convenience typedef for a dictionary entry. | |
Protected Member Functions | |
| virtual std::unique_ptr< Pattern > | getPattern (const DictionaryEntry &bytes, const DictionaryEntry &dict_bytes, const int match_location) const=0 |
| Since the factory cannot be instantiated here, classes that inherit from this base class have to implement the call to their factory's getPattern. | |
| std::unique_ptr< Pattern > | compressValue (const T data) |
| Compress data. | |
| T | decompressValue (const Pattern *pattern) |
| Decompress a pattern into a value that fits in a dictionary entry. | |
| virtual void | resetDictionary () |
| Clear all dictionary entries. | |
| virtual void | addToDictionary (const DictionaryEntry data)=0 |
| Add an entry to the dictionary. | |
| virtual std::unique_ptr< DictionaryCompressor::CompData > | instantiateDictionaryCompData () const |
| Instantiate a compression data of the sub-class compressor. | |
| std::unique_ptr< Base::CompressionData > | compress (const std::vector< Chunk > &chunks) |
| Apply compression. | |
| std::unique_ptr< Base::CompressionData > | compress (const std::vector< Chunk > &chunks, Cycles &comp_lat, Cycles &decomp_lat) override |
| Apply the compression process to the cache line. | |
| void | decompress (const CompressionData *comp_data, uint64_t *data) override |
| Apply the decompression process to the compressed data. | |
Protected Member Functions inherited from gem5::compression::BaseDictionaryCompressor | |
| virtual uint64_t | getNumPatterns () const =0 |
| Trick function to get the number of patterns. | |
| virtual std::string | getName (int number) const =0 |
| Get meta-name assigned to the given pattern. | |
Protected Member Functions inherited from gem5::compression::Base | |
| std::vector< Chunk > | toChunks (const uint64_t *data) const |
| This function splits the raw data into chunks, so that it can be parsed by the compressor. | |
| void | fromChunks (const std::vector< Chunk > &chunks, uint64_t *data) const |
| This function re-joins the chunks to recreate the original data. | |
Protected Member Functions inherited from gem5::Drainable | |
| Drainable () | |
| virtual | ~Drainable () |
| virtual void | drainResume () |
| Resume execution after a successful drain. | |
| void | signalDrainDone () const |
| Signal that an object is drained. | |
Protected Member Functions inherited from gem5::compression::DictionaryCompressor< T >::Pattern | |
| std::unique_ptr< Pattern > | compressValue (const T data) |
| Compress data. | |
| T | decompressValue (const Pattern *pattern) |
| Decompress a pattern into a value that fits in a dictionary entry. | |
| std::unique_ptr< Base::CompressionData > | compress (const std::vector< Chunk > &chunks) |
| Apply compression. | |
| std::unique_ptr< Base::CompressionData > | compress (const std::vector< Chunk > &chunks, Cycles &comp_lat, Cycles &decomp_lat) override |
| Apply the compression process to the cache line. | |
| void | decompress (const CompressionData *comp_data, uint64_t *data) override |
| Apply the decompression process to the compressed data. | |
Static Protected Member Functions | |
| static DictionaryEntry | toDictionaryEntry (T value) |
| Turn a value into a dictionary entry. | |
| static T | fromDictionaryEntry (const DictionaryEntry &entry) |
| Turn a dictionary entry into a value. | |
Static Protected Member Functions inherited from gem5::compression::DictionaryCompressor< T >::Pattern | |
| static DictionaryEntry | toDictionaryEntry (T value) |
| Turn a value into a dictionary entry. | |
| static T | fromDictionaryEntry (const DictionaryEntry &entry) |
| Turn a dictionary entry into a value. | |
Protected Attributes | |
| std::vector< DictionaryEntry > | dictionary |
| The dictionary. | |
Protected Attributes inherited from gem5::compression::BaseDictionaryCompressor | |
| const std::size_t | dictionarySize |
| Dictionary size. | |
| std::size_t | numEntries |
| Number of valid entries in the dictionary. | |
| gem5::compression::BaseDictionaryCompressor::DictionaryStats | dictionaryStats |
Protected Attributes inherited from gem5::compression::Base | |
| const std::size_t | blkSize |
| Uncompressed cache line size (in bytes). | |
| const unsigned | chunkSizeBits |
| Chunk size, in number of bits. | |
| const std::size_t | sizeThreshold |
| Size in bytes at which a compression is classified as bad and therefore the compressed block is restored to its uncompressed format. | |
| const Cycles | compChunksPerCycle |
| Degree of parallelization of the compression process. | |
| const Cycles | compExtraLatency |
| Extra latency added to compression due to packaging, shifting or other operations. | |
| const Cycles | decompChunksPerCycle |
| Degree of parallelization of the decompression process. | |
| const Cycles | decompExtraLatency |
| Extra latency added to decompression due to packaging, shifting or other operations. | |
| BaseCache * | cache |
| Pointer to the parent cache. | |
| gem5::compression::Base::BaseStats | stats |
Protected Attributes inherited from gem5::SimObject | |
| const SimObjectParams & | _params |
| Cached copy of the object parameters. | |
Protected Attributes inherited from gem5::EventManager | |
| EventQueue * | eventq |
| A pointer to this object's event queue. | |
Protected Attributes inherited from gem5::compression::DictionaryCompressor< T >::Pattern | |
| const int | patternNumber |
| Pattern enum number. | |
| const uint8_t | code |
| Code associated to the pattern. | |
| const uint8_t | length |
| Length, in bits, of the code and match location. | |
| const uint8_t | numUnmatchedBits |
| Number of unmatched bits. | |
| const int | matchLocation |
| Index representing the the match location. | |
| const bool | allocate |
| Wether the pattern allocates a dictionary entry or not. | |
| std::vector< DictionaryEntry > | dictionary |
| The dictionary. | |
Private Attributes | |
| const T | bits |
| A copy of the bits that do not belong to the mask. | |
A pattern that compares masked values against dictionary entries.
If the masked dictionary entry matches perfectly the masked value to be compressed, there is a pattern match.
For example, if the mask is 0xFF00 (that is, this pattern matches the MSB), the value (V) 0xFF20 is being compressed, and the dictionary contains the value (D) 0xFF03, this is a match (V & mask == 0xFF00 == D & mask), and 0x0020 is added to the list of unmatched bits.
| mask | A mask containing the bits that must match. |
Definition at line 463 of file dictionary_compressor.hh.
|
protected |
Convenience typedef for a dictionary entry.
Definition at line 121 of file dictionary_compressor.hh.
| typedef BaseDictionaryCompressorParams gem5::compression::DictionaryCompressor< T >::Params |
Definition at line 273 of file dictionary_compressor.hh.
|
inline |
Definition at line 474 of file dictionary_compressor.hh.
References gem5::compression::DictionaryCompressor< T >::Pattern::allocate, bits, gem5::compression::DictionaryCompressor< T >::Pattern::code, DictionaryCompressor(), fromDictionaryEntry(), gem5::ArmISA::mask, gem5::compression::DictionaryCompressor< T >::Pattern::Pattern(), and gem5::popCount().
Referenced by gem5::compression::DictionaryCompressor< T >::LocatedMaskedPattern< mask, location >::LocatedMaskedPattern(), and gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< value, mask >::MaskedValuePattern().
|
default |
|
protectedpure virtual |
Add an entry to the dictionary.
| data | The new entry. |
Implements gem5::compression::DictionaryCompressor< T >::Pattern.
Implemented in gem5::compression::DictionaryCompressor< T >::LocatedMaskedPattern< mask, location >, gem5::compression::DictionaryCompressor< T >::LocatedMaskedPattern< 0xFFFFFFFFFFFFFFFF, 0 >, gem5::compression::DictionaryCompressor< T >::LocatedMaskedPattern< 0xFFFFFFFFFFFFFFFF, 0 >, gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< value, mask >, gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< 0, 0xFFFFFFFFFFFFFFFF >, and gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< 0, 0xFFFFFFFFFFFFFFFF >.
|
protected |
Apply compression.
| chunks | The cache line to be compressed. |
Definition at line 245 of file dictionary_compressor_impl.hh.
|
overrideprotectedvirtual |
Apply the compression process to the cache line.
Returns the number of cycles used by the compressor, however it is usually covered by a good pipelined execution, and is currently ignored. The decompression latency is also returned, in order to avoid increasing simulation time and memory consumption.
| chunks | The cache line to be compressed, divided into chunks. |
| comp_lat | Compression latency in number of cycles. |
| decomp_lat | Decompression latency in number of cycles. |
Implements gem5::compression::Base.
Reimplemented in gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< value, mask >, gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< 0, 0xFFFFFFFFFFFFFFFF >, and gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< 0, 0xFFFFFFFFFFFFFFFF >.
Definition at line 248 of file dictionary_compressor_impl.hh.
|
protected |
Compress data.
| data | Data to be compressed. |
Definition at line 211 of file dictionary_compressor_impl.hh.
|
overrideprotectedvirtual |
Apply the decompression process to the compressed data.
| comp_data | Compressed cache line. |
| cache_line | The cache line to be decompressed. |
Implements gem5::compression::Base.
Reimplemented in gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< value, mask >, gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< 0, 0xFFFFFFFFFFFFFFFF >, and gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< 0, 0xFFFFFFFFFFFFFFFF >.
Definition at line 254 of file dictionary_compressor_impl.hh.
|
inlineoverridevirtual |
Decompress the pattern.
Each pattern has its own way of interpreting its data.
| dict_bytes | The bytes in the corresponding matching entry. |
Implements gem5::compression::DictionaryCompressor< T >::Pattern.
Reimplemented in gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< value, mask >, and gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< 0, 0xFFFFFFFFFFFFFFFF >.
Definition at line 498 of file dictionary_compressor.hh.
References bits, gem5::compression::DictionaryCompressor< T >::fromDictionaryEntry(), gem5::ArmISA::mask, and gem5::compression::DictionaryCompressor< T >::toDictionaryEntry().
Referenced by gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< value, mask >::decompress().
|
protected |
Decompress a pattern into a value that fits in a dictionary entry.
| pattern | The pattern to be decompressed. |
Definition at line 219 of file dictionary_compressor_impl.hh.
| gem5::compression::DictionaryCompressor< T >::DictionaryCompressor | ( | const Params & | p | ) |
Definition at line 274 of file dictionary_compressor_impl.hh.
Referenced by MaskedPattern().
|
staticprotected |
Turn a dictionary entry into a value.
| The | dictionary entry to turn. |
Definition at line 270 of file dictionary_compressor_impl.hh.
Referenced by MaskedPattern().
|
protectedpure virtual |
Since the factory cannot be instantiated here, classes that inherit from this base class have to implement the call to their factory's getPattern.
Implements gem5::compression::DictionaryCompressor< T >::Pattern.
Implemented in gem5::compression::DictionaryCompressor< T >::LocatedMaskedPattern< mask, location >, gem5::compression::DictionaryCompressor< T >::LocatedMaskedPattern< 0xFFFFFFFFFFFFFFFF, 0 >, gem5::compression::DictionaryCompressor< T >::LocatedMaskedPattern< 0xFFFFFFFFFFFFFFFF, 0 >, gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< value, mask >, gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< 0, 0xFFFFFFFFFFFFFFFF >, and gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< 0, 0xFFFFFFFFFFFFFFFF >.
|
protectedvirtual |
Instantiate a compression data of the sub-class compressor.
Reimplemented from gem5::compression::DictionaryCompressor< T >::Pattern.
Reimplemented in gem5::compression::DictionaryCompressor< T >::LocatedMaskedPattern< mask, location >, gem5::compression::DictionaryCompressor< T >::LocatedMaskedPattern< 0xFFFFFFFFFFFFFFFF, 0 >, gem5::compression::DictionaryCompressor< T >::LocatedMaskedPattern< 0xFFFFFFFFFFFFFFFF, 0 >, gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< value, mask >, gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< 0, 0xFFFFFFFFFFFFFFFF >, and gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< 0, 0xFFFFFFFFFFFFFFFF >.
Definition at line 237 of file dictionary_compressor_impl.hh.
|
inlinestatic |
Definition at line 487 of file dictionary_compressor.hh.
References gem5::compression::DictionaryCompressor< T >::fromDictionaryEntry(), and gem5::ArmISA::mask.
Referenced by gem5::compression::DictionaryCompressor< T >::LocatedMaskedPattern< mask, location >::isPattern().
|
protectedvirtual |
Clear all dictionary entries.
Reimplemented from gem5::compression::DictionaryCompressor< T >::Pattern.
Reimplemented in gem5::compression::DictionaryCompressor< T >::LocatedMaskedPattern< mask, location >, gem5::compression::DictionaryCompressor< T >::LocatedMaskedPattern< 0xFFFFFFFFFFFFFFFF, 0 >, gem5::compression::DictionaryCompressor< T >::LocatedMaskedPattern< 0xFFFFFFFFFFFFFFFF, 0 >, gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< value, mask >, gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< 0, 0xFFFFFFFFFFFFFFFF >, and gem5::compression::DictionaryCompressor< T >::MaskedValuePattern< 0, 0xFFFFFFFFFFFFFFFF >.
Definition at line 222 of file dictionary_compressor_impl.hh.
|
staticprotected |
Turn a value into a dictionary entry.
| value | The value to turn. |
Definition at line 262 of file dictionary_compressor_impl.hh.
|
private |
A copy of the bits that do not belong to the mask.
Definition at line 471 of file dictionary_compressor.hh.
Referenced by decompress(), and MaskedPattern().
|
protected |
The dictionary.
Definition at line 194 of file dictionary_compressor.hh.