doc: whitespace changes in licenses
[dpdk.git] / lib / librte_hash / rte_hash.c
index 76cba41..0327822 100644 (file)
@@ -1,36 +1,34 @@
 /*-
  *   BSD LICENSE
  * 
- *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
+ *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
  *   All rights reserved.
  * 
- *   Redistribution and use in source and binary forms, with or without 
- *   modification, are permitted provided that the following conditions 
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions
  *   are met:
  * 
- *     * Redistributions of source code must retain the above copyright 
+ *     * Redistributions of source code must retain the above copyright
  *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright 
- *       notice, this list of conditions and the following disclaimer in 
- *       the documentation and/or other materials provided with the 
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in
+ *       the documentation and/or other materials provided with the
  *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its 
- *       contributors may be used to endorse or promote products derived 
+ *     * Neither the name of Intel Corporation nor the names of its
+ *       contributors may be used to endorse or promote products derived
  *       from this software without specific prior written permission.
  * 
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- * 
- *  version: DPDK.L.1.2.3-3
  */
 
 #include <string.h>
 #include <rte_malloc.h>
 #include <rte_tailq.h>
 #include <rte_eal.h>
+#include <rte_eal_memconfig.h>
 #include <rte_per_lcore.h>
 #include <rte_errno.h>
 #include <rte_string_fns.h>
 #include <rte_cpuflags.h>
 #include <rte_log.h>
+#include <rte_rwlock.h>
+#include <rte_spinlock.h>
 
 #include "rte_hash.h"
-#include "rte_jhash.h"
-#include "rte_hash_crc.h"
 
 
 TAILQ_HEAD(rte_hash_list, rte_hash);
 
-/* global list of hashes (used for debug/dump) */
-static struct rte_hash_list *hash_list;
-
-/* macro to prevent duplication of list creation check code */
-#define CHECK_HASH_LIST_CREATED() do { \
-       if (hash_list == NULL) \
-               if ((hash_list = RTE_TAILQ_RESERVE("RTE_HASH", rte_hash_list)) == NULL){ \
-                       rte_errno = E_RTE_NO_TAILQ; \
-                       return NULL; \
-               } \
-} while (0)
-
 /* Macro to enable/disable run-time checking of function parameters */
 #if defined(RTE_LIBRTE_HASH_DEBUG)
 #define RETURN_IF_TRUE(cond, retval) do { \
@@ -85,7 +72,13 @@ static struct rte_hash_list *hash_list;
 #endif
 
 /* Hash function used if none is specified */
+#ifdef RTE_MACHINE_CPUFLAG_SSE4_2
+#include <rte_hash_crc.h>
 #define DEFAULT_HASH_FUNC       rte_hash_crc
+#else
+#include <rte_jhash.h>
+#define DEFAULT_HASH_FUNC       rte_jhash
+#endif
 
 /* Signature bucket size is a multiple of this value */
 #define SIG_BUCKET_ALIGNMENT    16
@@ -149,14 +142,21 @@ struct rte_hash *
 rte_hash_find_existing(const char *name)
 {
        struct rte_hash *h;
+       struct rte_hash_list *hash_list;
 
        /* check that we have an initialised tail queue */
-       CHECK_HASH_LIST_CREATED();
+       if ((hash_list = RTE_TAILQ_LOOKUP_BY_IDX(RTE_TAILQ_HASH, rte_hash_list)) == NULL) {
+               rte_errno = E_RTE_NO_TAILQ;
+               return NULL;
+       }
 
+       rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
        TAILQ_FOREACH(h, hash_list, next) {
                if (strncmp(name, h->name, RTE_HASH_NAMESIZE) == 0)
                        break;
        }
+       rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
+
        if (h == NULL)
                rte_errno = ENOENT;
        return h;
@@ -169,14 +169,14 @@ rte_hash_create(const struct rte_hash_parameters *params)
        uint32_t num_buckets, sig_bucket_size, key_size,
                hash_tbl_size, sig_tbl_size, key_tbl_size, mem_size;
        char hash_name[RTE_HASH_NAMESIZE];
-
-       if (rte_eal_process_type() == RTE_PROC_SECONDARY){
-               rte_errno = E_RTE_SECONDARY;
-               return NULL;
-       }
+       struct rte_hash_list *hash_list;
 
        /* check that we have an initialised tail queue */
-       CHECK_HASH_LIST_CREATED();
+       if ((hash_list = 
+            RTE_TAILQ_LOOKUP_BY_IDX(RTE_TAILQ_HASH, rte_hash_list)) == NULL) {
+               rte_errno = E_RTE_NO_TAILQ;
+               return NULL;    
+       }
 
        /* Check for valid parameters */
        if ((params == NULL) ||
@@ -205,28 +205,26 @@ rte_hash_create(const struct rte_hash_parameters *params)
                                  CACHE_LINE_SIZE);
        key_tbl_size = align_size(num_buckets * key_size *
                                  params->bucket_entries, CACHE_LINE_SIZE);
-
+       
        /* Total memory required for hash context */
        mem_size = hash_tbl_size + sig_tbl_size + key_tbl_size;
 
-       /* Allocate as a memzone, or in normal memory space */
-#if defined(RTE_LIBRTE_HASH_USE_MEMZONE)
-       const struct rte_memzone *mz;
-       mz = rte_memzone_reserve(hash_name, mem_size, params->socket_id, 0);
-       if (mz == NULL) {
-               RTE_LOG(ERR, HASH, "memzone reservation failed\n");
-               return NULL;
+       rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
+
+       /* guarantee there's no existing */
+       TAILQ_FOREACH(h, hash_list, next) {
+               if (strncmp(params->name, h->name, RTE_HASH_NAMESIZE) == 0)
+                       break;
        }
-       memset(mz->addr, 0, mem_size);
-       h = (struct rte_hash *)mz->addr;
-#else
-       h = (struct rte_hash *)rte_zmalloc(hash_name, mem_size,
-                                          CACHE_LINE_SIZE);
+       if (h != NULL)
+               goto exit;
+
+       h = (struct rte_hash *)rte_zmalloc_socket(hash_name, mem_size,
+                                          CACHE_LINE_SIZE, params->socket_id);
        if (h == NULL) {
                RTE_LOG(ERR, HASH, "memory allocation failed\n");
-               return NULL;
+               goto exit;
        }
-#endif
 
        /* Setup hash context */
        rte_snprintf(h->name, sizeof(h->name), "%s", params->name);
@@ -244,15 +242,11 @@ rte_hash_create(const struct rte_hash_parameters *params)
        h->hash_func = (params->hash_func == NULL) ?
                DEFAULT_HASH_FUNC : params->hash_func;
 
-       if (h->hash_func == rte_hash_crc &&
-                       !rte_cpu_get_flag_enabled(RTE_CPUFLAG_SSE4_2)) {
-               RTE_LOG(WARNING, HASH, "CRC32 instruction requires SSE4.2, "
-                               "which is not supported on this system. "
-                               "Falling back to software hash\n.");
-               h->hash_func = rte_jhash;
-       }
-
        TAILQ_INSERT_TAIL(hash_list, h, next);
+
+exit:
+       rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
+
        return h;
 }
 
@@ -261,26 +255,22 @@ rte_hash_free(struct rte_hash *h)
 {
        if (h == NULL)
                return;
-#if !defined(RTE_LIBRTE_HASH_USE_MEMZONE)
-       TAILQ_REMOVE(hash_list, h, next);
+
+       RTE_EAL_TAILQ_REMOVE(RTE_TAILQ_HASH, rte_hash_list, h);
        rte_free(h);
-#endif
-       /* No way to deallocate memzones */
-       return;
 }
 
-int32_t
-rte_hash_add_key(const struct rte_hash *h, const void *key)
+static inline int32_t
+__rte_hash_add_key_with_hash(const struct rte_hash *h, 
+                               const void *key, hash_sig_t sig)
 {
-       hash_sig_t sig, *sig_bucket;
+       hash_sig_t *sig_bucket;
        uint8_t *key_bucket;
        uint32_t bucket_index, i;
        int32_t pos;
 
-       RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
-
        /* Get the hash signature and bucket index */
-       sig = h->hash_func(key, h->key_len, h->hash_func_init_val) | h->sig_msb;
+       sig |= h->sig_msb;
        bucket_index = sig & h->bucket_bitmask;
        sig_bucket = get_sig_tbl_bucket(h, bucket_index);
        key_bucket = get_key_tbl_bucket(h, bucket_index);
@@ -307,16 +297,30 @@ rte_hash_add_key(const struct rte_hash *h, const void *key)
 }
 
 int32_t
-rte_hash_del_key(const struct rte_hash *h, const void *key)
+rte_hash_add_key_with_hash(const struct rte_hash *h, 
+                               const void *key, hash_sig_t sig)
 {
-       hash_sig_t sig, *sig_bucket;
-       uint8_t *key_bucket;
-       uint32_t bucket_index, i;
+       RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
+       return __rte_hash_add_key_with_hash(h, key, sig);
+}
 
+int32_t
+rte_hash_add_key(const struct rte_hash *h, const void *key)
+{
        RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
+       return __rte_hash_add_key_with_hash(h, key, rte_hash_hash(h, key));
+}
+
+static inline int32_t
+__rte_hash_del_key_with_hash(const struct rte_hash *h, 
+                               const void *key, hash_sig_t sig)
+{
+       hash_sig_t *sig_bucket;
+       uint8_t *key_bucket;
+       uint32_t bucket_index, i;
 
        /* Get the hash signature and bucket index */
-       sig = h->hash_func(key, h->key_len, h->hash_func_init_val) | h->sig_msb;
+       sig = sig | h->sig_msb;
        bucket_index = sig & h->bucket_bitmask;
        sig_bucket = get_sig_tbl_bucket(h, bucket_index);
        key_bucket = get_key_tbl_bucket(h, bucket_index);
@@ -335,16 +339,30 @@ rte_hash_del_key(const struct rte_hash *h, const void *key)
 }
 
 int32_t
-rte_hash_lookup(const struct rte_hash *h, const void *key)
+rte_hash_del_key_with_hash(const struct rte_hash *h, 
+                               const void *key, hash_sig_t sig)
 {
-       hash_sig_t sig, *sig_bucket;
-       uint8_t *key_bucket;
-       uint32_t bucket_index, i;
+       RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
+       return __rte_hash_del_key_with_hash(h, key, sig);
+}
 
+int32_t
+rte_hash_del_key(const struct rte_hash *h, const void *key)
+{
        RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
+       return __rte_hash_del_key_with_hash(h, key, rte_hash_hash(h, key));
+}
+
+static inline int32_t
+__rte_hash_lookup_with_hash(const struct rte_hash *h, 
+                       const void *key, hash_sig_t sig)
+{
+       hash_sig_t *sig_bucket;
+       uint8_t *key_bucket;
+       uint32_t bucket_index, i;
 
        /* Get the hash signature and bucket index */
-       sig = h->hash_func(key, h->key_len, h->hash_func_init_val) | h->sig_msb;
+       sig |= h->sig_msb;
        bucket_index = sig & h->bucket_bitmask;
        sig_bucket = get_sig_tbl_bucket(h, bucket_index);
        key_bucket = get_key_tbl_bucket(h, bucket_index);
@@ -361,15 +379,30 @@ rte_hash_lookup(const struct rte_hash *h, const void *key)
        return -ENOENT;
 }
 
+int32_t
+rte_hash_lookup_with_hash(const struct rte_hash *h, 
+                       const void *key, hash_sig_t sig)
+{
+       RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
+       return __rte_hash_lookup_with_hash(h, key, sig);
+}
+
+int32_t
+rte_hash_lookup(const struct rte_hash *h, const void *key)
+{
+       RETURN_IF_TRUE(((h == NULL) || (key == NULL)), -EINVAL);
+       return __rte_hash_lookup_with_hash(h, key, rte_hash_hash(h, key));
+}
+
 int
-rte_hash_lookup_multi(const struct rte_hash *h, const void **keys,
+rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
                      uint32_t num_keys, int32_t *positions)
 {
        uint32_t i, j, bucket_index;
-       hash_sig_t sigs[RTE_HASH_LOOKUP_MULTI_MAX];
+       hash_sig_t sigs[RTE_HASH_LOOKUP_BULK_MAX];
 
        RETURN_IF_TRUE(((h == NULL) || (keys == NULL) || (num_keys == 0) ||
-                       (num_keys > RTE_HASH_LOOKUP_MULTI_MAX) ||
+                       (num_keys > RTE_HASH_LOOKUP_BULK_MAX) ||
                        (positions == NULL)), -EINVAL);
 
        /* Get the hash signature and bucket index */