gem5  v22.1.0.0
perfect_bloom_filter.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019 Inria
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met: redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer;
9  * redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution;
12  * neither the name of the copyright holders nor the names of its
13  * contributors may be used to endorse or promote products derived from
14  * this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
30 
31 #include "base/logging.hh"
32 #include "params/BloomFilterPerfect.hh"
33 
34 namespace gem5
35 {
36 
37 GEM5_DEPRECATED_NAMESPACE(BloomFilter, bloom_filter);
38 namespace bloom_filter
39 {
40 
41 Perfect::Perfect(const BloomFilterPerfectParams &p)
42  : Base(p)
43 {
44  fatal_if(p.size != 1, "The perfect Bloom filter cannot be limited to a "
45  "specific size.");
46  fatal_if(p.num_bits != 1, "The perfect Bloom filter tracks entries "
47  "perfectly using an unlimited amount of 1-bit entries.");
48  fatal_if(p.threshold != 1, "The perfect Bloom filter uses 1-bit entries; "
49  "thus, their thresholds must be 1.");
50 }
51 
53 {
54 }
55 
56 void
58 {
59  entries.clear();
60 }
61 
62 void
63 Perfect::merge(const Base* other)
64 {
65  auto* cast_other = static_cast<const Perfect*>(other);
66  entries.insert(cast_other->entries.begin(), cast_other->entries.end());
67 }
68 
69 void
71 {
72  entries.insert(addr);
73 }
74 
75 void
77 {
78  entries.erase(addr);
79 }
80 
81 int
83 {
84  return entries.find(addr) != entries.end();
85 }
86 
87 int
89 {
90  return entries.size();
91 }
92 
93 } // namespace bloom_filter
94 } // namespace gem5
A perfect bloom filter with no false positives nor false negatives.
void unset(Addr addr) override
Perform the filter specific function to clear the corresponding entries (can be multiple) of an addre...
Perfect(const BloomFilterPerfectParams &p)
void clear() override
Clear the filter by resetting all values.
void merge(const Base *other) override
Merges the contents of both filters into this' (Bloom Filter union).
std::unordered_set< Addr > entries
Container storing all set (seen) entries.
int getTotalCount() const override
Get the total value stored in the filter entries.
void set(Addr addr) override
Perform the filter specific function to set the corresponding entries (can be multiple) of an address...
int getCount(Addr addr) const override
Get the value stored in the corresponding filter entry of an address.
#define fatal_if(cond,...)
Conditional fatal macro that checks the supplied condition and only causes a fatal error if the condi...
Definition: logging.hh:226
Bitfield< 54 > p
Definition: pagetable.hh:70
Bitfield< 3 > addr
Definition: types.hh:84
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
GEM5_DEPRECATED_NAMESPACE(GuestABI, guest_abi)

Generated on Wed Dec 21 2022 10:22:28 for gem5 by doxygen 1.9.1