1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
/*
* Copyright (c) 2019 Inria
* Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
* 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_BASE_HH__
#define __BASE_FILTERS_BASE_HH__
#include <vector>
#include "base/intmath.hh"
#include "base/types.hh"
#include "params/BloomFilterBase.hh"
#include "sim/sim_object.hh"
namespace BloomFilter {
class Base : public SimObject
{
protected:
/** Number of LSB bits to ignore from the the addresses. */
const unsigned offsetBits;
/** The filter itself. */
std::vector<int> filter;
/** Number of bits needed to represent the size of the filter. */
const int sizeBits;
/** Threshold at which a filter entry starts being considered as set. */
const int setThreshold;
public:
/**
* Create and clear the filter.
*/
Base(const BloomFilterBaseParams* p)
: SimObject(p), offsetBits(p->offset_bits), filter(p->size),
sizeBits(floorLog2(p->size)), setThreshold(p->threshold)
{
clear();
}
virtual ~Base() {};
/**
* Clear the filter by resetting all values.
*/
virtual void clear()
{
for (auto& entry : filter) {
entry = 0;
}
}
/**
* Merges the contents of both filters into this' (Bloom Filter union).
* Both must have the same number of entries.
*
* @param other The other bloom filter to merge with.
*/
virtual void
merge(const Base* other)
{
assert(filter.size() == other->filter.size());
for (int i = 0; i < filter.size(); ++i){
filter[i] |= other->filter[i];
}
}
/**
* Perform the filter specific function to set the corresponding
* entries (can be multiple) of an address.
*
* @param addr The address being parsed.
*/
virtual void set(Addr addr) = 0;
/**
* 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.
*
* @param addr The address being parsed.
*/
virtual void unset(Addr addr) {};
/**
* Check if the corresponding filter entries of an address should be
* considered as set.
*
* @param addr The address being parsed.
* @return Whether the respective filter entry is set.
*/
virtual bool
isSet(Addr addr) const
{
return getCount(addr) >= setThreshold;
}
/**
* Get the value stored in the corresponding filter entry of an address.
*
* @param addr The address being parsed.
* @param Get the value stored in the respective filter entry.
*/
virtual int getCount(Addr addr) const { return 0; }
/**
* Get the total value stored in the filter entries.
*
* @return The sum of all filter entries.
*/
virtual int getTotalCount() const
{
int count = 0;
for (const auto& entry : filter) {
count += entry;
}
return count;
}
};
} // namespace BloomFilter
#endif // __BASE_FILTERS_BASE_HH__
|
