gem5::bloom_filter::Perfect Class Reference

A perfect bloom filter with no false positives nor false negatives. More...

#include <perfect_bloom_filter.hh>

Inheritance diagram for gem5::bloom_filter::Perfect:

Public Member Functions
	Perfect (const BloomFilterPerfectParams &p)
	~Perfect ()
void	clear () override
	Clear the filter by resetting all values.
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.
void	merge (const Base *other) override
	Merges the contents of both filters into this' (Bloom Filter union).
int	getCount (Addr addr) const override
	Get the value stored in the corresponding filter entry of an address.
int	getTotalCount () const override
	Get the total value stored in the filter entries.
Public Member Functions inherited from gem5::bloom_filter::Base
	Base (const BloomFilterBaseParams &p)
	Create and clear the filter.
virtual	~Base ()
virtual bool	isSet (Addr addr) const
	Check if the corresponding filter entries of an address should be considered as set.
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 Attributes
std::unordered_set< Addr >	entries
	Container storing all set (seen) entries.

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

A perfect bloom filter with no false positives nor false negatives.

Definition at line 47 of file perfect_bloom_filter.hh.

Constructor & Destructor Documentation

Perfect()

gem5::bloom_filter::Perfect::Perfect

(

const BloomFilterPerfectParams &

p

)

Definition at line 40 of file perfect_bloom_filter.cc.

References fatal_if, and gem5::MipsISA::p.

~Perfect()

gem5::bloom_filter::Perfect::~Perfect

(

)

Definition at line 51 of file perfect_bloom_filter.cc.

Member Function Documentation

clear()

void gem5::bloom_filter::Perfect::clear ( )

overridevirtual

Clear the filter by resetting all values.

Reimplemented from gem5::bloom_filter::Base.

Definition at line 56 of file perfect_bloom_filter.cc.

References entries.

getCount()

int gem5::bloom_filter::Perfect::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 81 of file perfect_bloom_filter.cc.

References gem5::X86ISA::addr, entries, and gem5::SimObject::find().

getTotalCount()

int gem5::bloom_filter::Perfect::getTotalCount ( ) const

overridevirtual

Get the total value stored in the filter entries.

Returns

The sum of all filter entries.

Reimplemented from gem5::bloom_filter::Base.

Definition at line 87 of file perfect_bloom_filter.cc.

References entries.

merge()

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

overridevirtual

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 from gem5::bloom_filter::Base.

Definition at line 62 of file perfect_bloom_filter.cc.

References entries.

set()

void gem5::bloom_filter::Perfect::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 69 of file perfect_bloom_filter.cc.

References gem5::X86ISA::addr, and entries.

unset()

void gem5::bloom_filter::Perfect::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 75 of file perfect_bloom_filter.cc.

References gem5::X86ISA::addr, and entries.

Member Data Documentation

entries

std::unordered_set<Addr> gem5::bloom_filter::Perfect::entries

private

Container storing all set (seen) entries.

Definition at line 63 of file perfect_bloom_filter.hh.

Referenced by clear(), getCount(), getTotalCount(), merge(), set(), and unset().

---

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

• base/filters/perfect_bloom_filter.hh
• base/filters/perfect_bloom_filter.cc