Simple deletable (with false negatives) bloom filter that extracts bitfields of an address to use as indexes of the filter vector. More...

#include <block_bloom_filter.hh>

Inheritance diagram for gem5::bloom_filter::Block:

Public Member Functions
	Block (const BloomFilterBlockParams &p)

	~Block ()

void	set (Addr addr) override
	Perform the filter specific function to set the corresponding entries (can be multiple) of an address.

void	unset (Addr addr) override
	Perform the filter specific function to clear the corresponding entries (can be multiple) of an address.

int	getCount (Addr addr) const override
	Get the value stored in the corresponding filter entry of an address.

Public Member Functions inherited from gem5::bloom_filter::Base
	Base (const BloomFilterBaseParams &p)
	Create and clear the filter.

virtual	~Base ()

virtual void	clear ()
	Clear the filter by resetting all values.

virtual void	merge (const Base *other)
	Merges the contents of both filters into this' (Bloom Filter union).

virtual bool	isSet (Addr addr) const
	Check if the corresponding filter entries of an address should be considered as set.

virtual int	getTotalCount () const
	Get the total value stored in the filter entries.

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

Private Member Functions
int	hash (Addr addr) const
	XOR hash between bitfields of an address, provided by the mask vector.

Private Attributes
std::vector< unsigned >	masksLSBs
	Position of the LSB of each mask.

std::vector< unsigned >	masksSizes
	Number of bits in each mask.

Additional Inherited Members
Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

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 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 Attributes inherited from gem5::bloom_filter::Base
const unsigned	offsetBits
	Number of LSB bits to ignore from the the addresses.

std::vector< SatCounter8 >	filter
	The filter itself.

const int	sizeBits
	Number of bits needed to represent the size of the filter.

const int	setThreshold
	Threshold at which a filter entry starts being considered as set.

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

Simple deletable (with false negatives) bloom filter that extracts bitfields of an address to use as indexes of the filter vector.

Definition at line 49 of file block_bloom_filter.hh.

Constructor & Destructor Documentation

◆ Block()

Block::Block ( const BloomFilterBlockParams & p )

Definition at line 42 of file block_bloom_filter.cc.

References gem5::bloom_filter::Base::Base(), fatal_if, gem5::ArmISA::i, masksLSBs, masksSizes, gem5::MipsISA::p, and gem5::bloom_filter::Base::sizeBits.

◆ ~Block()

Block::~Block ( )

Definition at line 61 of file block_bloom_filter.cc.

Member Function Documentation

◆ getCount()

int Block::getCount ( Addr addr ) const

overridevirtual

Get the value stored in the corresponding filter entry of an address.

Parameters

addr	The address being parsed.
Get	the value stored in the respective filter entry.

Reimplemented from gem5::bloom_filter::Base.

Definition at line 78 of file block_bloom_filter.cc.

References gem5::X86ISA::addr, gem5::bloom_filter::Base::filter, and hash().

◆ hash()

int Block::hash ( Addr addr ) const

private

XOR hash between bitfields of an address, provided by the mask vector.

Parameters

addr	The address to be hashed.

Returns: The value of the XOR of the masked bitfields of the address.

Definition at line 84 of file block_bloom_filter.cc.

References gem5::X86ISA::addr, gem5::bits(), gem5::bloom_filter::Base::filter, gem5::ArmISA::i, masksLSBs, masksSizes, and gem5::bloom_filter::Base::offsetBits.

Referenced by getCount(), set(), and unset().

◆ set()

void Block::set ( Addr addr )

overridevirtual

Perform the filter specific function to set the corresponding entries (can be multiple) of an address.

Parameters

addr	The address being parsed.

Implements gem5::bloom_filter::Base.

Definition at line 66 of file block_bloom_filter.cc.

References gem5::X86ISA::addr, gem5::bloom_filter::Base::filter, and hash().

◆ unset()

void Block::unset ( Addr addr )

overridevirtual

Perform the filter specific function to clear the corresponding entries (can be multiple) of an address.

By default a bloom filter does not support element deletion.

Parameters

addr	The address being parsed.

Reimplemented from gem5::bloom_filter::Base.

Definition at line 72 of file block_bloom_filter.cc.

References gem5::X86ISA::addr, gem5::bloom_filter::Base::filter, and hash().

Member Data Documentation

◆ masksLSBs

std::vector<unsigned> gem5::bloom_filter::Block::masksLSBs

private

Position of the LSB of each mask.

Definition at line 69 of file block_bloom_filter.hh.

Referenced by Block(), and hash().

◆ masksSizes

std::vector<unsigned> gem5::bloom_filter::Block::masksSizes

private

Number of bits in each mask.

Definition at line 72 of file block_bloom_filter.hh.

Referenced by Block(), and hash().

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

base/filters/block_bloom_filter.hh
base/filters/block_bloom_filter.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Block()

◆ ~Block()

Member Function Documentation

◆ getCount()

◆ hash()

◆ set()

◆ unset()

Member Data Documentation

◆ masksLSBs

◆ masksSizes