#include <cpack.hh>

Inheritance diagram for Compressor::CPack:

Classes
class	PatternMMMM

class	PatternMMMX

class	PatternMMXX

class	PatternXXXX

class	PatternZZZX

class	PatternZZZZ

Public Types
typedef CPackParams	Params
	Convenience typedef. More...

Public Types inherited from Compressor::DictionaryCompressor< uint32_t >
typedef BaseDictionaryCompressorParams	Params

Public Types inherited from Compressor::BaseDictionaryCompressor
typedef BaseDictionaryCompressorParams	Params

Public Types inherited from Compressor::Base
typedef BaseCacheCompressorParams	Params

Public Types inherited from SimObject
typedef SimObjectParams	Params

Public Member Functions
	CPack (const Params *p)
	Default constructor. More...

	~CPack ()
	Default destructor. More...

Public Member Functions inherited from Compressor::DictionaryCompressor< uint32_t >
	DictionaryCompressor (const Params *p)

	~DictionaryCompressor ()=default

Public Member Functions inherited from Compressor::BaseDictionaryCompressor
	BaseDictionaryCompressor (const Params *p)

	~BaseDictionaryCompressor ()=default

Public Member Functions inherited from Compressor::Base
	Base (const Params *p)

virtual	~Base ()=default

std::unique_ptr< CompressionData >	compress (const uint64_t *data, Cycles &comp_lat, Cycles &decomp_lat)
	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
const Params *	params () const

	SimObject (const Params *_params)

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...

ProbeManager *	getProbeManager ()
	Get the probe manager for this object. More...

virtual Port &	getPort (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...

Public Member Functions inherited from 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. More...

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue. More...

	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	regStats ()
	Callback to set stat parameters. More...

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 Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group. More...

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Private Types
enum	PatternNumber { ZZZZ, XXXX, MMMM, MMXX, ZZZX, MMMX, NUM_PATTERNS }
	The patterns proposed in the paper. More...

using	DictionaryEntry = DictionaryCompressor< uint32_t >::DictionaryEntry

using	PatternFactory = Factory< PatternZZZZ, PatternMMMM, PatternZZZX, PatternMMMX, PatternMMXX, PatternXXXX >
	Convenience factory declaration. More...

Private Member Functions
uint64_t	getNumPatterns () const override
	Trick function to get the number of patterns. More...

std::string	getName (int number) const override
	Get meta-name assigned to the given pattern. More...

std::unique_ptr< Pattern >	getPattern (const DictionaryEntry &bytes, const DictionaryEntry &dict_bytes, const int match_location) const override

void	addToDictionary (DictionaryEntry data) override

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. More...

Additional Inherited Members
Static Public Member Functions inherited from Compressor::Base
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 SimObject *	find (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)
	Serializes all the SimObjects. More...

static void	unserializeGlobals (CheckpointIn &cp)

Protected Types inherited from Compressor::DictionaryCompressor< uint32_t >
typedef std::array< uint8_t, sizeof(uint32_t)>	DictionaryEntry
	Convenience typedef for a dictionary entry. More...

Protected Types inherited from Compressor::Base
typedef uint64_t	Chunk
	A chunk is a basic lexical unit. More...

Protected Member Functions inherited from Compressor::DictionaryCompressor< uint32_t >
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. More...

std::unique_ptr< Pattern >	compressValue (const uint32_t data)
	Compress data. More...

uint32_t	decompressValue (const Pattern *pattern)
	Decompress a pattern into a value that fits in a dictionary entry. More...

virtual void	resetDictionary ()
	Clear all dictionary entries. More...

virtual void	addToDictionary (const DictionaryEntry data)=0
	Add an entry to the dictionary. More...

virtual std::unique_ptr< DictionaryCompressor::CompData >	instantiateDictionaryCompData () const
	Instantiate a compression data of the sub-class compressor. More...

std::unique_ptr< Base::CompressionData >	compress (const std::vector< Chunk > &chunks)
	Apply compression. More...

void	decompress (const CompressionData comp_data, uint64_t data) override
	Decompress data. More...

Protected Member Functions inherited from Compressor::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. More...

void	fromChunks (const std::vector< Chunk > &chunks, uint64_t *data) const
	This function re-joins the chunks to recreate the original data. More...

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...

Static Protected Member Functions inherited from Compressor::DictionaryCompressor< uint32_t >
static DictionaryEntry	toDictionaryEntry (uint32_t value)
	Turn a value into a dictionary entry. More...

static uint32_t	fromDictionaryEntry (const DictionaryEntry &entry)
	Turn a dictionary entry into a value. More...

Protected Attributes inherited from Compressor::DictionaryCompressor< uint32_t >
std::vector< DictionaryEntry >	dictionary
	The dictionary. More...

Protected Attributes inherited from Compressor::BaseDictionaryCompressor
const std::size_t	dictionarySize
	Dictionary size. More...

std::size_t	numEntries
	Number of valid entries in the dictionary. More...

Compressor::BaseDictionaryCompressor::DictionaryStats	dictionaryStats

Protected Attributes inherited from Compressor::Base
const std::size_t	blkSize
	Uncompressed cache line size (in bytes). More...

const unsigned	chunkSizeBits
	Chunk size, in number of bits. 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...

Compressor::Base::BaseStats	stats

Protected Attributes inherited from SimObject
const SimObjectParams *	_params
	Cached copy of the object parameters. More...

Protected Attributes inherited from EventManager
EventQueue *	eventq
	A pointer to this object's event queue. More...

Detailed Description

Definition at line 48 of file cpack.hh.

Member Typedef Documentation

◆ DictionaryEntry

using Compressor::CPack::DictionaryEntry = DictionaryCompressor<uint32_t>::DictionaryEntry

private

Definition at line 51 of file cpack.hh.

◆ Params

typedef CPackParams Compressor::CPack::Params

Convenience typedef.

Definition at line 107 of file cpack.hh.

◆ PatternFactory

using Compressor::CPack::PatternFactory = Factory<PatternZZZZ, PatternMMMM, PatternZZZX, PatternMMMX, PatternMMXX, PatternXXXX>

private

Convenience factory declaration.

The templates must be organized by size, with the smallest first, and "no-match" last.

Definition at line 76 of file cpack.hh.

Member Enumeration Documentation

◆ PatternNumber

enum Compressor::CPack::PatternNumber

private

The patterns proposed in the paper.

Each letter represents a byte: Z is a null byte, M is a dictionary match, X is a new value. These are used as indexes to reference the pattern data. If a new pattern is added, it must be done before NUM_PATTERNS.

Enumerator
ZZZZ
XXXX
MMMM
MMXX
ZZZX
MMMX
NUM_PATTERNS

Definition at line 67 of file cpack.hh.

Constructor & Destructor Documentation

◆ CPack()

Compressor::CPack::CPack ( const Params * p )

Default constructor.

Definition at line 40 of file cpack.cc.

◆ ~CPack()

Compressor::CPack::~CPack ( )

inline

Default destructor.

Definition at line 117 of file cpack.hh.

Member Function Documentation

◆ addToDictionary()

void Compressor::CPack::addToDictionary ( DictionaryEntry data )

overrideprivate

Definition at line 46 of file cpack.cc.

References data, Compressor::DictionaryCompressor< uint32_t >::dictionary, Compressor::BaseDictionaryCompressor::dictionarySize, and Compressor::BaseDictionaryCompressor::numEntries.

◆ compress()

std::unique_ptr< Base::CompressionData > Compressor::CPack::compress	(	const std::vector< Base::Chunk > &	chunks,
		Cycles &	comp_lat,
		Cycles &	decomp_lat
	)

overrideprivatevirtual

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

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.

Returns: Cache line after compression.

Implements Compressor::Base.

Definition at line 53 of file cpack.cc.

References Compressor::Base::blkSize, and Compressor::DictionaryCompressor< T >::compress().

◆ getName()

std::string Compressor::CPack::getName ( int number ) const

inlineoverrideprivatevirtual

Get meta-name assigned to the given pattern.

Parameters

number The number of the pattern.

Returns: The meta-name of the pattern.

Implements Compressor::BaseDictionaryCompressor.

Definition at line 81 of file cpack.hh.

References MMMM, MMMX, MMXX, XXXX, ZZZX, and ZZZZ.

◆ getNumPatterns()

uint64_t Compressor::CPack::getNumPatterns ( ) const

inlineoverrideprivatevirtual

Trick function to get the number of patterns.

Returns: The number of defined patterns.

Implements Compressor::BaseDictionaryCompressor.

Definition at line 78 of file cpack.hh.

References NUM_PATTERNS.

◆ getPattern()

std::unique_ptr<Pattern> Compressor::CPack::getPattern	(	const DictionaryEntry &	bytes,
		const DictionaryEntry &	dict_bytes,
		const int	match_location
	)		const

inlineoverrideprivate

Definition at line 91 of file cpack.hh.

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

mem/cache/compressors/cpack.hh
mem/cache/compressors/cpack.cc

Classes

Public Types

Public Member Functions

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DictionaryEntry

◆ Params

◆ PatternFactory

Member Enumeration Documentation

◆ PatternNumber

Constructor & Destructor Documentation

◆ CPack()

◆ ~CPack()

Member Function Documentation

◆ addToDictionary()

◆ compress()

◆ getName()

◆ getNumPatterns()

◆ getPattern()