DPDK  17.11.0
rte_member.h
Go to the documentation of this file.
1 /*-
2  * BSD LICENSE
3  *
4  * Copyright(c) 2017 Intel Corporation. All rights reserved.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  * * Neither the name of Intel Corporation nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
74 #ifndef _RTE_MEMBER_H_
75 #define _RTE_MEMBER_H_
76 
77 #ifdef __cplusplus
78 extern "C" {
79 #endif
80 
81 #include <stdint.h>
82 
84 typedef uint16_t member_set_t;
86 #define RTE_MEMBER_NO_MATCH 0
87 
88 #define RTE_MEMBER_ENTRIES_MAX (1 << 30)
89 
90 #define RTE_MEMBER_LOOKUP_BULK_MAX 64
91 
92 #define RTE_MEMBER_BUCKET_ENTRIES 16
93 
94 #define RTE_MEMBER_NAMESIZE 32
95 
97 #if defined(RTE_ARCH_X86) || defined(RTE_MACHINE_CPUFLAG_CRC32)
98 #include <rte_hash_crc.h>
99 #define MEMBER_HASH_FUNC rte_hash_crc
100 #else
101 #include <rte_jhash.h>
102 #define MEMBER_HASH_FUNC rte_jhash
103 #endif
104 
105 extern int librte_member_logtype;
106 
107 #define RTE_MEMBER_LOG(level, fmt, args...) \
108 rte_log(RTE_LOG_ ## level, librte_member_logtype, "%s(): " fmt, \
109  __func__, ## args)
110 
112 struct rte_member_setsum;
113 
120 struct rte_member_parameters;
121 
131  RTE_MEMBER_NUM_TYPE
132 };
133 
135 enum rte_member_sig_compare_function {
136  RTE_MEMBER_COMPARE_SCALAR = 0,
137  RTE_MEMBER_COMPARE_AVX2,
138  RTE_MEMBER_COMPARE_NUM
139 };
140 
142 struct rte_member_setsum {
143  enum rte_member_setsum_type type; /* Type of the set summary. */
144  uint32_t key_len; /* Length of key. */
145  uint32_t prim_hash_seed; /* Primary hash function seed. */
146  uint32_t sec_hash_seed; /* Secondary hash function seed. */
147 
148  /* Hash table based. */
149  uint32_t bucket_cnt; /* Number of buckets. */
150  uint32_t bucket_mask; /* Bit mask to get bucket index. */
151  /* For runtime selecting AVX, scalar, etc for signature comparison. */
152  enum rte_member_sig_compare_function sig_cmp_fn;
153  uint8_t cache; /* If it is cache mode for ht based. */
154 
155  /* Vector bloom filter. */
156  uint32_t num_set; /* Number of set (bf) in vbf. */
157  uint32_t bits; /* Number of bits in each bf. */
158  uint32_t bit_mask; /* Bit mask to get bit location in bf. */
159  uint32_t num_hashes; /* Number of hash values to index bf. */
160 
161  uint32_t mul_shift; /* vbf internal variable used during bit test. */
162  uint32_t div_shift; /* vbf internal variable used during bit test. */
163 
164  void *table; /* This is the handler of hash table or vBF array. */
165 
166 
167  /* Second cache line should start here. */
168  uint32_t socket_id; /* NUMA Socket ID for memory. */
169  char name[RTE_MEMBER_NAMESIZE]; /* Name of this set summary. */
171 
182  const char *name;
195 
215  uint8_t is_cache;
216 
233  uint32_t num_keys;
234 
239  uint32_t key_len;
240 
250  uint32_t num_set;
251 
272 
281  uint32_t prim_hash_seed;
282 
286  uint32_t sec_hash_seed;
287 
288  int socket_id;
289 };
290 
304 struct rte_member_setsum *
305 rte_member_find_existing(const char *name);
306 
319 struct rte_member_setsum *
320 rte_member_create(const struct rte_member_parameters *params);
321 
338 int
339 rte_member_lookup(const struct rte_member_setsum *setsum, const void *key,
340  member_set_t *set_id);
341 
362 int
363 rte_member_lookup_bulk(const struct rte_member_setsum *setsum,
364  const void **keys, uint32_t num_keys,
365  member_set_t *set_ids);
366 
391 int
392 rte_member_lookup_multi(const struct rte_member_setsum *setsum,
393  const void *key, uint32_t max_match_per_key,
394  member_set_t *set_id);
395 
422 int
423 rte_member_lookup_multi_bulk(const struct rte_member_setsum *setsum,
424  const void **keys, uint32_t num_keys,
425  uint32_t max_match_per_key,
426  uint32_t *match_count,
427  member_set_t *set_ids);
428 
458 int
459 rte_member_add(const struct rte_member_setsum *setsum, const void *key,
460  member_set_t set_id);
461 
471 void
472 rte_member_free(struct rte_member_setsum *setsum);
473 
484 void
485 rte_member_reset(const struct rte_member_setsum *setsum);
486 
505 int
506 rte_member_delete(const struct rte_member_setsum *setsum, const void *key,
507  member_set_t set_id);
508 
509 #ifdef __cplusplus
510 }
511 #endif
512 
513 #endif /* _RTE_MEMBER_H_ */
const char * name
Definition: rte_member.h:182
#define RTE_MEMBER_NAMESIZE
Definition: rte_member.h:94
int rte_member_delete(const struct rte_member_setsum *setsum, const void *key, member_set_t set_id)
int rte_member_add(const struct rte_member_setsum *setsum, const void *key, member_set_t set_id)
int rte_member_lookup_multi(const struct rte_member_setsum *setsum, const void *key, uint32_t max_match_per_key, member_set_t *set_id)
struct rte_mbuf __rte_cache_aligned
int rte_member_lookup_multi_bulk(const struct rte_member_setsum *setsum, const void **keys, uint32_t num_keys, uint32_t max_match_per_key, uint32_t *match_count, member_set_t *set_ids)
uint16_t member_set_t
Definition: rte_member.h:84
void rte_member_free(struct rte_member_setsum *setsum)
int rte_member_lookup_bulk(const struct rte_member_setsum *setsum, const void **keys, uint32_t num_keys, member_set_t *set_ids)
struct rte_member_setsum * rte_member_find_existing(const char *name)
rte_member_setsum_type
Definition: rte_member.h:128
int rte_member_lookup(const struct rte_member_setsum *setsum, const void *key, member_set_t *set_id)
void rte_member_reset(const struct rte_member_setsum *setsum)
struct rte_member_setsum * rte_member_create(const struct rte_member_parameters *params)
enum rte_member_setsum_type type
Definition: rte_member.h:194