hash: fix doc about thread/process safety

[ upstream commit c96b55d ] 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: fc1f275 ("doc: programmers guide") Fixes: 48a3991 ("hash: replace with cuckoo hash implementation") 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>
kevintraynor · May 8, 2019 · f26ab68 · f26ab68
1 parent ca4728b
commit f26ab68
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git 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
@@ -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.