#include <base.hh>

Inheritance diagram for gem5::bloom_filter::Base:

Public Member Functions
	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 void	set (Addr addr)=0
	Perform the filter specific function to set the corresponding entries (can be multiple) of an address.

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

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

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

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 (const std::string &name_)

virtual	~Named ()=default

virtual std::string	name () const

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

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.

Detailed Description

Definition at line 48 of file base.hh.

Constructor & Destructor Documentation

◆ Base()

gem5::bloom_filter::Base::Base ( const BloomFilterBaseParams & p )

inline

Create and clear the filter.

Definition at line 67 of file base.hh.

References clear().

◆ ~Base()

virtual gem5::bloom_filter::Base::~Base ( )

inlinevirtual

Definition at line 74 of file base.hh.

Member Function Documentation

◆ clear()

virtual void gem5::bloom_filter::Base::clear ( )

inlinevirtual

Clear the filter by resetting all values.

Reimplemented in gem5::bloom_filter::Multi, and gem5::bloom_filter::Perfect.

Definition at line 79 of file base.hh.

References filter.

Referenced by Base(), and gem5::bloom_filter::Multi::clear().

◆ getCount()

virtual int gem5::bloom_filter::Base::getCount ( Addr addr ) const

inlinevirtual

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 in gem5::bloom_filter::Block, gem5::bloom_filter::Multi, gem5::bloom_filter::MultiBitSel, and gem5::bloom_filter::Perfect.

Definition at line 137 of file base.hh.

Referenced by isSet().

◆ getTotalCount()

virtual int gem5::bloom_filter::Base::getTotalCount ( ) const

inlinevirtual

Get the total value stored in the filter entries.

Returns: The sum of all filter entries.

Reimplemented in gem5::bloom_filter::Multi, and gem5::bloom_filter::Perfect.

Definition at line 144 of file base.hh.

References gem5::X86ISA::count, and filter.

◆ isSet()

virtual bool gem5::bloom_filter::Base::isSet ( Addr addr ) const

inlinevirtual

Check if the corresponding filter entries of an address should be considered as set.

Parameters

addr	The address being parsed.

Returns: Whether the respective filter entry is set.

Reimplemented in gem5::bloom_filter::Multi.

Definition at line 126 of file base.hh.

References gem5::X86ISA::addr, getCount(), and setThreshold.

◆ merge()

virtual void gem5::bloom_filter::Base::merge ( const Base * other )

inlinevirtual

Merges the contents of both filters into this' (Bloom Filter union).

Both must have the same number of entries.

Parameters

other The other bloom filter to merge with.

Reimplemented in gem5::bloom_filter::Multi, and gem5::bloom_filter::Perfect.

Definition at line 93 of file base.hh.

References filter, and gem5::ArmISA::i.

◆ set()

virtual void gem5::bloom_filter::Base::set ( Addr addr )

pure virtual

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

Parameters

addr	The address being parsed.

Implemented in gem5::bloom_filter::Block, gem5::bloom_filter::Multi, gem5::bloom_filter::MultiBitSel, and gem5::bloom_filter::Perfect.

◆ unset()

virtual void gem5::bloom_filter::Base::unset ( Addr addr )

inlinevirtual

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 in gem5::bloom_filter::Block, gem5::bloom_filter::Multi, and gem5::bloom_filter::Perfect.

Definition at line 116 of file base.hh.

Member Data Documentation

◆ filter

std::vector<SatCounter8> gem5::bloom_filter::Base::filter

protected

The filter itself.

Definition at line 55 of file base.hh.

Referenced by clear(), gem5::bloom_filter::Block::getCount(), gem5::bloom_filter::MultiBitSel::getCount(), getTotalCount(), gem5::bloom_filter::Block::hash(), gem5::bloom_filter::Bulk::hash(), gem5::bloom_filter::H3::hash(), gem5::bloom_filter::MultiBitSel::hash(), merge(), gem5::bloom_filter::Block::set(), gem5::bloom_filter::MultiBitSel::set(), and gem5::bloom_filter::Block::unset().

◆ offsetBits

const unsigned gem5::bloom_filter::Base::offsetBits

protected

Number of LSB bits to ignore from the the addresses.

Definition at line 52 of file base.hh.

Referenced by gem5::bloom_filter::Bulk::Bulk(), gem5::bloom_filter::Block::hash(), gem5::bloom_filter::Bulk::hash(), gem5::bloom_filter::H3::hash(), gem5::bloom_filter::MultiBitSel::hash(), and gem5::bloom_filter::Bulk::permute().

◆ setThreshold

const int gem5::bloom_filter::Base::setThreshold

protected

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

Definition at line 61 of file base.hh.

Referenced by isSet(), and gem5::bloom_filter::Multi::isSet().

◆ sizeBits

const int gem5::bloom_filter::Base::sizeBits

protected

Number of bits needed to represent the size of the filter.

Definition at line 58 of file base.hh.

Referenced by gem5::bloom_filter::Block::Block(), and gem5::bloom_filter::MultiBitSel::hash().

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

base/filters/base.hh

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Base()

◆ ~Base()

Member Function Documentation

◆ clear()

◆ getCount()

◆ getTotalCount()

◆ isSet()

◆ merge()

◆ set()

◆ unset()

Member Data Documentation

◆ filter

◆ offsetBits

◆ setThreshold

◆ sizeBits