summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYipeng Wang <yipeng1.wang@intel.com>2019-04-29 02:40:16 -0700
committerThomas Monjalon <thomas@monjalon.net>2019-05-04 23:29:45 +0200
commitc96b55df8eea9223ec60f99974a95eb1c305aec5 (patch)
treef7306282408e13f1a275cf14843543aea33960ad
parent92b5ea41bb69c15220707a9f3954b6dc0058e956 (diff)
downloaddpdk-c96b55df8eea9223ec60f99974a95eb1c305aec5.zip
dpdk-c96b55df8eea9223ec60f99974a95eb1c305aec5.tar.gz
dpdk-c96b55df8eea9223ec60f99974a95eb1c305aec5.tar.xz
hash: fix doc about thread/process safety
rte_hash_hash is multi-thread safe but not multi-process safe because of the use of function pointers. Previous document and comment says the other way around. This commit fixes the issue. Fixes: fc1f2750a3ec ("doc: programmers guide") Fixes: 48a399119619 ("hash: replace with cuckoo hash implementation") Cc: stable@dpdk.org Reported-by: Andrey Nikolaev <gentoorion@gmail.com> Suggested-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Signed-off-by: Yipeng Wang <yipeng1.wang@intel.com> Acked-by: Dharmik Thakkar <dharmik.thakkar@arm.com> Acked-by: John McNamara <john.mcnamara@intel.com>
-rw-r--r--doc/guides/prog_guide/multi_proc_support.rst2
-rw-r--r--lib/librte_hash/rte_hash.h2
2 files changed, 2 insertions, 2 deletions
diff --git a/doc/guides/prog_guide/multi_proc_support.rst b/doc/guides/prog_guide/multi_proc_support.rst
index 6196d3f..f6f012d 100644
--- a/doc/guides/prog_guide/multi_proc_support.rst
+++ b/doc/guides/prog_guide/multi_proc_support.rst
@@ -176,7 +176,7 @@ Some of these are documented below:
* The use of function pointers between multiple processes running based of different compiled binaries is not supported,
since the location of a given function in one process may be different to its location in a second.
- This prevents the librte_hash library from behaving properly as in a multi-threaded instance,
+ This prevents the librte_hash library from behaving properly as in a multi-process instance,
since it uses a pointer to the hash function internally.
To work around this issue, it is recommended that multi-process applications perform the hash calculations by directly calling
diff --git a/lib/librte_hash/rte_hash.h b/lib/librte_hash/rte_hash.h
index e5970b4..4432aef 100644
--- a/lib/librte_hash/rte_hash.h
+++ b/lib/librte_hash/rte_hash.h
@@ -463,7 +463,7 @@ rte_hash_lookup_with_hash(const struct rte_hash *h,
/**
* Calc a hash value by key.
- * This operation is not multi-thread safe.
+ * This operation is not multi-process safe.
*
* @param h
* Hash table to look in.