gem5  v22.0.0.1
Public Member Functions | Protected Attributes | List of all members
gem5::bloom_filter::Base Class Referenceabstract

#include <base.hh>

Inheritance diagram for gem5::bloom_filter::Base:
gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named gem5::bloom_filter::Block gem5::bloom_filter::Multi gem5::bloom_filter::MultiBitSel gem5::bloom_filter::Perfect gem5::bloom_filter::Bulk gem5::bloom_filter::H3

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

Protected Attributes

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

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

Detailed Description

Definition at line 49 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 68 of file base.hh.

References clear().

◆ ~Base()

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

Definition at line 75 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 80 of file base.hh.

References filter.

Referenced by Base().

◆ 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
addrThe address being parsed.
Getthe value stored in the respective filter entry.

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

Definition at line 138 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 145 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
addrThe address being parsed.
Returns
Whether the respective filter entry is set.

Reimplemented in gem5::bloom_filter::Multi.

Definition at line 127 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
otherThe other bloom filter to merge with.

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

Definition at line 94 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
addrThe address being parsed.

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

◆ 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
addrThe address being parsed.

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

Definition at line 117 of file base.hh.

Member Data Documentation

◆ filter

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

◆ offsetBits

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

◆ setThreshold

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

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

Definition at line 62 of file base.hh.

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

◆ sizeBits

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

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

Definition at line 59 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:

Generated on Sat Jun 18 2022 08:13:38 for gem5 by doxygen 1.8.17