#include <fpc.hh>

Inheritance diagram for gem5::compression::FPC:

Classes
class	FPCCompData

class	RepBytes

class	SignExtended1Byte

class	SignExtended4Bits

class	SignExtendedHalfword

class	SignExtendedTwoHalfwords

class	Uncompressed

class	ZeroPaddedHalfword

class	ZeroRun

Public Types
typedef FPCParams	Params

Public Types inherited from gem5::compression::DictionaryCompressor< uint32_t >
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 Member Functions
	FPC (const Params &p)

	~FPC ()=default

Public Member Functions inherited from gem5::compression::DictionaryCompressor< uint32_t >
	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 (const std::string &name_)

virtual	~Named ()=default

virtual std::string	name () const

Private Types
enum	PatternNumber { ZERO_RUN , SIGN_EXTENDED_4_BITS , SIGN_EXTENDED_1_BYTE , SIGN_EXTENDED_HALFWORD , ZERO_PADDED_HALFWORD , SIGN_EXTENDED_TWO_HALFWORDS , REP_BYTES , UNCOMPRESSED , NUM_PATTERNS }
	The possible patterns. More...

using	DictionaryEntry = DictionaryCompressor<uint32_t>::DictionaryEntry

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

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

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

void	addToDictionary (const DictionaryEntry data) override

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

Private Attributes
const int	zeroRunSizeBits
	Number of bits of the zero run size bitfield.

Additional Inherited Members
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 inherited from gem5::compression::DictionaryCompressor< uint32_t >
typedef std::array< uint8_t, sizeof(uint32_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 Member Functions inherited from gem5::compression::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.

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

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

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

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

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

Protected Attributes inherited from gem5::compression::DictionaryCompressor< uint32_t >
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.

Detailed Description

Definition at line 57 of file fpc.hh.

Member Typedef Documentation

◆ DictionaryEntry

using gem5::compression::FPC::DictionaryEntry = DictionaryCompressor<uint32_t>::DictionaryEntry

private

Definition at line 60 of file fpc.hh.

◆ Params

typedef FPCParams gem5::compression::FPC::Params

Definition at line 132 of file fpc.hh.

Member Enumeration Documentation

◆ PatternNumber

enum gem5::compression::FPC::PatternNumber

private

The possible patterns.

If a new pattern is added, it must be done before NUM_PATTERNS.

Enumerator
ZERO_RUN
SIGN_EXTENDED_4_BITS
SIGN_EXTENDED_1_BYTE
SIGN_EXTENDED_HALFWORD
ZERO_PADDED_HALFWORD
SIGN_EXTENDED_TWO_HALFWORDS
REP_BYTES
UNCOMPRESSED
NUM_PATTERNS

Definition at line 82 of file fpc.hh.

Constructor & Destructor Documentation

◆ FPC()

gem5::compression::FPC::FPC ( const Params & p )

Definition at line 80 of file fpc.cc.

◆ ~FPC()

gem5::compression::FPC::~FPC ( )

default

Member Function Documentation

◆ addToDictionary()

void gem5::compression::FPC::addToDictionary ( const DictionaryEntry data )

overrideprivate

Definition at line 86 of file fpc.cc.

◆ getName()

std::string gem5::compression::FPC::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 gem5::compression::BaseDictionaryCompressor.

Definition at line 99 of file fpc.hh.

References REP_BYTES, SIGN_EXTENDED_1_BYTE, SIGN_EXTENDED_4_BITS, SIGN_EXTENDED_HALFWORD, SIGN_EXTENDED_TWO_HALFWORDS, UNCOMPRESSED, ZERO_PADDED_HALFWORD, and ZERO_RUN.

◆ getNumPatterns()

uint64_t gem5::compression::FPC::getNumPatterns ( ) const

inlineoverrideprivatevirtual

Trick function to get the number of patterns.

Returns: The number of defined patterns.

Implements gem5::compression::BaseDictionaryCompressor.

Definition at line 96 of file fpc.hh.

References NUM_PATTERNS.

◆ getPattern()

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

inlineoverrideprivate

Definition at line 115 of file fpc.hh.

◆ instantiateDictionaryCompData()

std::unique_ptr< DictionaryCompressor< uint32_t >::CompData > gem5::compression::FPC::instantiateDictionaryCompData ( ) const

overrideprivatevirtual

Instantiate a compression data of the sub-class compressor.

Returns: The new compression data entry.

Reimplemented from gem5::compression::DictionaryCompressor< uint32_t >.

Definition at line 95 of file fpc.cc.

References zeroRunSizeBits.

Member Data Documentation

◆ zeroRunSizeBits

const int gem5::compression::FPC::zeroRunSizeBits

private

Number of bits of the zero run size bitfield.

If the size of the zero run reaches the maximum value, it is split into ZERO_RUN entries.

Definition at line 94 of file fpc.hh.

Referenced by gem5::compression::FPC::FPCCompData::addEntry(), and instantiateDictionaryCompData().

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

mem/cache/compressors/fpc.hh
mem/cache/compressors/fpc.cc

Classes

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DictionaryEntry

◆ Params

Member Enumeration Documentation

◆ PatternNumber

Constructor & Destructor Documentation

◆ FPC()

◆ ~FPC()

Member Function Documentation

◆ addToDictionary()

◆ getName()

◆ getNumPatterns()

◆ getPattern()

◆ instantiateDictionaryCompData()

Member Data Documentation

◆ zeroRunSizeBits