numam-dpdk/lib/librte_member/rte_member_vbf.h
Yipeng Wang 54b8edc07c member: implement vBF mode
Bloom Filter (BF) [1] is a well-known space-efficient
probabilistic data structure that answers set membership queries.
Vector of Bloom Filters (vBF) is an extension to traditional BF
that supports multi-set membership testing. Traditional BF will
return found or not-found for each key. vBF will also return
which set the key belongs to if it is found.

Since each set requires a BF, vBF should be used when set count
is small. vBF's false positive rate could be set appropriately so
that its memory requirement and lookup speed is better in certain
cases comparing to HT based set-summary.

This patch adds the vBF implementation.

[1]B H Bloom, “Space/Time Trade-offs in Hash Coding with Allowable
Errors,” Communications of the ACM, 1970.

Signed-off-by: Yipeng Wang <yipeng1.wang@intel.com>
Reviewed-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2017-10-09 00:02:45 +02:00

83 lines
2.8 KiB
C

/*-
* BSD LICENSE
*
* Copyright(c) 2017 Intel Corporation. All rights reserved.
* 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 Intel Corporation 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 _RTE_MEMBER_VBF_H_
#define _RTE_MEMBER_VBF_H_
#ifdef __cplusplus
extern "C" {
#endif
/* Currently we only support up to 32 sets in vBF */
#define RTE_MEMBER_MAX_BF 32
int
rte_member_create_vbf(struct rte_member_setsum *ss,
const struct rte_member_parameters *params);
int
rte_member_lookup_vbf(const struct rte_member_setsum *setsum,
const void *key, member_set_t *set_id);
uint32_t
rte_member_lookup_bulk_vbf(const struct rte_member_setsum *setsum,
const void **keys, uint32_t num_keys,
member_set_t *set_ids);
uint32_t
rte_member_lookup_multi_vbf(const struct rte_member_setsum *setsum,
const void *key, uint32_t match_per_key,
member_set_t *set_id);
uint32_t
rte_member_lookup_multi_bulk_vbf(const struct rte_member_setsum *setsum,
const void **keys, uint32_t num_keys, uint32_t match_per_key,
uint32_t *match_count,
member_set_t *set_ids);
int
rte_member_add_vbf(const struct rte_member_setsum *setsum,
const void *key, member_set_t set_id);
void
rte_member_free_vbf(struct rte_member_setsum *ss);
void
rte_member_reset_vbf(const struct rte_member_setsum *setsum);
#ifdef __cplusplus
}
#endif
#endif /* _RTE_MEMBER_VBF_H_ */