#include <base.hh>

Inheritance diagram for BloomFilter::Base:

Public Member Functions
	Base (const BloomFilterBaseParams *p)
	Create and clear the filter. More...

virtual	~Base ()

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

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

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

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

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

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

virtual int	getTotalCount () const
	Get the total value stored in the filter entries. 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

Protected Attributes
const unsigned	offsetBits
	Number of LSB bits to ignore from the the addresses. More...

std::vector< SatCounter >	filter
	The filter itself. More...

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

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

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

Additional Inherited Members
Public Types inherited from SimObject
typedef SimObjectParams	Params

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 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 43 of file base.hh.

Constructor & Destructor Documentation

◆ Base()

BloomFilter::Base::Base ( const BloomFilterBaseParams * p )

inline

Create and clear the filter.

Definition at line 62 of file base.hh.

References clear().

◆ ~Base()

virtual BloomFilter::Base::~Base ( )

inlinevirtual

Definition at line 69 of file base.hh.

Member Function Documentation

◆ clear()

virtual void BloomFilter::Base::clear ( )

inlinevirtual

Clear the filter by resetting all values.

Reimplemented in BloomFilter::Multi, and BloomFilter::Perfect.

Definition at line 74 of file base.hh.

References filter.

Referenced by Base().

◆ getCount()

virtual int BloomFilter::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 BloomFilter::Multi, BloomFilter::Perfect, BloomFilter::Block, and BloomFilter::MultiBitSel.

Definition at line 132 of file base.hh.

Referenced by isSet().

◆ getTotalCount()

virtual int BloomFilter::Base::getTotalCount ( ) const

inlinevirtual

Get the total value stored in the filter entries.

Returns: The sum of all filter entries.

Reimplemented in BloomFilter::Multi, and BloomFilter::Perfect.

Definition at line 139 of file base.hh.

References X86ISA::count, and filter.

◆ isSet()

virtual bool BloomFilter::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 BloomFilter::Multi.

Definition at line 121 of file base.hh.

References addr, getCount(), and setThreshold.

◆ merge()

virtual void BloomFilter::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 BloomFilter::Multi, and BloomFilter::Perfect.

Definition at line 88 of file base.hh.

References filter, and ArmISA::i.

◆ set()

virtual void BloomFilter::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 BloomFilter::Multi, BloomFilter::Block, BloomFilter::Perfect, and BloomFilter::MultiBitSel.

◆ unset()

virtual void BloomFilter::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 BloomFilter::Multi, BloomFilter::Block, and BloomFilter::Perfect.

Definition at line 111 of file base.hh.

Member Data Documentation

◆ filter

std::vector<SatCounter> BloomFilter::Base::filter

protected

The filter itself.

Definition at line 50 of file base.hh.

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

◆ offsetBits

const unsigned BloomFilter::Base::offsetBits

protected

Number of LSB bits to ignore from the the addresses.

Definition at line 47 of file base.hh.

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

◆ setThreshold

const int BloomFilter::Base::setThreshold

protected

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

Definition at line 56 of file base.hh.

Referenced by BloomFilter::Multi::isSet(), and isSet().

◆ sizeBits

const int BloomFilter::Base::sizeBits

protected

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

Definition at line 53 of file base.hh.

Referenced by BloomFilter::Block::Block(), and BloomFilter::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