d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

hash: add more accurate thread-safety comments

Browse Source 
Describing the thread-safety support more accurately for
API documentation.

Fixes: f2e3001b53ec ("hash: support read/write concurrency")

Signed-off-by: Yipeng Wang <yipeng1.wang@intel.com>
Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
This commit is contained in:
Yipeng Wang 2018-07-26 10:56:01 -07:00 committed by Thomas Monjalon
parent f4ec5e5b5e
commit 8308d2ff5d
1 changed files with 39 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
lib/librte_hash/rte_hash.h
View File

@ -140,7 +140,9 @@ rte_hash_count(const struct rte_hash *h);
/**
* Add a key-value pair to an existing hash table.
* This operation is not multi-thread safe
* and should only be called from one thread.
* and should only be called from one thread by default.
* Thread safety can be enabled by setting flag during
* table creation.
*
* @param h
* Hash table to add the key to.
@ -160,7 +162,9 @@ rte_hash_add_key_data(const struct rte_hash *h, const void *key, void *data);
* Add a key-value pair with a pre-computed hash value
* to an existing hash table.
* This operation is not multi-thread safe
* and should only be called from one thread.
* and should only be called from one thread by default.
* Thread safety can be enabled by setting flag during
* table creation.
*
* @param h
* Hash table to add the key to.
@ -181,7 +185,9 @@ rte_hash_add_key_with_hash_data(const struct rte_hash *h, const void *key,
/**
* Add a key to an existing hash table. This operation is not multi-thread safe
* and should only be called from one thread.
* and should only be called from one thread by default.
* Thread safety can be enabled by setting flag during
* table creation.
*
* @param h
* Hash table to add the key to.
@ -199,7 +205,9 @@ rte_hash_add_key(const struct rte_hash *h, const void *key);
/**
* Add a key to an existing hash table.
* This operation is not multi-thread safe
* and should only be called from one thread.
* and should only be called from one thread by default.
* Thread safety can be enabled by setting flag during
* table creation.
*
* @param h
* Hash table to add the key to.
@ -219,7 +227,9 @@ rte_hash_add_key_with_hash(const struct rte_hash *h, const void *key, hash_sig_t
/**
* Remove a key from an existing hash table.
* This operation is not multi-thread safe
* and should only be called from one thread.
* and should only be called from one thread by default.
* Thread safety can be enabled by setting flag during
* table creation.
*
* @param h
* Hash table to remove the key from.
@ -238,7 +248,9 @@ rte_hash_del_key(const struct rte_hash *h, const void *key);
/**
* Remove a key from an existing hash table.
* This operation is not multi-thread safe
* and should only be called from one thread.
* and should only be called from one thread by default.
* Thread safety can be enabled by setting flag during
* table creation.
*
* @param h
* Hash table to remove the key from.
@ -258,7 +270,9 @@ rte_hash_del_key_with_hash(const struct rte_hash *h, const void *key, hash_sig_t
/**
* Find a key in the hash table given the position.
* This operation is multi-thread safe.
* This operation is multi-thread safe with regarding to other lookup threads.
* Read-write concurrency can be enabled by setting flag during
* table creation.
*
* @param h
* Hash table to get the key from.
@ -277,7 +291,9 @@ rte_hash_get_key_with_position(const struct rte_hash *h, const int32_t position,
/**
* Find a key-value pair in the hash table.
* This operation is multi-thread safe.
* This operation is multi-thread safe with regarding to other lookup threads.
* Read-write concurrency can be enabled by setting flag during
* table creation.
*
* @param h
* Hash table to look in.
@ -298,7 +314,9 @@ rte_hash_lookup_data(const struct rte_hash *h, const void *key, void **data);
/**
* Find a key-value pair with a pre-computed hash value
* to an existing hash table.
* This operation is multi-thread safe.
* This operation is multi-thread safe with regarding to other lookup threads.
* Read-write concurrency can be enabled by setting flag during
* table creation.
*
* @param h
* Hash table to look in.
@ -321,7 +339,9 @@ rte_hash_lookup_with_hash_data(const struct rte_hash *h, const void *key,
/**
* Find a key in the hash table.
* This operation is multi-thread safe.
* This operation is multi-thread safe with regarding to other lookup threads.
* Read-write concurrency can be enabled by setting flag during
* table creation.
*
* @param h
* Hash table to look in.
@ -339,7 +359,9 @@ rte_hash_lookup(const struct rte_hash *h, const void *key);
/**
* Find a key in the hash table.
* This operation is multi-thread safe.
* This operation is multi-thread safe with regarding to other lookup threads.
* Read-write concurrency can be enabled by setting flag during
* table creation.
*
* @param h
* Hash table to look in.
@ -374,7 +396,9 @@ rte_hash_hash(const struct rte_hash *h, const void *key);
/**
* Find multiple keys in the hash table.
* This operation is multi-thread safe.
* This operation is multi-thread safe with regarding to other lookup threads.
* Read-write concurrency can be enabled by setting flag during
* table creation.
*
* @param h
* Hash table to look in.
@ -395,7 +419,9 @@ rte_hash_lookup_bulk_data(const struct rte_hash *h, const void **keys,
/**
* Find multiple keys in the hash table.
* This operation is multi-thread safe.
* This operation is multi-thread safe with regarding to other lookup threads.
* Read-write concurrency can be enabled by setting flag during
* table creation.
*
* @param h
* Hash table to look in.