[v2,4/4] doc/hash: deprecate lock ellision and read/write concurreny flags

Message ID 20181101232522.702-5-honnappa.nagarahalli@arm.com
State New
Headers show
Series
  • hash: deprecate lock ellision and read/write concurreny flags
Related show

Commit Message

Honnappa Nagarahalli Nov. 1, 2018, 11:25 p.m.
RTE_HASH_EXTRA_FLAGS_RW_CONCURRENCY and
RTE_HASH_EXTRA_FLAGS_TRANS_MEM_SUPPORT configuration flags are
deprecated. Reader/Writer concurrency is provided by default.
Transactional memory will be used if the platform supports it.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Reviewed-by: Dharmik Thakkar <dharmik.thakkar@arm.com>

Reviewed-by: Gavin Hu <gavin.hu@arm.com>

---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 1 file changed, 5 insertions(+)

-- 
2.17.1

Comments

Bruce Richardson Nov. 2, 2018, 11:21 a.m. | #1
On Thu, Nov 01, 2018 at 06:25:22PM -0500, Honnappa Nagarahalli wrote:
> RTE_HASH_EXTRA_FLAGS_RW_CONCURRENCY and

> RTE_HASH_EXTRA_FLAGS_TRANS_MEM_SUPPORT configuration flags are

> deprecated. Reader/Writer concurrency is provided by default.

> Transactional memory will be used if the platform supports it.

> 

> Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

> Reviewed-by: Dharmik Thakkar <dharmik.thakkar@arm.com>

> Reviewed-by: Gavin Hu <gavin.hu@arm.com>

> ---

>  doc/guides/rel_notes/deprecation.rst | 5 +++++

>  1 file changed, 5 insertions(+)

> 

> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst

> index 34b28234c..d34cca260 100644

> --- a/doc/guides/rel_notes/deprecation.rst

> +++ b/doc/guides/rel_notes/deprecation.rst

> @@ -55,3 +55,8 @@ Deprecation Notices

>    - ``rte_pdump_set_socket_dir`` will be removed;

>    - The parameter, ``path``, of ``rte_pdump_init`` will be removed;

>    - The enum ``rte_pdump_socktype`` will be removed.

> +

> +* hash: The configuration flags RTE_HASH_EXTRA_FLAGS_RW_CONCURRENCY and

> +  RTE_HASH_EXTRA_FLAGS_TRANS_MEM_SUPPORT will be removed in v19.02.

> +  Reader/writer concurrency will be supported by default. The library will

> +  use transactional memory if the platform supports it.

> -- 

I think we need more documentation than this. The programmers guide also
needs an update (probably in patch 2) to record the changes in the flags
used on hash create.

/Bruce

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 34b28234c..d34cca260 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -55,3 +55,8 @@  Deprecation Notices
   - ``rte_pdump_set_socket_dir`` will be removed;
   - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
   - The enum ``rte_pdump_socktype`` will be removed.
+
+* hash: The configuration flags RTE_HASH_EXTRA_FLAGS_RW_CONCURRENCY and
+  RTE_HASH_EXTRA_FLAGS_TRANS_MEM_SUPPORT will be removed in v19.02.
+  Reader/writer concurrency will be supported by default. The library will
+  use transactional memory if the platform supports it.