ruby: bloom filters: refactor code

17 files changed, 25 insertions, 320 deletions

diff --git a/src/mem/protocol/RubySlicc_Types.sm b/src/mem/protocol/RubySlicc_Types.sm
index a8bf93bcc..8e846098c 100644
--- a/src/mem/protocol/RubySlicc_Types.sm
+++ b/src/mem/protocol/RubySlicc_Types.sm
@@ -186,7 +186,7 @@ structure (TimerTable, inport="yes", external = "yes") {
   bool isSet(Addr);
 }
 
-structure (GenericBloomFilter, external = "yes") {
+structure (AbstractBloomFilter, external = "yes") {
   void clear(int);
   void increment(Addr, int);
   void decrement(Addr, int);
diff --git a/src/mem/ruby/SConscript b/src/mem/ruby/SConscript
index 091f55060..2ab9c024f 100644
--- a/src/mem/ruby/SConscript
+++ b/src/mem/ruby/SConscript
@@ -119,7 +119,7 @@ MakeInclude('common/DataBlock.hh')
 MakeInclude('common/MachineID.hh')
 MakeInclude('common/NetDest.hh')
 MakeInclude('common/Set.hh')
-MakeInclude('filters/GenericBloomFilter.hh')
+MakeInclude('filters/AbstractBloomFilter.hh')
 MakeInclude('network/MessageBuffer.hh')
 MakeInclude('structures/Prefetcher.hh')
 MakeInclude('structures/CacheMemory.hh')
diff --git a/src/mem/ruby/filters/BlockBloomFilter.cc b/src/mem/ruby/filters/BlockBloomFilter.cc
index 94e748d6e..a453c373f 100644
--- a/src/mem/ruby/filters/BlockBloomFilter.cc
+++ b/src/mem/ruby/filters/BlockBloomFilter.cc
@@ -33,18 +33,9 @@
 
 using namespace std;
 
-BlockBloomFilter::BlockBloomFilter(string str)
+BlockBloomFilter::BlockBloomFilter(int size)
 {
-    string head, tail;
-
-#ifndef NDEBUG
-    bool success =
-#endif
-        split_first(str, head, tail, '_');
-
-    assert(success);
-
-    m_filter_size = atoi(head.c_str());
+    m_filter_size = size;
     m_filter_size_bits = floorLog2(m_filter_size);
 
     m_filter.resize(m_filter_size);
diff --git a/src/mem/ruby/filters/BlockBloomFilter.hh b/src/mem/ruby/filters/BlockBloomFilter.hh
index d45dd236b..8e6a94fa1 100644
--- a/src/mem/ruby/filters/BlockBloomFilter.hh
+++ b/src/mem/ruby/filters/BlockBloomFilter.hh
@@ -30,7 +30,6 @@
 #define __MEM_RUBY_FILTERS_BLOCKBLOOMFILTER_HH__
 
 #include <iostream>
-#include <string>
 #include <vector>
 
 #include "mem/ruby/common/Address.hh"
@@ -39,7 +38,7 @@
 class BlockBloomFilter : public AbstractBloomFilter
 {
   public:
-    BlockBloomFilter(std::string config);
+    BlockBloomFilter(int size);
     ~BlockBloomFilter();
 
     void clear();
@@ -64,7 +63,6 @@ class BlockBloomFilter : public AbstractBloomFilter
     std::vector<int> m_filter;
     int m_filter_size;
     int m_filter_size_bits;
-
 };
 
 #endif // __MEM_RUBY_FILTERS_BLOCKBLOOMFILTER_HH__
diff --git a/src/mem/ruby/filters/BulkBloomFilter.cc b/src/mem/ruby/filters/BulkBloomFilter.cc
index c656776a4..478871a40 100644
--- a/src/mem/ruby/filters/BulkBloomFilter.cc
+++ b/src/mem/ruby/filters/BulkBloomFilter.cc
@@ -35,17 +35,9 @@
 
 using namespace std;
 
-BulkBloomFilter::BulkBloomFilter(string str)
+BulkBloomFilter::BulkBloomFilter(int size)
 {
-    string head, tail;
-
-#ifndef NDEBUG
-    bool success =
-#endif
-        split_first(str, head, tail, '_');
-    assert(success);
-
-    m_filter_size = atoi(head.c_str());
+    m_filter_size = size;
     m_filter_size_bits = floorLog2(m_filter_size);
     // split the filter bits in half, c0 and c1
     m_sector_bits = m_filter_size_bits - 1;
diff --git a/src/mem/ruby/filters/BulkBloomFilter.hh b/src/mem/ruby/filters/BulkBloomFilter.hh
index 8b67c718e..059f8b17a 100644
--- a/src/mem/ruby/filters/BulkBloomFilter.hh
+++ b/src/mem/ruby/filters/BulkBloomFilter.hh
@@ -30,7 +30,6 @@
 #define __MEM_RUBY_FILTERS_BULKBLOOMFILTER_HH__
 
 #include <iostream>
-#include <string>
 #include <vector>
 
 #include "mem/ruby/common/Address.hh"
@@ -39,7 +38,7 @@
 class BulkBloomFilter : public AbstractBloomFilter
 {
   public:
-    BulkBloomFilter(std::string config);
+    BulkBloomFilter(int size);
     ~BulkBloomFilter();
 
     void clear();
diff --git a/src/mem/ruby/filters/GenericBloomFilter.cc b/src/mem/ruby/filters/GenericBloomFilter.cc
deleted file mode 100644
index 3d4cb9ed3..000000000
--- a/src/mem/ruby/filters/GenericBloomFilter.cc
+++ /dev/null
@@ -1,153 +0,0 @@
-/*
- * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are
- * met: redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer;
- * redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution;
- * neither the name of the copyright holders nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-#include "base/str.hh"
-#include "mem/ruby/common/Address.hh"
-#include "mem/ruby/filters/BlockBloomFilter.hh"
-#include "mem/ruby/filters/BulkBloomFilter.hh"
-#include "mem/ruby/filters/GenericBloomFilter.hh"
-#include "mem/ruby/filters/H3BloomFilter.hh"
-#include "mem/ruby/filters/LSB_CountingBloomFilter.hh"
-#include "mem/ruby/filters/MultiBitSelBloomFilter.hh"
-#include "mem/ruby/filters/MultiGrainBloomFilter.hh"
-#include "mem/ruby/filters/NonCountingBloomFilter.hh"
-
-using namespace std;
-
-GenericBloomFilter::GenericBloomFilter(string config)
-{
-    string head, tail;
-#ifndef NDEBUG
-    bool success =
-#endif
-        split_first(config, head, tail, '_');
-    assert(success);
-
-    if (head == "LSB_Counting" ) {
-        m_filter = new LSB_CountingBloomFilter(tail);
-    } else if(head == "NonCounting" ) {
-        m_filter = new NonCountingBloomFilter(tail);
-    } else if(head == "Bulk" ) {
-        m_filter = new BulkBloomFilter(tail);
-    } else if(head == "Block") {
-        m_filter = new BlockBloomFilter(tail);
-    } else if(head == "Multigrain"){
-        m_filter = new MultiGrainBloomFilter(tail);
-    } else if(head == "MultiBitSel"){
-        m_filter = new MultiBitSelBloomFilter(tail);
-    } else if(head == "H3"){
-        m_filter = new H3BloomFilter(tail);
-    } else {
-        assert(0);
-    }
-}
-
-GenericBloomFilter::~GenericBloomFilter()
-{
-    delete m_filter;
-}
-
-void
-GenericBloomFilter::clear()
-{
-    m_filter->clear();
-}
-
-void
-GenericBloomFilter::increment(Addr addr)
-{
-    m_filter->increment(addr);
-}
-
-void
-GenericBloomFilter::decrement(Addr addr)
-{
-    m_filter->decrement(addr);
-}
-
-void
-GenericBloomFilter::merge(GenericBloomFilter * other_filter)
-{
-    m_filter->merge(other_filter->getFilter());
-}
-
-void
-GenericBloomFilter::set(Addr addr)
-{
-    m_filter->set(addr);
-}
-
-void
-GenericBloomFilter::unset(Addr addr)
-{
-    m_filter->unset(addr);
-}
-
-bool
-GenericBloomFilter::isSet(Addr addr)
-{
-    return m_filter->isSet(addr);
-}
-
-int
-GenericBloomFilter::getCount(Addr addr)
-{
-    return m_filter->getCount(addr);
-}
-
-int
-GenericBloomFilter::getTotalCount()
-{
-    return m_filter->getTotalCount();
-}
-
-int
-GenericBloomFilter::getIndex(Addr addr)
-{
-    return m_filter->getIndex(addr);
-}
-
-int
-GenericBloomFilter::readBit(const int index)
-{
-    return m_filter->readBit(index);
-}
-
-void
-GenericBloomFilter::writeBit(const int index, const int value)
-{
-    m_filter->writeBit(index, value);
-}
-
-void
-GenericBloomFilter::print(ostream& out) const
-{
-    return m_filter->print(out);
-}
-
-
diff --git a/src/mem/ruby/filters/GenericBloomFilter.hh b/src/mem/ruby/filters/GenericBloomFilter.hh
deleted file mode 100644
index 869c40ba7..000000000
--- a/src/mem/ruby/filters/GenericBloomFilter.hh
+++ /dev/null
@@ -1,80 +0,0 @@
-/*
- * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are
- * met: redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer;
- * redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution;
- * neither the name of the copyright holders nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-#ifndef __MEM_RUBY_FILTERS_GENERICBLOOMFILTER_HH__
-#define __MEM_RUBY_FILTERS_GENERICBLOOMFILTER_HH__
-
-#include <iostream>
-#include <string>
-
-#include "mem/ruby/common/Address.hh"
-#include "mem/ruby/filters/AbstractBloomFilter.hh"
-
-class GenericBloomFilter
-{
-  public:
-    GenericBloomFilter(std::string config);
-    ~GenericBloomFilter();
-
-    void clear();
-    void increment(Addr addr);
-    void decrement(Addr addr);
-    void merge(GenericBloomFilter * other_filter);
-    void set(Addr addr);
-    void unset(Addr addr);
-    AbstractBloomFilter *
-    getFilter()
-    {
-        return m_filter;
-    }
-
-    bool isSet(Addr addr);
-
-    int getCount(Addr addr);
-
-    int getTotalCount();
-
-    int getIndex(Addr addr);
-    int readBit(const int index);
-    void writeBit(const int index, const int value);
-
-    void print(std::ostream& out) const;
-
-  private:
-    AbstractBloomFilter* m_filter;
-};
-
-inline std::ostream&
-operator<<(std::ostream& out, const GenericBloomFilter& obj)
-{
-    obj.print(out);
-    out << std::flush;
-    return out;
-}
-
-#endif // __MEM_RUBY_FILTERS_GENERICBLOOMFILTER_HH__
diff --git a/src/mem/ruby/filters/H3BloomFilter.cc b/src/mem/ruby/filters/H3BloomFilter.cc
index b0d277782..5d6a9558f 100644
--- a/src/mem/ruby/filters/H3BloomFilter.cc
+++ b/src/mem/ruby/filters/H3BloomFilter.cc
@@ -27,7 +27,6 @@
  */
 
 #include "base/intmath.hh"
-#include "base/str.hh"
 #include "mem/ruby/filters/H3BloomFilter.hh"
 
 using namespace std;
@@ -354,7 +353,7 @@ static int H3[64][16] = {
       394261773,  848616745,  15446017,   517723271,  },
 };
 
-H3BloomFilter::H3BloomFilter(string str)
+H3BloomFilter::H3BloomFilter(int size, int hashes, bool parallel)
 {
     //TODO: change this ugly init code...
     primes_list[0] = 9323;
@@ -378,21 +377,9 @@ H3BloomFilter::H3BloomFilter(string str)
     adds_list[4] = 7777;
     adds_list[5] = 65931;
 
-    vector<string> items;
-    tokenize(items, str, '_');
-    assert(items.size() == 3);
-
-    // head contains filter size, tail contains bit offset from block number
-    m_filter_size = atoi(items[0].c_str());
-    m_num_hashes = atoi(items[1].c_str());
-
-    if (items[2] == "Regular") {
-        isParallel = false;
-    } else if (items[2] == "Parallel") {
-        isParallel = true;
-    } else {
-        panic("ERROR: Incorrect config string for MultiHash Bloom! :%s", str);
-    }
+    m_filter_size = size;
+    m_num_hashes = hashes;
+    isParallel = parallel;
 
     m_filter_size_bits = floorLog2(m_filter_size);
 
diff --git a/src/mem/ruby/filters/H3BloomFilter.hh b/src/mem/ruby/filters/H3BloomFilter.hh
index b6628f5e1..443487fac 100644
--- a/src/mem/ruby/filters/H3BloomFilter.hh
+++ b/src/mem/ruby/filters/H3BloomFilter.hh
@@ -30,17 +30,15 @@
 #define __MEM_RUBY_FILTERS_H3BLOOMFILTER_HH__
 
 #include <iostream>
-#include <string>
 #include <vector>
 
 #include "mem/ruby/common/Address.hh"
-#include "mem/ruby/common/TypeDefines.hh"
 #include "mem/ruby/filters/AbstractBloomFilter.hh"
 
 class H3BloomFilter : public AbstractBloomFilter
 {
   public:
-    H3BloomFilter(std::string config);
+    H3BloomFilter(int size, int hashes, bool parallel);
     ~H3BloomFilter();
 
     void clear();
diff --git a/src/mem/ruby/filters/LSB_CountingBloomFilter.cc b/src/mem/ruby/filters/LSB_CountingBloomFilter.cc
index 1c2d4fea6..eaac5c4a2 100644
--- a/src/mem/ruby/filters/LSB_CountingBloomFilter.cc
+++ b/src/mem/ruby/filters/LSB_CountingBloomFilter.cc
@@ -27,25 +27,17 @@
  */
 
 #include "base/intmath.hh"
-#include "base/str.hh"
 #include "mem/ruby/filters/LSB_CountingBloomFilter.hh"
 #include "mem/ruby/system/RubySystem.hh"
 
 using namespace std;
 
-LSB_CountingBloomFilter::LSB_CountingBloomFilter(string str)
+LSB_CountingBloomFilter::LSB_CountingBloomFilter(int head, int tail)
 {
-    string head, tail;
-#ifndef NDEBUG
-    bool success =
-#endif
-        split_first(str, head, tail, '_');
-    assert(success);
-
-    m_filter_size = atoi(head.c_str());
+    m_filter_size = head;
     m_filter_size_bits = floorLog2(m_filter_size);
 
-    m_count = atoi(tail.c_str());
+    m_count = tail;
     m_count_bits = floorLog2(m_count);
 
     m_filter.resize(m_filter_size);
diff --git a/src/mem/ruby/filters/LSB_CountingBloomFilter.hh b/src/mem/ruby/filters/LSB_CountingBloomFilter.hh
index 2f23896e2..e0e263ae6 100644
--- a/src/mem/ruby/filters/LSB_CountingBloomFilter.hh
+++ b/src/mem/ruby/filters/LSB_CountingBloomFilter.hh
@@ -30,7 +30,6 @@
 #define __MEM_RUBY_FILTERS_LSBCOUNTINGBLOOMFILTER_HH__
 
 #include <iostream>
-#include <string>
 #include <vector>
 
 #include "mem/ruby/common/Address.hh"
@@ -39,7 +38,7 @@
 class LSB_CountingBloomFilter : public AbstractBloomFilter
 {
   public:
-    LSB_CountingBloomFilter(std::string config);
+    LSB_CountingBloomFilter(int head, int tail);
     ~LSB_CountingBloomFilter();
 
     void clear();
diff --git a/src/mem/ruby/filters/MultiGrainBloomFilter.cc b/src/mem/ruby/filters/MultiGrainBloomFilter.cc
index 52aae0b55..a6642ab7b 100644
--- a/src/mem/ruby/filters/MultiGrainBloomFilter.cc
+++ b/src/mem/ruby/filters/MultiGrainBloomFilter.cc
@@ -33,22 +33,14 @@
 
 using namespace std;
 
-MultiGrainBloomFilter::MultiGrainBloomFilter(string str)
+MultiGrainBloomFilter::MultiGrainBloomFilter(int head, int tail)
 {
-    string head, tail;
-#ifndef NDEBUG
-    bool success =
-#endif
-        split_first(str, head, tail, '_');
-    assert(success);
-
     // head contains size of 1st bloom filter, tail contains size of
     // 2nd bloom filter
-
-    m_filter_size = atoi(head.c_str());
+    m_filter_size = head;
     m_filter_size_bits = floorLog2(m_filter_size);
 
-    m_page_filter_size = atoi(tail.c_str());
+    m_page_filter_size = tail;
     m_page_filter_size_bits = floorLog2(m_page_filter_size);
 
     m_filter.resize(m_filter_size);
diff --git a/src/mem/ruby/filters/MultiGrainBloomFilter.hh b/src/mem/ruby/filters/MultiGrainBloomFilter.hh
index ceb364a49..e4c83957d 100644
--- a/src/mem/ruby/filters/MultiGrainBloomFilter.hh
+++ b/src/mem/ruby/filters/MultiGrainBloomFilter.hh
@@ -30,7 +30,6 @@
 #define __MEM_RUBY_FILTERS_MULTIGRAINBLOOMFILTER_HH__
 
 #include <iostream>
-#include <string>
 #include <vector>
 
 #include "mem/ruby/common/Address.hh"
@@ -39,7 +38,7 @@
 class MultiGrainBloomFilter : public AbstractBloomFilter
 {
   public:
-    MultiGrainBloomFilter(std::string str);
+    MultiGrainBloomFilter(int head, int tail);
     ~MultiGrainBloomFilter();
 
     void clear();
diff --git a/src/mem/ruby/filters/NonCountingBloomFilter.cc b/src/mem/ruby/filters/NonCountingBloomFilter.cc
index a8d00c8d7..d949d02c4 100644
--- a/src/mem/ruby/filters/NonCountingBloomFilter.cc
+++ b/src/mem/ruby/filters/NonCountingBloomFilter.cc
@@ -33,18 +33,11 @@
 
 using namespace std;
 
-NonCountingBloomFilter::NonCountingBloomFilter(string str)
+NonCountingBloomFilter::NonCountingBloomFilter(int head, int tail)
 {
-    string head, tail;
-#ifndef NDEBUG
-    bool success =
-#endif
-        split_first(str, head, tail, '_');
-    assert(success);
-
     // head contains filter size, tail contains bit offset from block number
-    m_filter_size = atoi(head.c_str());
-    m_offset = atoi(tail.c_str());
+    m_filter_size = head;
+    m_offset = tail;
     m_filter_size_bits = floorLog2(m_filter_size);
 
     m_filter.resize(m_filter_size);
diff --git a/src/mem/ruby/filters/NonCountingBloomFilter.hh b/src/mem/ruby/filters/NonCountingBloomFilter.hh
index a092cd667..b0599e74b 100644
--- a/src/mem/ruby/filters/NonCountingBloomFilter.hh
+++ b/src/mem/ruby/filters/NonCountingBloomFilter.hh
@@ -30,7 +30,6 @@
 #define __MEM_RUBY_FILTERS_NONCOUNTINGBLOOMFILTER_HH__
 
 #include <iostream>
-#include <string>
 #include <vector>
 
 #include "mem/ruby/common/Address.hh"
@@ -39,7 +38,7 @@
 class NonCountingBloomFilter : public AbstractBloomFilter
 {
   public:
-    NonCountingBloomFilter(std::string config);
+    NonCountingBloomFilter(int head, int tail);
     ~NonCountingBloomFilter();
 
     void clear();
diff --git a/src/mem/ruby/filters/SConscript b/src/mem/ruby/filters/SConscript
index adfe214c0..5b7e58334 100644
--- a/src/mem/ruby/filters/SConscript
+++ b/src/mem/ruby/filters/SConscript
@@ -35,7 +35,6 @@ if env['PROTOCOL'] == 'None':
 
 Source('BlockBloomFilter.cc')
 Source('BulkBloomFilter.cc')
-Source('GenericBloomFilter.cc')
 Source('H3BloomFilter.cc')
 Source('LSB_CountingBloomFilter.cc')
 Source('MultiBitSelBloomFilter.cc')