4 * Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
49 /** Maximum size of hash table that can be created. */
50 #define RTE_HASH_ENTRIES_MAX (1 << 30)
52 /** @deprecated Maximum bucket size that can be created. */
53 #define RTE_HASH_BUCKET_ENTRIES_MAX 4
55 /** @deprecated Maximum length of key that can be used. */
56 #define RTE_HASH_KEY_LENGTH_MAX 64
58 /** Maximum number of characters in hash name.*/
59 #define RTE_HASH_NAMESIZE 32
61 /** Maximum number of keys that can be searched for using rte_hash_lookup_bulk. */
62 #define RTE_HASH_LOOKUP_BULK_MAX 64
63 #define RTE_HASH_LOOKUP_MULTI_MAX RTE_HASH_LOOKUP_BULK_MAX
65 /** Signature of key that is stored internally. */
66 typedef uint32_t hash_sig_t;
68 /** Type of function that can be used for calculating the hash value. */
69 typedef uint32_t (*rte_hash_function)(const void *key, uint32_t key_len,
73 * Parameters used when creating the hash table.
75 struct rte_hash_parameters {
76 const char *name; /**< Name of the hash. */
77 uint32_t entries; /**< Total hash table entries. */
78 uint32_t bucket_entries; /**< Bucket entries. */
79 uint32_t key_len; /**< Length of hash key. */
80 rte_hash_function hash_func; /**< Primary Hash function used to calculate hash. */
81 uint32_t hash_func_init_val; /**< Init value used by hash_func. */
82 int socket_id; /**< NUMA Socket ID for memory. */
85 /** @internal A hash table structure. */
90 * Create a new hash table.
93 * Parameters used to create and initialise the hash table.
95 * Pointer to hash table structure that is used in future hash table
96 * operations, or NULL on error, with error code set in rte_errno.
97 * Possible rte_errno errors include:
98 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
99 * - E_RTE_SECONDARY - function was called from a secondary process instance
100 * - ENOENT - missing entry
101 * - EINVAL - invalid parameter passed to function
102 * - ENOSPC - the maximum number of memzones has already been allocated
103 * - EEXIST - a memzone with the same name already exists
104 * - ENOMEM - no appropriate memory area found in which to create memzone
107 rte_hash_create(const struct rte_hash_parameters *params);
110 * Find an existing hash table object and return a pointer to it.
113 * Name of the hash table as passed to rte_hash_create()
115 * Pointer to hash table or NULL if object not found
116 * with rte_errno set appropriately. Possible rte_errno values include:
117 * - ENOENT - value not available for return
120 rte_hash_find_existing(const char *name);
123 * De-allocate all memory used by hash table.
128 rte_hash_free(struct rte_hash *h);
131 * Reset all hash structure, by zeroing all entries
133 * Hash table to reset
136 rte_hash_reset(struct rte_hash *h);
139 * Add a key to an existing hash table. This operation is not multi-thread safe
140 * and should only be called from one thread.
143 * Hash table to add the key to.
145 * Key to add to the hash table.
147 * - -EINVAL if the parameters are invalid.
148 * - -ENOSPC if there is no space in the hash for this key.
149 * - A positive value that can be used by the caller as an offset into an
150 * array of user data. This value is unique for this key.
153 rte_hash_add_key(const struct rte_hash *h, const void *key);
156 * Add a key to an existing hash table.
157 * This operation is not multi-thread safe
158 * and should only be called from one thread.
161 * Hash table to add the key to.
163 * Key to add to the hash table.
165 * Precomputed hash value for 'key'.
167 * - -EINVAL if the parameters are invalid.
168 * - -ENOSPC if there is no space in the hash for this key.
169 * - A positive value that can be used by the caller as an offset into an
170 * array of user data. This value is unique for this key.
173 rte_hash_add_key_with_hash(const struct rte_hash *h, const void *key, hash_sig_t sig);
176 * Remove a key from an existing hash table.
177 * This operation is not multi-thread safe
178 * and should only be called from one thread.
181 * Hash table to remove the key from.
183 * Key to remove from the hash table.
185 * - -EINVAL if the parameters are invalid.
186 * - -ENOENT if the key is not found.
187 * - A positive value that can be used by the caller as an offset into an
188 * array of user data. This value is unique for this key, and is the same
189 * value that was returned when the key was added.
192 rte_hash_del_key(const struct rte_hash *h, const void *key);
195 * Remove a key from an existing hash table.
196 * This operation is not multi-thread safe
197 * and should only be called from one thread.
200 * Hash table to remove the key from.
202 * Key to remove from the hash table.
204 * Precomputed hash value for 'key'.
206 * - -EINVAL if the parameters are invalid.
207 * - -ENOENT if the key is not found.
208 * - A positive value that can be used by the caller as an offset into an
209 * array of user data. This value is unique for this key, and is the same
210 * value that was returned when the key was added.
213 rte_hash_del_key_with_hash(const struct rte_hash *h, const void *key, hash_sig_t sig);
216 * Find a key in the hash table.
217 * This operation is multi-thread safe.
220 * Hash table to look in.
224 * - -EINVAL if the parameters are invalid.
225 * - -ENOENT if the key is not found.
226 * - A positive value that can be used by the caller as an offset into an
227 * array of user data. This value is unique for this key, and is the same
228 * value that was returned when the key was added.
231 rte_hash_lookup(const struct rte_hash *h, const void *key);
234 * Find a key in the hash table.
235 * This operation is multi-thread safe.
238 * Hash table to look in.
242 * Hash value to remove from the hash table.
244 * - -EINVAL if the parameters are invalid.
245 * - -ENOENT if the key is not found.
246 * - A positive value that can be used by the caller as an offset into an
247 * array of user data. This value is unique for this key, and is the same
248 * value that was returned when the key was added.
251 rte_hash_lookup_with_hash(const struct rte_hash *h,
252 const void *key, hash_sig_t sig);
255 * Calc a hash value by key.
256 * This operation is not multi-thread safe.
259 * Hash table to look in.
266 rte_hash_hash(const struct rte_hash *h, const void *key);
268 #define rte_hash_lookup_multi rte_hash_lookup_bulk
270 * Find multiple keys in the hash table.
271 * This operation is multi-thread safe.
274 * Hash table to look in.
276 * A pointer to a list of keys to look for.
278 * How many keys are in the keys list (less than RTE_HASH_LOOKUP_BULK_MAX).
280 * Output containing a list of values, corresponding to the list of keys that
281 * can be used by the caller as an offset into an array of user data. These
282 * values are unique for each key, and are the same values that were returned
283 * when each key was added. If a key in the list was not found, then -ENOENT
286 * -EINVAL if there's an error, otherwise 0.
289 rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
290 uint32_t num_keys, int32_t *positions);
296 #endif /* _RTE_HASH_H_ */