From 28c8fa04540837f25f7f8cf6d924c177176b8962 Mon Sep 17 00:00:00 2001 From: "Daniel R. Carvalho" Date: Sun, 12 May 2019 23:17:24 +0200 Subject: [PATCH] base: Add a perfect bloom filter Add a bloom filter that keeps track of all observed entries, and thus has no false negatives nor false positives. Change-Id: Iba784e617a99c77554c688470d9b9e12c260f23b Signed-off-by: Daniel R. Carvalho Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/18879 Tested-by: kokoro Reviewed-by: Nikos Nikoleris Maintainer: Nikos Nikoleris --- src/base/filters/BloomFilters.py | 8 +++ src/base/filters/SConscript | 1 + src/base/filters/perfect_bloom_filter.cc | 90 ++++++++++++++++++++++++ src/base/filters/perfect_bloom_filter.hh | 66 +++++++++++++++++ 4 files changed, 165 insertions(+) create mode 100644 src/base/filters/perfect_bloom_filter.cc create mode 100644 src/base/filters/perfect_bloom_filter.hh diff --git a/src/base/filters/BloomFilters.py b/src/base/filters/BloomFilters.py index b3460d747..09dda4f58 100644 --- a/src/base/filters/BloomFilters.py +++ b/src/base/filters/BloomFilters.py @@ -92,3 +92,11 @@ class BloomFilterMulti(BloomFilterBase): # By default match this with the number of sub-filters threshold = 2 + +class BloomFilterPerfect(BloomFilterBase): + type = 'BloomFilterPerfect' + cxx_class = 'BloomFilter::Perfect' + cxx_header = "base/filters/perfect_bloom_filter.hh" + + # The base filter is not needed. Use a dummy value. + size = 1 diff --git a/src/base/filters/SConscript b/src/base/filters/SConscript index 254531203..8c0ee84f2 100644 --- a/src/base/filters/SConscript +++ b/src/base/filters/SConscript @@ -39,3 +39,4 @@ Source('bulk_bloom_filter.cc') Source('h3_bloom_filter.cc') Source('multi_bit_sel_bloom_filter.cc') Source('multi_bloom_filter.cc') +Source('perfect_bloom_filter.cc') diff --git a/src/base/filters/perfect_bloom_filter.cc b/src/base/filters/perfect_bloom_filter.cc new file mode 100644 index 000000000..61a5a79b3 --- /dev/null +++ b/src/base/filters/perfect_bloom_filter.cc @@ -0,0 +1,90 @@ +/* + * Copyright (c) 2019 Inria + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer; + * redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution; + * neither the name of the copyright holders nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * Authors: Daniel Carvalho + */ + +#include "base/filters/perfect_bloom_filter.hh" + +#include "params/BloomFilterPerfect.hh" + +namespace BloomFilter { + +Perfect::Perfect(const BloomFilterPerfectParams* p) + : Base(p) +{ +} + +Perfect::~Perfect() +{ +} + +void +Perfect::clear() +{ + entries.clear(); +} + +void +Perfect::merge(const Base* other) +{ + auto* cast_other = static_cast(other); + entries.insert(cast_other->entries.begin(), cast_other->entries.end()); +} + +void +Perfect::set(Addr addr) +{ + entries.insert(addr); +} + +void +Perfect::unset(Addr addr) +{ + entries.erase(addr); +} + +int +Perfect::getCount(Addr addr) const +{ + return entries.find(addr) != entries.end(); +} + +int +Perfect::getTotalCount() const +{ + return entries.size(); +} + +} // namespace BloomFilter + +BloomFilter::Perfect* +BloomFilterPerfectParams::create() +{ + return new BloomFilter::Perfect(this); +} + diff --git a/src/base/filters/perfect_bloom_filter.hh b/src/base/filters/perfect_bloom_filter.hh new file mode 100644 index 000000000..92b4b396b --- /dev/null +++ b/src/base/filters/perfect_bloom_filter.hh @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2019 Inria + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer; + * redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution; + * neither the name of the copyright holders nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * Authors: Daniel Carvalho + */ + +#ifndef __BASE_FILTERS_PERFECT_BLOOM_FILTER_HH__ +#define __BASE_FILTERS_PERFECT_BLOOM_FILTER_HH__ + +#include + +#include "base/filters/base.hh" + +struct BloomFilterPerfectParams; + +namespace BloomFilter { + +/** + * A perfect bloom filter with no false positives nor false negatives. + */ +class Perfect : public Base +{ + public: + Perfect(const BloomFilterPerfectParams* p); + ~Perfect(); + + void clear() override; + void set(Addr addr) override; + void unset(Addr addr) override; + + void merge(const Base* other) override; + int getCount(Addr addr) const override; + int getTotalCount() const override; + + private: + /** Container storing all set (seen) entries. */ + std::unordered_set entries; +}; + +} // namespace BloomFilter + +#endif // __BASE_FILTERS_PERFECT_BLOOM_FILTER_HH__ -- 2.30.2