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_tailq.h>
  44 #include <rte_eal.h>
  45 #include <rte_eal_memconfig.h>
  46 #include <rte_malloc.h>
  47 #include <rte_common.h>
  48 #include <rte_per_lcore.h>
  49 #include <rte_errno.h>
  50 #include <rte_string_fns.h>
  51 #include <rte_cpuflags.h>
  52 #include <rte_log.h>
  53 #include <rte_spinlock.h>
  54
  55 #include "rte_fbk_hash.h"
  56
  57 TAILQ_HEAD(rte_fbk_hash_list, rte_fbk_hash_table);
  58
  59 /**
  60  * Performs a lookup for an existing hash table, and returns a pointer to
  61  * the table if found.
  62  *
  63  * @param name
  64  *   Name of the hash table to find
  65  *
  66  * @return
  67  *   pointer to hash table structure or NULL on error.
  68  */
  69 struct rte_fbk_hash_table *
  70 rte_fbk_hash_find_existing(const char *name)
  71 {
  72         struct rte_fbk_hash_table *h;
  73         struct rte_fbk_hash_list *fbk_hash_list;
  74
  75         /* check that we have an initialised tail queue */
  76         if ((fbk_hash_list =
  77              RTE_TAILQ_LOOKUP_BY_IDX(RTE_TAILQ_FBK_HASH, rte_fbk_hash_list)) == NULL) {
  78                 rte_errno = E_RTE_NO_TAILQ;
  79                 return NULL;
  80         }
  81
  82         rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
  83         TAILQ_FOREACH(h, fbk_hash_list, next) {
  84                 if (strncmp(name, h->name, RTE_FBK_HASH_NAMESIZE) == 0)
  85                         break;
  86         }
  87         rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
  88         if (h == NULL)
  89                 rte_errno = ENOENT;
  90         return h;
  91 }
  92
  93 /**
  94  * Create a new hash table for use with four byte keys.
  95  *
  96  * @param params
  97  *   Parameters used in creation of hash table.
  98  *
  99  * @return
 100  *   Pointer to hash table structure that is used in future hash table
 101  *   operations, or NULL on error.
 102  */
 103 struct rte_fbk_hash_table *
 104 rte_fbk_hash_create(const struct rte_fbk_hash_params *params)
 105 {
 106         struct rte_fbk_hash_table *ht = NULL;
 107         char hash_name[RTE_FBK_HASH_NAMESIZE];
 108         const uint32_t mem_size =
 109                         sizeof(*ht) + (sizeof(ht->t[0]) * params->entries);
 110         uint32_t i;
 111         struct rte_fbk_hash_list *fbk_hash_list;
 112
 113         /* check that we have an initialised tail queue */
 114         if ((fbk_hash_list =
 115              RTE_TAILQ_LOOKUP_BY_IDX(RTE_TAILQ_FBK_HASH, rte_fbk_hash_list)) == NULL) {
 116                 rte_errno = E_RTE_NO_TAILQ;
 117                 return NULL;
 118         }
 119
 120         /* Error checking of parameters. */
 121         if ((!rte_is_power_of_2(params->entries)) ||
 122                         (!rte_is_power_of_2(params->entries_per_bucket)) ||
 123                         (params->entries == 0) ||
 124                         (params->entries_per_bucket == 0) ||
 125                         (params->entries_per_bucket > params->entries) ||
 126                         (params->entries > RTE_FBK_HASH_ENTRIES_MAX) ||
 127                         (params->entries_per_bucket > RTE_FBK_HASH_ENTRIES_PER_BUCKET_MAX)){
 128                 rte_errno = EINVAL;
 129                 return NULL;
 130         }
 131
 132         rte_snprintf(hash_name, sizeof(hash_name), "FBK_%s", params->name);
 133
 134         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
 135
 136         /* guarantee there's no existing */
 137         TAILQ_FOREACH(ht, fbk_hash_list, next) {
 138                 if (strncmp(params->name, ht->name, RTE_FBK_HASH_NAMESIZE) == 0)
 139                         break;
 140         }
 141         if (ht != NULL)
 142                 goto exit;
 143
 144         /* Allocate memory for table. */
 145         ht = (struct rte_fbk_hash_table *)rte_malloc_socket(hash_name, mem_size,
 146                         0, params->socket_id);
 147         if (ht == NULL)
 148                 goto exit;
 149
 150         memset(ht, 0, mem_size);
 151
 152         /* Set up hash table context. */
 153         rte_snprintf(ht->name, sizeof(ht->name), "%s", params->name);
 154         ht->entries = params->entries;
 155         ht->entries_per_bucket = params->entries_per_bucket;
 156         ht->used_entries = 0;
 157         ht->bucket_mask = (params->entries / params->entries_per_bucket) - 1;
 158         for (ht->bucket_shift = 0, i = 1;
 159             (params->entries_per_bucket & i) == 0;
 160             ht->bucket_shift++, i <<= 1)
 161                 ; /* empty loop body */
 162
 163         if (params->hash_func != NULL) {
 164                 ht->hash_func = params->hash_func;
 165                 ht->init_val = params->init_val;
 166         }
 167         else {
 168                 ht->hash_func = RTE_FBK_HASH_FUNC_DEFAULT;
 169                 ht->init_val = RTE_FBK_HASH_INIT_VAL_DEFAULT;
 170         }
 171
 172         TAILQ_INSERT_TAIL(fbk_hash_list, ht, next);
 173
 174 exit:
 175         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 176
 177         return ht;
 178 }
 179
 180 /**
 181  * Free all memory used by a hash table.
 182  *
 183  * @param ht
 184  *   Hash table to deallocate.
 185  */
 186 void
 187 rte_fbk_hash_free(struct rte_fbk_hash_table *ht)
 188 {
 189         if (ht == NULL)
 190                 return;
 191
 192         RTE_EAL_TAILQ_REMOVE(RTE_TAILQ_FBK_HASH, rte_fbk_hash_list, ht);
 193         rte_free(ht);
 194 }
 195