1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Bloom filter support 4 * 5 * Copyright (C) 1999-2019, Broadcom. 6 * 7 * Unless you and Broadcom execute a separate written software license 8 * agreement governing use of this software, this software is licensed to you 9 * under the terms of the GNU General Public License version 2 (the "GPL"), 10 * available at http://www.broadcom.com/licenses/GPLv2.php, with the 11 * following added to such license: 12 * 13 * As a special exception, the copyright holders of this software give you 14 * permission to link this software with independent modules, and to copy and 15 * distribute the resulting executable under terms of your choice, provided that 16 * you also meet, for each linked independent module, the terms and conditions of 17 * the license of that module. An independent module is a module which is not 18 * derived from this software. The special exception does not apply to any 19 * modifications of the software. 20 * 21 * Notwithstanding the above, under no circumstances may you combine this 22 * software in any way with any other Broadcom software provided under a license 23 * other than the GPL, without Broadcom's express prior written consent. 24 * 25 * 26 * <<Broadcom-WL-IPTag/Open:>> 27 * 28 * $Id: bcmbloom.h 714397 2017-08-04 08:24:38Z $ 29 */ 30 31 #ifndef _bcmbloom_h_ 32 #define _bcmbloom_h_ 33 34 #include <typedefs.h> 35 #ifdef BCMDRIVER 36 #include <osl.h> 37 #else 38 #include <stddef.h> /* For size_t */ 39 #endif // endif 40 41 struct bcm_bloom_filter; 42 typedef struct bcm_bloom_filter bcm_bloom_filter_t; 43 44 typedef void* (*bcm_bloom_alloc_t)(void *ctx, uint size); 45 typedef void (*bcm_bloom_free_t)(void *ctx, void *buf, uint size); 46 typedef uint (*bcm_bloom_hash_t)(void* ctx, uint idx, const uint8 *tag, uint len); 47 48 /* create/allocate a bloom filter. filter size can be 0 for validate only filters */ 49 int bcm_bloom_create(bcm_bloom_alloc_t alloc_cb, 50 bcm_bloom_free_t free_cb, void *callback_ctx, uint max_hash, 51 uint filter_size /* bytes */, bcm_bloom_filter_t **bloom); 52 53 /* destroy bloom filter */ 54 int bcm_bloom_destroy(bcm_bloom_filter_t **bloom, bcm_bloom_free_t free_cb); 55 56 /* add a hash function to filter, return an index */ 57 int bcm_bloom_add_hash(bcm_bloom_filter_t *filter, bcm_bloom_hash_t hash, uint *idx); 58 59 /* remove the hash function at index from filter */ 60 int bcm_bloom_remove_hash(bcm_bloom_filter_t *filter, uint idx); 61 62 /* check if given tag is member of the filter. If buf is NULL and/or buf_len is 0 63 * then use the internal state. BCME_OK if member, BCME_NOTFOUND if not, 64 * or other error (e.g. BADARG) 65 */ 66 bool bcm_bloom_is_member(bcm_bloom_filter_t *filter, 67 const uint8 *tag, uint tag_len, const uint8 *buf, uint buf_len); 68 69 /* add a member to the filter. invalid for validate_only filters */ 70 int bcm_bloom_add_member(bcm_bloom_filter_t *filter, const uint8 *tag, uint tag_len); 71 72 /* no support for remove member */ 73 74 /* get the filter data from state. BCME_BUFTOOSHORT w/ required length in buf_len 75 * if supplied size is insufficient 76 */ 77 int bcm_bloom_get_filter_data(bcm_bloom_filter_t *filter, 78 uint buf_size, uint8 *buf, uint *buf_len); 79 80 #endif /* _bcmbloom_h_ */ 81