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