4 * Copyright(c) 2010-2012 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.
41 #include <sys/queue.h>
42 #include <rte_memory.h>
43 #include <rte_memzone.h>
44 #include <rte_tailq.h>
46 #include <rte_eal_memconfig.h>
47 #include <rte_malloc.h>
48 #include <rte_common.h>
49 #include <rte_per_lcore.h>
50 #include <rte_errno.h>
51 #include <rte_string_fns.h>
52 #include <rte_cpuflags.h>
55 #include "rte_fbk_hash.h"
57 TAILQ_HEAD(rte_fbk_hash_list, rte_fbk_hash_table);
60 * Performs a lookup for an existing hash table, and returns a pointer to
64 * Name of the hash table to find
67 * pointer to hash table structure or NULL on error.
69 struct rte_fbk_hash_table *
70 rte_fbk_hash_find_existing(const char *name)
72 struct rte_fbk_hash_table *h;
73 struct rte_fbk_hash_list *fbk_hash_list;
75 /* check that we have an initialised tail queue */
77 RTE_TAILQ_LOOKUP_BY_IDX(RTE_TAILQ_FBK_HASH, rte_fbk_hash_list)) == NULL) {
78 rte_errno = E_RTE_NO_TAILQ;
82 TAILQ_FOREACH(h, fbk_hash_list, next) {
83 if (strncmp(name, h->name, RTE_FBK_HASH_NAMESIZE) == 0)
92 * Create a new hash table for use with four byte keys.
95 * Parameters used in creation of hash table.
98 * Pointer to hash table structure that is used in future hash table
99 * operations, or NULL on error.
101 struct rte_fbk_hash_table *
102 rte_fbk_hash_create(const struct rte_fbk_hash_params *params)
104 struct rte_fbk_hash_table *ht = NULL;
105 char hash_name[RTE_FBK_HASH_NAMESIZE];
106 const uint32_t mem_size =
107 sizeof(*ht) + (sizeof(ht->t[0]) * params->entries);
109 struct rte_fbk_hash_list *fbk_hash_list;
111 /* check that we have an initialised tail queue */
113 RTE_TAILQ_LOOKUP_BY_IDX(RTE_TAILQ_FBK_HASH, rte_fbk_hash_list)) == NULL) {
114 rte_errno = E_RTE_NO_TAILQ;
118 /* Error checking of parameters. */
119 if ((!rte_is_power_of_2(params->entries)) ||
120 (!rte_is_power_of_2(params->entries_per_bucket)) ||
121 (params->entries == 0) ||
122 (params->entries_per_bucket == 0) ||
123 (params->entries_per_bucket > params->entries) ||
124 (params->entries > RTE_FBK_HASH_ENTRIES_MAX) ||
125 (params->entries_per_bucket > RTE_FBK_HASH_ENTRIES_MAX)){
130 rte_snprintf(hash_name, sizeof(hash_name), "FBK_%s", params->name);
132 /* guarantee there's no existing */
133 TAILQ_FOREACH(ht, fbk_hash_list, next) {
134 if (strncmp(params->name, ht->name, RTE_FBK_HASH_NAMESIZE) == 0)
140 /* Allocate memory for table. */
141 ht = (struct rte_fbk_hash_table *)rte_malloc(hash_name, mem_size, 0);
144 memset(ht, 0, mem_size);
146 /* Set up hash table context. */
147 rte_snprintf(ht->name, sizeof(ht->name), "%s", params->name);
148 ht->entries = params->entries;
149 ht->entries_per_bucket = params->entries_per_bucket;
150 ht->used_entries = 0;
151 ht->bucket_mask = (params->entries / params->entries_per_bucket) - 1;
152 for (ht->bucket_shift = 0, i = 1;
153 (params->entries_per_bucket & i) == 0;
154 ht->bucket_shift++, i <<= 1)
155 ; /* empty loop body */
157 if (params->hash_func != NULL) {
158 ht->hash_func = params->hash_func;
159 ht->init_val = params->init_val;
162 ht->hash_func = RTE_FBK_HASH_FUNC_DEFAULT;
163 ht->init_val = RTE_FBK_HASH_INIT_VAL_DEFAULT;
166 TAILQ_INSERT_TAIL(fbk_hash_list, ht, next);
171 * Free all memory used by a hash table.
174 * Hash table to deallocate.
177 rte_fbk_hash_free(struct rte_fbk_hash_table *ht)
182 RTE_EAL_TAILQ_REMOVE(RTE_TAILQ_FBK_HASH, rte_fbk_hash_list, ht);