gem5  v21.2.0.0
Public Member Functions | Private Attributes | List of all members
gem5::bloom_filter::Multi Class Reference

This BloomFilter has multiple sub-filters, each with its own hashing functionality. More...

#include <multi_bloom_filter.hh>

Inheritance diagram for gem5::bloom_filter::Multi:
gem5::bloom_filter::Base gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Member Functions

 Multi (const BloomFilterMultiParams &p)
 
 ~Multi ()
 
void clear () override
 Clear the filter by resetting all values. More...
 
void set (Addr addr) override
 Perform the filter specific function to set the corresponding entries (can be multiple) of an address. More...
 
void unset (Addr addr) override
 Perform the filter specific function to clear the corresponding entries (can be multiple) of an address. More...
 
void merge (const Base *other) override
 Merges the contents of both filters into this' (Bloom Filter union). More...
 
bool isSet (Addr addr) const override
 Check if the corresponding filter entries of an address should be considered as set. More...
 
int getCount (Addr addr) const override
 Get the value stored in the corresponding filter entry of an address. More...
 
int getTotalCount () const override
 Get the total value stored in the filter entries. More...
 
- Public Member Functions inherited from gem5::bloom_filter::Base
 Base (const BloomFilterBaseParams &p)
 Create and clear the filter. More...
 
virtual ~Base ()
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () 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. 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...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual PortgetPort (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 gem5::EventManager
EventQueueeventQueue () 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 gem5::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 gem5::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 gem5::statistics::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 (statistics::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 InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (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::vector< Base * > filters
 Sub-filters used by this filter. More...
 

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. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 
- Protected Member Functions inherited from gem5::Drainable
 Drainable ()
 
virtual ~Drainable ()
 
virtual void drainResume ()
 Resume execution after a successful drain. More...
 
void signalDrainDone () const
 Signal that an object is drained. More...
 
- Protected Attributes inherited from gem5::bloom_filter::Base
const unsigned offsetBits
 Number of LSB bits to ignore from the the addresses. More...
 
std::vector< SatCounter8filter
 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 gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Detailed Description

This BloomFilter has multiple sub-filters, each with its own hashing functionality.

The results of the operations are the results of applying them to each sub-filter.

Definition at line 51 of file multi_bloom_filter.hh.

Constructor & Destructor Documentation

◆ Multi()

gem5::bloom_filter::Multi::Multi ( const BloomFilterMultiParams &  p)

Definition at line 42 of file multi_bloom_filter.cc.

◆ ~Multi()

gem5::bloom_filter::Multi::~Multi ( )

Definition at line 47 of file multi_bloom_filter.cc.

Member Function Documentation

◆ clear()

void gem5::bloom_filter::Multi::clear ( )
overridevirtual

Clear the filter by resetting all values.

Reimplemented from gem5::bloom_filter::Base.

Definition at line 52 of file multi_bloom_filter.cc.

References filters.

◆ getCount()

int gem5::bloom_filter::Multi::getCount ( Addr  addr) const
overridevirtual

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

Parameters
addrThe address being parsed.
Getthe value stored in the respective filter entry.

Reimplemented from gem5::bloom_filter::Base.

Definition at line 98 of file multi_bloom_filter.cc.

References gem5::X86ISA::addr, gem5::X86ISA::count, and filters.

◆ getTotalCount()

int gem5::bloom_filter::Multi::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 108 of file multi_bloom_filter.cc.

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

◆ isSet()

bool gem5::bloom_filter::Multi::isSet ( Addr  addr) const
overridevirtual

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

Parameters
addrThe address being parsed.
Returns
Whether the respective filter entry is set.

Reimplemented from gem5::bloom_filter::Base.

Definition at line 86 of file multi_bloom_filter.cc.

References gem5::X86ISA::addr, gem5::X86ISA::count, filters, and gem5::bloom_filter::Base::setThreshold.

◆ merge()

void gem5::bloom_filter::Multi::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
otherThe other bloom filter to merge with.

Reimplemented from gem5::bloom_filter::Base.

Definition at line 60 of file multi_bloom_filter.cc.

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

◆ set()

void gem5::bloom_filter::Multi::set ( Addr  addr)
overridevirtual

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

Parameters
addrThe address being parsed.

Implements gem5::bloom_filter::Base.

Definition at line 70 of file multi_bloom_filter.cc.

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

◆ unset()

void gem5::bloom_filter::Multi::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
addrThe address being parsed.

Reimplemented from gem5::bloom_filter::Base.

Definition at line 78 of file multi_bloom_filter.cc.

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

Member Data Documentation

◆ filters

std::vector<Base*> gem5::bloom_filter::Multi::filters
private

Sub-filters used by this filter.

Definition at line 68 of file multi_bloom_filter.hh.

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


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

Generated on Tue Dec 21 2021 11:35:24 for gem5 by doxygen 1.8.17