src/mem/ruby/filters/GenericBloomFilter.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_GENERICBLOOMFILTER_HH__
  30 #define __MEM_RUBY_FILTERS_GENERICBLOOMFILTER_HH__
  31
  32 #include <iostream>
  33 #include <string>
  34
  35 #include "mem/ruby/common/Address.hh"
  36 #include "mem/ruby/common/Global.hh"
  37 #include "mem/ruby/filters/AbstractBloomFilter.hh"
  38
  39 class GenericBloomFilter
  40 {
  41   public:
  42     GenericBloomFilter(std::string config);
  43     ~GenericBloomFilter();
  44
  45     void clear();
  46     void increment(const Address& addr);
  47     void decrement(const Address& addr);
  48     void merge(GenericBloomFilter * other_filter);
  49     void set(const Address& addr);
  50     void unset(const Address& addr);
  51     AbstractBloomFilter *
  52     getFilter()
  53     {
  54         return m_filter;
  55     }
  56
  57     bool isSet(const Address& addr);
  58
  59     int getCount(const Address& addr);
  60
  61     int getTotalCount();
  62
  63     int getIndex(const Address& addr);
  64     int readBit(const int index);
  65     void writeBit(const int index, const int value);
  66
  67     void print(std::ostream& out) const;
  68
  69   private:
  70     AbstractBloomFilter* m_filter;
  71 };
  72
  73 inline std::ostream&
  74 operator<<(std::ostream& out, const GenericBloomFilter& obj)
  75 {
  76     obj.print(out);
  77     out << std::flush;
  78     return out;
  79 }
  80
  81 #endif // __MEM_RUBY_FILTERS_GENERICBLOOMFILTER_HH__