X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_hash%2Frte_fbk_hash.h;h=c39c097651c414230d09e3e6817b48a667ac55b8;hb=4ad5b94e0d13771a48cdf395d0c8b26e5f8cbe91;hp=48c90c72227b7d70b0cd358974d5f671bb9dffe6;hpb=dada9ef6edc59015b6674b5a95258787c71401b0;p=dpdk.git diff --git a/lib/librte_hash/rte_fbk_hash.h b/lib/librte_hash/rte_fbk_hash.h index 48c90c7222..c39c097651 100644 --- a/lib/librte_hash/rte_fbk_hash.h +++ b/lib/librte_hash/rte_fbk_hash.h @@ -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 #include #include -#include #ifdef __cplusplus extern "C" { @@ -57,8 +55,14 @@ extern "C" { #include #ifndef RTE_FBK_HASH_FUNC_DEFAULT +#if defined(RTE_ARCH_X86) || defined(RTE_MACHINE_CPUFLAG_CRC32) +#include /** Default four-byte key hash function if none is specified. */ #define RTE_FBK_HASH_FUNC_DEFAULT rte_hash_crc_4byte +#else +#include +#define RTE_FBK_HASH_FUNC_DEFAULT rte_jhash_1word +#endif #endif #ifndef RTE_FBK_HASH_INIT_VAL_DEFAULT @@ -96,14 +100,11 @@ 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. */ -} ; - +}; /** The four-byte key hash table structure. */ struct rte_fbk_hash_table { - TAILQ_ENTRY(rte_fbk_hash_table) next; /**< Linked list. */ - char name[RTE_FBK_HASH_NAMESIZE]; /**< Name of the hash. */ uint32_t entries; /**< Total number of entries. */ uint32_t entries_per_bucket; /**< Number of entries in a bucket. */ @@ -114,7 +115,7 @@ struct rte_fbk_hash_table { uint32_t init_val; /**< For initialising hash function. */ /** A flat table of all buckets. */ - union rte_fbk_hash_entry t[0]; + union rte_fbk_hash_entry t[]; }; /** @@ -134,9 +135,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 +146,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 +164,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 +180,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 +251,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 +301,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. @@ -308,7 +372,6 @@ struct rte_fbk_hash_table *rte_fbk_hash_find_existing(const char *name); * Possible rte_errno error values include: * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure * - E_RTE_SECONDARY - function was called from a secondary process instance - * - E_RTE_NO_TAILQ - no tailq list could be got for the fbk hash table list * - EINVAL - invalid parameter value passed to function * - ENOSPC - the maximum number of memzones has already been allocated * - EEXIST - a memzone with the same name already exists