src/mem/ruby/system/AbstractBloomFilter.hh

   1
   2 /*
   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
  30 /*
  31  * AbstractBloomFilter.h
  32  *
  33  * Description:
  34  *
  35  *
  36  */
  37
  38 #ifndef ABSTRACT_BLOOM_FILTER_H
  39 #define ABSTRACT_BLOOM_FILTER_H
  40
  41 #include "Global.hh"
  42 #include "AbstractChip.hh"
  43 #include "RubyConfig.hh"
  44 #include "Address.hh"
  45
  46 class AbstractBloomFilter {
  47 public:
  48
  49   virtual ~AbstractBloomFilter() {};
  50   virtual void clear() = 0;
  51   virtual void increment(const Address& addr) = 0;
  52   virtual void decrement(const Address& addr) = 0;
  53   virtual void merge(AbstractBloomFilter * other_filter) = 0;
  54   virtual void set(const Address& addr) = 0;
  55   virtual void unset(const Address& addr) = 0;
  56
  57   virtual bool isSet(const Address& addr) = 0;
  58   virtual int getCount(const Address& addr) = 0;
  59   virtual int getTotalCount() = 0;
  60
  61   virtual void print(ostream& out) const = 0;
  62
  63   virtual int getIndex(const Address& addr) = 0;
  64   virtual int readBit(const int index) = 0;
  65   virtual void writeBit(const int index, const int value) = 0;
  66
  67 private:
  68
  69 };
  70
  71
  72 #endif