/*
 * 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_BLOCKBLOOMFILTER_HH__
#define __MEM_RUBY_FILTERS_BLOCKBLOOMFILTER_HH__

#include <vector>

#include "mem/ruby/filters/AbstractBloomFilter.hh"

struct BlockBloomFilterParams;

/**
 * Simple deletable (with false negatives) bloom filter that extracts
 * bitfields of an address to use as indexes of the filter vector.
 */
class BlockBloomFilter : public AbstractBloomFilter
{
  public:
    BlockBloomFilter(const BlockBloomFilterParams* p);
    ~BlockBloomFilter();

    void set(Addr addr) override;
    void unset(Addr addr) override;
    int getCount(Addr addr) const override;

  private:
    /**
     * XOR hash between bitfields of an address, provided by the mask vector.
     *
     * @param addr The address to be hashed.
     * @return The value of the XOR of the masked bitfields of the address.
     */
    int hash(Addr addr) const;

    /** Position of the LSB of each mask. */
    std::vector<unsigned> masksLSBs;

    /** Number of bits in each mask. */
    std::vector<unsigned> masksSizes;
};

#endif // __MEM_RUBY_FILTERS_BLOCKBLOOMFILTER_HH__