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 << 26)
52 /** Maximum bucket size that can be created. */
53 #define RTE_HASH_BUCKET_ENTRIES_MAX 16
55 /** Maximum length of key that can be used. */
56 #define RTE_HASH_KEY_LENGTH_MAX 64
58 /** Max number of keys that can be searched for using rte_hash_lookup_multi. */
59 #define RTE_HASH_LOOKUP_BULK_MAX 16
60 #define RTE_HASH_LOOKUP_MULTI_MAX RTE_HASH_LOOKUP_BULK_MAX
62 /** Max number of characters in hash name.*/
63 #define RTE_HASH_NAMESIZE 32
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. The total table entries and
74 * bucket entries must be a power of 2.
76 struct rte_hash_parameters {
77 const char *name; /**< Name of the hash. */
78 uint32_t entries; /**< Total hash table entries. */
79 uint32_t bucket_entries; /**< Bucket entries. */
80 uint32_t key_len; /**< Length of hash key. */
81 rte_hash_function hash_func; /**< Function used to calculate hash. */
82 uint32_t hash_func_init_val; /**< Init value used by hash_func. */
83 int socket_id; /**< NUMA Socket ID for memory. */
86 /** @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);
111 * Find an existing hash table object and return a pointer to it.
114 * Name of the hash table as passed to rte_hash_create()
116 * Pointer to hash table or NULL if object not found
117 * with rte_errno set appropriately. Possible rte_errno values include:
118 * - ENOENT - value not available for return
121 rte_hash_find_existing(const char *name);
124 * De-allocate all memory used by hash table.
129 rte_hash_free(struct rte_hash *h);
132 * Add a key to an existing hash table. This operation is not multi-thread safe
133 * and should only be called from one thread.
136 * Hash table to add the key to.
138 * Key to add to the hash table.
140 * - -EINVAL if the parameters are invalid.
141 * - -ENOSPC if there is no space in the hash for this key.
142 * - A positive value that can be used by the caller as an offset into an
143 * array of user data. This value is unique for this key.
146 rte_hash_add_key(const struct rte_hash *h, const void *key);
149 * Add a key to an existing hash table. This operation is not multi-thread safe
150 * and should only be called from one thread.
153 * Hash table to add the key to.
155 * Key to add to the hash table.
157 * Hash value to add to the hash table.
159 * - -EINVAL if the parameters are invalid.
160 * - -ENOSPC if there is no space in the hash for this key.
161 * - A positive value that can be used by the caller as an offset into an
162 * array of user data. This value is unique for this key.
165 rte_hash_add_key_with_hash(const struct rte_hash *h,
166 const void *key, hash_sig_t sig);
169 * Remove a key from an existing hash table. This operation is not multi-thread
170 * safe and should only be called from one thread.
173 * Hash table to remove the key from.
175 * Key to remove from the hash table.
177 * - -EINVAL if the parameters are invalid.
178 * - -ENOENT if the key is not found.
179 * - A positive value that can be used by the caller as an offset into an
180 * array of user data. This value is unique for this key, and is the same
181 * value that was returned when the key was added.
184 rte_hash_del_key(const struct rte_hash *h, const void *key);
187 * Remove a key from an existing hash table. This operation is not multi-thread
188 * safe and should only be called from one thread.
191 * Hash table to remove the key from.
193 * Key to remove from the hash table.
195 * Hash value to remove from the hash table.
197 * - -EINVAL if the parameters are invalid.
198 * - -ENOENT if the key is not found.
199 * - A positive value that can be used by the caller as an offset into an
200 * array of user data. This value is unique for this key, and is the same
201 * value that was returned when the key was added.
204 rte_hash_del_key_with_hash(const struct rte_hash *h,
205 const void *key, hash_sig_t sig);
209 * Find a key in the hash table. This operation is multi-thread safe.
212 * Hash table to look in.
216 * - -EINVAL if the parameters are invalid.
217 * - -ENOENT if the key is not found.
218 * - A positive value that can be used by the caller as an offset into an
219 * array of user data. This value is unique for this key, and is the same
220 * value that was returned when the key was added.
223 rte_hash_lookup(const struct rte_hash *h, const void *key);
226 * Find a key in the hash table. This operation is multi-thread safe.
229 * Hash table to look in.
233 * Hash value to find.
235 * - -EINVAL if the parameters are invalid.
236 * - -ENOENT if the key is not found.
237 * - A positive value that can be used by the caller as an offset into an
238 * array of user data. This value is unique for this key, and is the same
239 * value that was returned when the key was added.
242 rte_hash_lookup_with_hash(const struct rte_hash *h,
243 const void *key, hash_sig_t sig);
246 * Calc a hash value by key. This operation is not multi-process safe.
249 * Hash table to look in.
256 rte_hash_hash(const struct rte_hash *h, const void *key);
258 #define rte_hash_lookup_multi rte_hash_lookup_bulk
260 * Find multiple keys in the hash table. This operation is multi-thread safe.
263 * Hash table to look in.
265 * A pointer to a list of keys to look for.
267 * How many keys are in the keys list (less than RTE_HASH_LOOKUP_BULK_MAX).
269 * Output containing a list of values, corresponding to the list of keys that
270 * can be used by the caller as an offset into an array of user data. These
271 * values are unique for each key, and are the same values that were returned
272 * when each key was added. If a key in the list was not found, then -ENOENT
275 * -EINVAL if there's an error, otherwise 0.
278 rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
279 uint32_t num_keys, int32_t *positions);
284 #endif /* _RTE_HASH_H_ */