lib/librte_hash/rte_fbk_hash.c

   1 /**
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 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
  34 #include <stdint.h>
  35 #include <stdio.h>
  36 #include <stdarg.h>
  37 #include <string.h>
  38 #include <errno.h>
  39
  40 #include <sys/queue.h>
  41 #include <rte_memory.h>
  42 #include <rte_memzone.h>
  43 #include <rte_eal.h>
  44 #include <rte_eal_memconfig.h>
  45 #include <rte_malloc.h>
  46 #include <rte_common.h>
  47 #include <rte_per_lcore.h>
  48 #include <rte_errno.h>
  49 #include <rte_string_fns.h>
  50 #include <rte_cpuflags.h>
  51 #include <rte_log.h>
  52 #include <rte_spinlock.h>
  53
  54 #include "rte_fbk_hash.h"
  55
  56 TAILQ_HEAD(rte_fbk_hash_list, rte_tailq_entry);
  57
  58 static struct rte_tailq_elem rte_fbk_hash_tailq = {
  59         .name = "RTE_FBK_HASH",
  60 };
  61 EAL_REGISTER_TAILQ(rte_fbk_hash_tailq)
  62
  63 /**
  64  * Performs a lookup for an existing hash table, and returns a pointer to
  65  * the table if found.
  66  *
  67  * @param name
  68  *   Name of the hash table to find
  69  *
  70  * @return
  71  *   pointer to hash table structure or NULL on error.
  72  */
  73 struct rte_fbk_hash_table *
  74 rte_fbk_hash_find_existing(const char *name)
  75 {
  76         struct rte_fbk_hash_table *h = NULL;
  77         struct rte_tailq_entry *te;
  78         struct rte_fbk_hash_list *fbk_hash_list;
  79
  80         fbk_hash_list = RTE_TAILQ_CAST(rte_fbk_hash_tailq.head,
  81                                        rte_fbk_hash_list);
  82
  83         rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
  84         TAILQ_FOREACH(te, fbk_hash_list, next) {
  85                 h = (struct rte_fbk_hash_table *) te->data;
  86                 if (strncmp(name, h->name, RTE_FBK_HASH_NAMESIZE) == 0)
  87                         break;
  88         }
  89         rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
  90         if (te == NULL) {
  91                 rte_errno = ENOENT;
  92                 return NULL;
  93         }
  94         return h;
  95 }
  96
  97 /**
  98  * Create a new hash table for use with four byte keys.
  99  *
 100  * @param params
 101  *   Parameters used in creation of hash table.
 102  *
 103  * @return
 104  *   Pointer to hash table structure that is used in future hash table
 105  *   operations, or NULL on error.
 106  */
 107 struct rte_fbk_hash_table *
 108 rte_fbk_hash_create(const struct rte_fbk_hash_params *params)
 109 {
 110         struct rte_fbk_hash_table *ht = NULL;
 111         struct rte_tailq_entry *te;
 112         char hash_name[RTE_FBK_HASH_NAMESIZE];
 113         const uint32_t mem_size =
 114                         sizeof(*ht) + (sizeof(ht->t[0]) * params->entries);
 115         uint32_t i;
 116         struct rte_fbk_hash_list *fbk_hash_list;
 117
 118         fbk_hash_list = RTE_TAILQ_CAST(rte_fbk_hash_tailq.head,
 119                                        rte_fbk_hash_list);
 120
 121         /* Error checking of parameters. */
 122         if ((!rte_is_power_of_2(params->entries)) ||
 123                         (!rte_is_power_of_2(params->entries_per_bucket)) ||
 124                         (params->entries == 0) ||
 125                         (params->entries_per_bucket == 0) ||
 126                         (params->entries_per_bucket > params->entries) ||
 127                         (params->entries > RTE_FBK_HASH_ENTRIES_MAX) ||
 128                         (params->entries_per_bucket > RTE_FBK_HASH_ENTRIES_PER_BUCKET_MAX)){
 129                 rte_errno = EINVAL;
 130                 return NULL;
 131         }
 132
 133         snprintf(hash_name, sizeof(hash_name), "FBK_%s", params->name);
 134
 135         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
 136
 137         /* guarantee there's no existing */
 138         TAILQ_FOREACH(te, fbk_hash_list, next) {
 139                 ht = (struct rte_fbk_hash_table *) te->data;
 140                 if (strncmp(params->name, ht->name, RTE_FBK_HASH_NAMESIZE) == 0)
 141                         break;
 142         }
 143         if (te != NULL)
 144                 goto exit;
 145
 146         te = rte_zmalloc("FBK_HASH_TAILQ_ENTRY", sizeof(*te), 0);
 147         if (te == NULL) {
 148                 RTE_LOG(ERR, HASH, "Failed to allocate tailq entry\n");
 149                 goto exit;
 150         }
 151
 152         /* Allocate memory for table. */
 153         ht = (struct rte_fbk_hash_table *)rte_zmalloc_socket(hash_name, mem_size,
 154                         0, params->socket_id);
 155         if (ht == NULL) {
 156                 RTE_LOG(ERR, HASH, "Failed to allocate fbk hash table\n");
 157                 rte_free(te);
 158                 goto exit;
 159         }
 160
 161         /* Set up hash table context. */
 162         snprintf(ht->name, sizeof(ht->name), "%s", params->name);
 163         ht->entries = params->entries;
 164         ht->entries_per_bucket = params->entries_per_bucket;
 165         ht->used_entries = 0;
 166         ht->bucket_mask = (params->entries / params->entries_per_bucket) - 1;
 167         for (ht->bucket_shift = 0, i = 1;
 168             (params->entries_per_bucket & i) == 0;
 169             ht->bucket_shift++, i <<= 1)
 170                 ; /* empty loop body */
 171
 172         if (params->hash_func != NULL) {
 173                 ht->hash_func = params->hash_func;
 174                 ht->init_val = params->init_val;
 175         }
 176         else {
 177                 ht->hash_func = RTE_FBK_HASH_FUNC_DEFAULT;
 178                 ht->init_val = RTE_FBK_HASH_INIT_VAL_DEFAULT;
 179         }
 180
 181         te->data = (void *) ht;
 182
 183         TAILQ_INSERT_TAIL(fbk_hash_list, te, next);
 184
 185 exit:
 186         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 187
 188         return ht;
 189 }
 190
 191 /**
 192  * Free all memory used by a hash table.
 193  *
 194  * @param ht
 195  *   Hash table to deallocate.
 196  */
 197 void
 198 rte_fbk_hash_free(struct rte_fbk_hash_table *ht)
 199 {
 200         struct rte_tailq_entry *te;
 201         struct rte_fbk_hash_list *fbk_hash_list;
 202
 203         if (ht == NULL)
 204                 return;
 205
 206         fbk_hash_list = RTE_TAILQ_CAST(rte_fbk_hash_tailq.head,
 207                                        rte_fbk_hash_list);
 208
 209         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
 210
 211         /* find out tailq entry */
 212         TAILQ_FOREACH(te, fbk_hash_list, next) {
 213                 if (te->data == (void *) ht)
 214                         break;
 215         }
 216
 217         if (te == NULL) {
 218                 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 219                 return;
 220         }
 221
 222         TAILQ_REMOVE(fbk_hash_list, te, next);
 223
 224         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 225
 226         rte_free(ht);
 227         rte_free(te);
 228 }
 229