1/*
2 * Copyright (c) 2019 Inria
3 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * Authors: Daniel Carvalho
30 */
31
32#ifndef __BASE_FILTERS_BULK_BLOOM_FILTER_HH__
33#define __BASE_FILTERS_BULK_BLOOM_FILTER_HH__
34
35#include "base/filters/multi_bit_sel_bloom_filter.hh"
36
37struct BloomFilterBulkParams;
38
39namespace BloomFilter {
40
41/**
42 * Implementation of the bloom filter, as described in "Bulk Disambiguation of
43 * Speculative Threads in Multiprocessors", by Ceze, Luis, et al.
44 * The number of hashes indicates the number of c bitfields.
45 */
46class Bulk : public MultiBitSel
47{
48  public:
49    Bulk(const BloomFilterBulkParams* p);
50    ~Bulk();
51
52  protected:
53    int hash(Addr addr, int hash_number) const override;
54
55  private:
56    /** Permutes the address to generate its signature. */
57    Addr permute(Addr addr) const;
58
59    /**
60     * Number of bits used per sector. The filter is split into sectors,
61     * each of which with its own hash function. When an address is hashed
62     * all sectors are parsed to generate c indexes. These indexes are then
63     * used to find the respective v indexes in the main filter.
64     */
65    const int sectorBits;
66};
67
68} // namespace BloomFilter
69
70#endif // __BASE_FILTERS_BULK_BLOOM_FILTER_HH__
71