update Intel copyright years to 2014
[dpdk.git] / lib / librte_hash / rte_fbk_hash.h
index 48c90c7..ac3a604 100644 (file)
@@ -1,35 +1,34 @@
 /*-
  *   BSD LICENSE
  * 
- *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
+ *   Copyright(c) 2010-2014 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.
- * 
  */
 
 #ifndef _RTE_FBK_HASH_H_
@@ -48,7 +47,6 @@
 #include <stdint.h>
 #include <errno.h>
 #include <sys/queue.h>
-#include <rte_hash_crc.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -57,8 +55,14 @@ extern "C" {
 #include <string.h>
 
 #ifndef RTE_FBK_HASH_FUNC_DEFAULT
+#ifdef RTE_MACHINE_CPUFLAG_SSE4_2
+#include <rte_hash_crc.h>
 /** Default four-byte key hash function if none is specified. */
 #define RTE_FBK_HASH_FUNC_DEFAULT              rte_hash_crc_4byte
+#else
+#include <rte_jhash.h>
+#define RTE_FBK_HASH_FUNC_DEFAULT              rte_jhash_1word
+#endif
 #endif
 
 #ifndef RTE_FBK_HASH_INIT_VAL_DEFAULT
@@ -96,7 +100,7 @@ union rte_fbk_hash_entry {
                uint16_t value;         /**< Value returned by lookup. */
                uint32_t key;           /**< Key used to find value. */
        } entry;                        /**< For accessing each entry part. */
-} ;
+};
 
 
 
@@ -134,9 +138,9 @@ rte_fbk_hash_get_bucket(const struct rte_fbk_hash_table *ht, uint32_t key)
                        ht->bucket_shift;
 }
 
-
 /**
- * Add a key to an existing hash table. This operation is not multi-thread safe
+ * Add a key to an existing hash table with bucket id. 
+ * This operation is not multi-thread safe
  * and should only be called from one thread.
  *
  * @param ht
@@ -145,12 +149,14 @@ rte_fbk_hash_get_bucket(const struct rte_fbk_hash_table *ht, uint32_t key)
  *   Key to add to the hash table.
  * @param value
  *   Value to associate with key.
+ * @param bucket
+ *   Bucket to associate with key.
  * @return
  *   0 if ok, or negative value on error.
  */
 static inline int
-rte_fbk_hash_add_key(struct rte_fbk_hash_table *ht,
-                       uint32_t key, uint16_t value)
+rte_fbk_hash_add_key_with_bucket(struct rte_fbk_hash_table *ht,
+                       uint32_t key, uint16_t value, uint32_t bucket)
 {
        /*
         * The writing of a new value to the hash table is done as a single
@@ -161,7 +167,6 @@ rte_fbk_hash_add_key(struct rte_fbk_hash_table *ht,
        const uint64_t new_entry = ((uint64_t)(key) << 32) |
                        ((uint64_t)(value) << 16) |
                        1;  /* 1 = is_entry bit. */
-       const uint32_t bucket = rte_fbk_hash_get_bucket(ht, key);
        uint32_t i;
 
        for (i = 0; i < ht->entries_per_bucket; i++) {
@@ -178,24 +183,48 @@ rte_fbk_hash_add_key(struct rte_fbk_hash_table *ht,
                }
        }
 
-       return -ENOSPC; /* No space in bucket. */
+       return -ENOSPC; /* No space in bucket. */       
 }
 
 /**
- * Remove a key from an existing hash table. This operation is not multi-thread
+ * Add a key to an existing hash table. This operation is not multi-thread safe
+ * and should only be called from one thread.
+ *
+ * @param ht
+ *   Hash table to add the key to.
+ * @param key
+ *   Key to add to the hash table.
+ * @param value
+ *   Value to associate with key.
+ * @return
+ *   0 if ok, or negative value on error.
+ */
+static inline int
+rte_fbk_hash_add_key(struct rte_fbk_hash_table *ht,
+                       uint32_t key, uint16_t value)
+{
+       return rte_fbk_hash_add_key_with_bucket(ht, 
+                               key, value, rte_fbk_hash_get_bucket(ht, key));
+}
+
+/**
+ * Remove a key with a given bucket id from an existing hash table. 
+ * This operation is not multi-thread
  * safe and should only be called from one thread.
  *
  * @param ht
  *   Hash table to remove the key from.
  * @param key
  *   Key to remove from the hash table.
+ * @param bucket
+ *   Bucket id associate with key.
  * @return
  *   0 if ok, or negative value on error.
  */
 static inline int
-rte_fbk_hash_delete_key(struct rte_fbk_hash_table *ht, uint32_t key)
+rte_fbk_hash_delete_key_with_bucket(struct rte_fbk_hash_table *ht, 
+                                       uint32_t key, uint32_t bucket)
 {
-       const uint32_t bucket = rte_fbk_hash_get_bucket(ht, key);
        uint32_t last_entry = ht->entries_per_bucket - 1;
        uint32_t i, j;
 
@@ -225,19 +254,40 @@ rte_fbk_hash_delete_key(struct rte_fbk_hash_table *ht, uint32_t key)
 }
 
 /**
- * Find a key in the hash table. This operation is multi-thread safe.
+ * Remove a key from an existing hash table. This operation is not multi-thread
+ * safe and should only be called from one thread.
+ *
+ * @param ht
+ *   Hash table to remove the key from.
+ * @param key
+ *   Key to remove from the hash table.
+ * @return
+ *   0 if ok, or negative value on error.
+ */
+static inline int
+rte_fbk_hash_delete_key(struct rte_fbk_hash_table *ht, uint32_t key)
+{
+       return rte_fbk_hash_delete_key_with_bucket(ht, 
+                               key, rte_fbk_hash_get_bucket(ht, key));
+}
+
+/**
+ * Find a key in the hash table with a given bucketid. 
+ * This operation is multi-thread safe.
  *
  * @param ht
  *   Hash table to look in.
  * @param key
  *   Key to find.
+ * @param bucket
+ *   Bucket associate to the key.
  * @return
  *   The value that was associated with the key, or negative value on error.
  */
 static inline int
-rte_fbk_hash_lookup(const struct rte_fbk_hash_table *ht, uint32_t key)
+rte_fbk_hash_lookup_with_bucket(const struct rte_fbk_hash_table *ht, 
+                               uint32_t key, uint32_t bucket)
 {
-       const uint32_t bucket = rte_fbk_hash_get_bucket(ht, key);
        union rte_fbk_hash_entry current_entry;
        uint32_t i;
 
@@ -254,6 +304,23 @@ rte_fbk_hash_lookup(const struct rte_fbk_hash_table *ht, uint32_t key)
        return -ENOENT; /* Key didn't exist. */
 }
 
+/**
+ * Find a key in the hash table. This operation is multi-thread safe.
+ *
+ * @param ht
+ *   Hash table to look in.
+ * @param key
+ *   Key to find.
+ * @return
+ *   The value that was associated with the key, or negative value on error.
+ */
+static inline int
+rte_fbk_hash_lookup(const struct rte_fbk_hash_table *ht, uint32_t key)
+{
+       return rte_fbk_hash_lookup_with_bucket(ht,
+                               key, rte_fbk_hash_get_bucket(ht, key));
+}
+
 /**
  * Delete all entries in a hash table. This operation is not multi-thread
  * safe and should only be called from one thread.