src/mem/ruby/filters/AbstractBloomFilter.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_ABSTRACTBLOOMFILTER_HH__
  30 #define __MEM_RUBY_FILTERS_ABSTRACTBLOOMFILTER_HH__
  31
  32 #include <iostream>
  33
  34 #include "mem/ruby/common/Address.hh"
  35 #include "mem/ruby/common/Global.hh"
  36
  37 class AbstractBloomFilter
  38 {
  39   public:
  40     virtual ~AbstractBloomFilter() {};
  41     virtual void clear() = 0;
  42     virtual void increment(const Address& addr) = 0;
  43     virtual void decrement(const Address& addr) = 0;
  44     virtual void merge(AbstractBloomFilter * other_filter) = 0;
  45     virtual void set(const Address& addr) = 0;
  46     virtual void unset(const Address& addr) = 0;
  47
  48     virtual bool isSet(const Address& addr) = 0;
  49     virtual int getCount(const Address& addr) = 0;
  50     virtual int getTotalCount() = 0;
  51
  52     virtual void print(std::ostream& out) const = 0;
  53
  54     virtual int getIndex(const Address& addr) = 0;
  55     virtual int readBit(const int index) = 0;
  56     virtual void writeBit(const int index, const int value) = 0;
  57 };
  58
  59 #endif // __MEM_RUBY_FILTERS_ABSTRACTBLOOMFILTER_HH__