src/mem/ruby/filters/NonCountingBloomFilter.hh

   1 /*
   2  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
   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
  29 #ifndef __MEM_RUBY_FILTERS_NONCOUNTINGBLOOMFILTER_HH__
  30 #define __MEM_RUBY_FILTERS_NONCOUNTINGBLOOMFILTER_HH__
  31
  32 #include <iostream>
  33 #include <string>
  34 #include <vector>
  35
  36 #include "mem/ruby/common/Address.hh"
  37 #include "mem/ruby/common/Global.hh"
  38 #include "mem/ruby/filters/AbstractBloomFilter.hh"
  39
  40 class NonCountingBloomFilter : public AbstractBloomFilter
  41 {
  42   public:
  43     NonCountingBloomFilter(std::string config);
  44     ~NonCountingBloomFilter();
  45
  46     void clear();
  47     void increment(const Address& addr);
  48     void decrement(const Address& addr);
  49     void merge(AbstractBloomFilter * other_filter);
  50     void set(const Address& addr);
  51     void unset(const Address& addr);
  52
  53     bool isSet(const Address& addr);
  54     int getCount(const Address& addr);
  55     int getTotalCount();
  56
  57     int getIndex(const Address& addr);
  58     int readBit(const int index);
  59     void writeBit(const int index, const int value);
  60
  61     void print(std::ostream& out) const;
  62
  63     int
  64     operator[](const int index) const
  65     {
  66         return this->m_filter[index];
  67     }
  68
  69   private:
  70     int get_index(const Address& addr);
  71
  72     std::vector<int> m_filter;
  73     int m_filter_size;
  74     int m_offset;
  75     int m_filter_size_bits;
  76
  77     int m_count_bits;
  78     int m_count;
  79 };
  80
  81 #endif // __MEM_RUBY_FILTERS_NONCOUNTINGBLOOMFILTER_HH__