gem5  v20.0.0.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
MultiCompressor Class Reference

#include <multi.hh>

Inheritance diagram for MultiCompressor:
BaseCacheCompressor SimObject EventManager Serializable Drainable Stats::Group

Classes

class  MultiCompData
 

Public Types

typedef MultiCompressorParams Params
 Convenience typedef. More...
 
- Public Types inherited from BaseCacheCompressor
typedef BaseCacheCompressorParams Params
 Convenience typedef. More...
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

 MultiCompressor (const Params *p)
 Default constructor. More...
 
 ~MultiCompressor ()
 Default destructor. More...
 
void regStats () override
 Callback to set stat parameters. More...
 
std::unique_ptr< BaseCacheCompressor::CompressionDatacompress (const uint64_t *data, Cycles &comp_lat, Cycles &decomp_lat) override
 Apply the compression process to the cache line. More...
 
void decompress (const CompressionData *comp_data, uint64_t *data) override
 Apply the decompression process to the compressed data. More...
 
- Public Member Functions inherited from BaseCacheCompressor
 BaseCacheCompressor (const Params *p)
 Default constructor. More...
 
virtual ~BaseCacheCompressor ()
 Default destructor. More...
 
void compress (const uint64_t *data, Cycles &comp_lat, Cycles &decomp_lat, std::size_t &comp_size_bits)
 Apply the compression process to the cache line. More...
 
Cycles getDecompressionLatency (const CacheBlk *blk)
 Get the decompression latency if the block is compressed. More...
 
- Public Member Functions inherited from SimObject
virtual ~SimObject ()
 
virtual const std::string name () const
 
virtual void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
virtual void loadState (CheckpointIn &cp)
 loadState() is called on each SimObject when restoring from a checkpoint. More...
 
virtual void initState ()
 initState() is called on each SimObject when not restoring from a checkpoint. More...
 
virtual void regProbePoints ()
 Register probe points for this object. More...
 
virtual void regProbeListeners ()
 Register probe listeners for this object. More...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual PortgetPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a port with a given name and index. More...
 
virtual void startup ()
 startup() is the final initialization call before simulation. More...
 
DrainState drain () override
 Provide a default implementation of the drain interface for objects that don't need draining. More...
 
virtual void memWriteback ()
 Write back dirty buffers to memory using functional writes. More...
 
virtual void memInvalidate ()
 Invalidate the contents of memory buffers. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
const Paramsparams () const
 
 SimObject (const Params *_params)
 
- Public Member Functions inherited from EventManager
EventQueueeventQueue () 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)
 
void setCurTick (Tick newVal)
 
 EventManager (EventManager &em)
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
- Public Member Functions inherited from Serializable
 Serializable ()
 
virtual ~Serializable ()
 
void serializeSection (CheckpointOut &cp, const char *name) const
 Serialize an object into a new section. More...
 
void serializeSection (CheckpointOut &cp, const std::string &name) const
 
void unserializeSection (CheckpointIn &cp, const char *name)
 Unserialize an a child object. More...
 
void unserializeSection (CheckpointIn &cp, const std::string &name)
 
- Public Member Functions inherited from Drainable
DrainState drainState () const
 Return the current drain state of an object. More...
 
virtual void notifyFork ()
 Notify a child process of a fork. More...
 
- Public Member Functions inherited from Stats::Group
 Group (Group *parent, const char *name=nullptr)
 Construct a new statistics group. More...
 
virtual ~Group ()
 
virtual void resetStats ()
 Callback to reset stats. More...
 
virtual void preDumpStats ()
 Callback before stats are dumped. More...
 
void addStat (Stats::Info *info)
 Register a stat with this group. More...
 
const std::map< std::string, Group * > & getStatGroups () const
 Get all child groups associated with this object. More...
 
const std::vector< Info * > & getStats () const
 Get all stats associated with this object. More...
 
void addStatGroup (const char *name, Group *block)
 Add a stat block as a child of this block. More...
 
const InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 

Protected Attributes

std::vector< BaseCacheCompressor * > compressors
 List of sub-compressors. More...
 
Stats::Vector2d rankStats
 Number of times each compressor provided the nth best compression. More...
 
- Protected Attributes inherited from BaseCacheCompressor
const std::size_t blkSize
 Uncompressed cache line size (in bytes). More...
 
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. More...
 
BaseCacheCompressor::BaseCacheCompressorStats stats
 
- Protected Attributes inherited from SimObject
const SimObjectParams * _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from BaseCacheCompressor
static void setDecompressionLatency (CacheBlk *blk, const Cycles lat)
 Set the decompression latency of compressed block. More...
 
static void setSizeBits (CacheBlk *blk, const std::size_t size_bits)
 Set the size of the compressed block, in bits. More...
 
- Static Public Member Functions inherited from SimObject
static void serializeAll (CheckpointOut &cp)
 Serialize all SimObjects in the system. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
- Static Public Member Functions inherited from Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 
static void unserializeGlobals (CheckpointIn &cp)
 
- Protected Member Functions inherited from Drainable
 Drainable ()
 
virtual ~Drainable ()
 
virtual void drainResume ()
 Resume execution after a successful drain. More...
 
void signalDrainDone () const
 Signal that an object is drained. More...
 

Detailed Description

Definition at line 45 of file multi.hh.

Member Typedef Documentation

◆ Params

typedef MultiCompressorParams MultiCompressor::Params

Convenience typedef.

Definition at line 72 of file multi.hh.

Constructor & Destructor Documentation

◆ MultiCompressor()

MultiCompressor::MultiCompressor ( const Params p)

Default constructor.

Definition at line 56 of file multi.cc.

References compressors, and fatal_if.

Referenced by regStats().

◆ ~MultiCompressor()

MultiCompressor::~MultiCompressor ( )

Default destructor.

Definition at line 62 of file multi.cc.

References compressors.

Member Function Documentation

◆ compress()

std::unique_ptr< BaseCacheCompressor::CompressionData > MultiCompressor::compress ( const uint64_t *  cache_line,
Cycles comp_lat,
Cycles decomp_lat 
)
overridevirtual

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.

Parameters
cache_lineThe cache line to be compressed.
comp_latCompression latency in number of cycles.
decomp_latDecompression latency in number of cycles.
Returns
Cache line after compression.

Implements BaseCacheCompressor.

Definition at line 70 of file multi.cc.

References alignToPowerOfTwo(), BaseCacheCompressor::blkSize, compressors, DPRINTF, ArmISA::i, MipsISA::index, and rankStats.

◆ decompress()

void MultiCompressor::decompress ( const CompressionData comp_data,
uint64_t *  cache_line 
)
overridevirtual

Apply the decompression process to the compressed data.

Parameters
comp_dataCompressed cache line.
cache_lineThe cache line to be decompressed.

Implements BaseCacheCompressor.

Definition at line 149 of file multi.cc.

References MultiCompressor::MultiCompData::compData, compressors, and MultiCompressor::MultiCompData::getIndex().

◆ regStats()

void MultiCompressor::regStats ( )
overridevirtual

Callback to set stat parameters.

This callback is typically used for complex stats (e.g., distributions) that need parameters in addition to a name and a description. Stat names and descriptions should typically be set from the constructor usingo from the constructor using the ADD_STAT macro.

Reimplemented from Stats::Group.

Definition at line 159 of file multi.cc.

References compressors, Stats::Vector2dBase< Derived, Stor >::init(), MultiCompressor(), SimObject::name(), rankStats, Stats::Group::regStats(), Stats::DataWrapVec< Derived, InfoProxyType >::subdesc(), Stats::DataWrapVec< Derived, InfoProxyType >::subname(), sc_dt::to_string(), and Stats::DataWrapVec2d< Derived, InfoProxyType >::ysubname().

Member Data Documentation

◆ compressors

std::vector<BaseCacheCompressor*> MultiCompressor::compressors
protected

List of sub-compressors.

Definition at line 53 of file multi.hh.

Referenced by compress(), decompress(), MultiCompressor(), regStats(), and ~MultiCompressor().


The documentation for this class was generated from the following files:

Generated on Thu May 28 2020 16:21:48 for gem5 by doxygen 1.8.13