diff mbox

[dpdk-dev,v2] doc: announce removal of indirect mbuf check macro

Message ID 20180525012006.29856-1-yskoh@mellanox.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Yongseok Koh May 25, 2018, 1:20 a.m. UTC 
  Link: http://dpdk.org/ml/archives/dev/2018-April/099476.html

Signed-off-by: Yongseok Koh <yskoh@mellanox.com>
---

v2:
* modify removal deadline and add more comments in the deprecation note
* mark deprecation on the comment of the macro in rte_mbuf.h

 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 lib/librte_mbuf/rte_mbuf.h           | 3 ++-
 2 files changed, 9 insertions(+), 1 deletion(-)

Comments

Andrew Rybchenko May 25, 2018, 6:34 a.m. UTC | #1 
On 05/25/2018 04:20 AM, Yongseok Koh wrote:
> Link: http://dpdk.org/ml/archives/dev/2018-April/099476.html
>
> Signed-off-by: Yongseok Koh <yskoh@mellanox.com>
> ---
>
> v2:
> * modify removal deadline and add more comments in the deprecation note
> * mark deprecation on the comment of the macro in rte_mbuf.h
>
>   doc/guides/rel_notes/deprecation.rst | 7 +++++++
>   lib/librte_mbuf/rte_mbuf.h           | 3 ++-
>   2 files changed, 9 insertions(+), 1 deletion(-)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 1e2443c76..e1630c2cf 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -42,6 +42,13 @@ Deprecation Notices
>     is defined in librte_sched in a non-generic way. The new generic format
>     will contain: queue ID, traffic class, color. Field size will not change.
>   
> +* mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and
> +  replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As
> +  ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()``
> +  can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the new
> +  experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro
> +  is to fix this semantic inconsistency.
> +
>   * ethdev: a new Tx and Rx offload API was introduced on 17.11.
>     In the new API, offloads are divided into per-port and per-queue offloads.
>     Offloads are disabled by default and enabled per application request.
> diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h
> index e136d12b7..8e6b4d292 100644
> --- a/lib/librte_mbuf/rte_mbuf.h
> +++ b/lib/librte_mbuf/rte_mbuf.h
> @@ -738,7 +738,8 @@ rte_mbuf_to_baddr(struct rte_mbuf *md)
>   #define RTE_MBUF_CLONED(mb)     ((mb)->ol_flags & IND_ATTACHED_MBUF)
>   
>   /**
> - * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
> + * Deprecated.
> + * Use RTE_MBUF_CLONED().
>    */
>   #define RTE_MBUF_INDIRECT(mb)   RTE_MBUF_CLONED(mb)
>   

Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
Olivier Matz May 25, 2018, 7:20 a.m. UTC | #2 
On Thu, May 24, 2018 at 06:20:06PM -0700, Yongseok Koh wrote:
> Link: http://dpdk.org/ml/archives/dev/2018-April/099476.html
> 
> Signed-off-by: Yongseok Koh <yskoh@mellanox.com>

Acked-by: Olivier Matz <olivier.matz@6wind.com>
Shahaf Shuler May 27, 2018, 4:36 a.m. UTC | #3 
Friday, May 25, 2018 4:20 AM, Yongseok Koh:
> Subject: [dpdk-dev] [PATCH v2] doc: announce removal of indirect mbuf
> check macro
> 
> Link:
> https://emea01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdpd
> k.org%2Fml%2Farchives%2Fdev%2F2018-
> April%2F099476.html&data=02%7C01%7Cshahafs%40mellanox.com%7Ccaccc
> ead653640735e3308d5c1ddb6b0%7Ca652971c7d2e4d9ba6a4d149256f461b%7
> C0%7C0%7C636628080378790994&sdata=7JOFTPtuU4OYWowtwEKp3BaK5aS
> 8idulFiGhLEHRIkU%3D&reserved=0
> 
> Signed-off-by: Yongseok Koh <yskoh@mellanox.com>
> ---
> 
> v2:
> * modify removal deadline and add more comments in the deprecation note
> * mark deprecation on the comment of the macro in rte_mbuf.h
> 
>  doc/guides/rel_notes/deprecation.rst | 7 +++++++
>  lib/librte_mbuf/rte_mbuf.h           | 3 ++-
>  2 files changed, 9 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index 1e2443c76..e1630c2cf 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -42,6 +42,13 @@ Deprecation Notices
>    is defined in librte_sched in a non-generic way. The new generic format
>    will contain: queue ID, traffic class, color. Field size will not change.
> 
> +* mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or
> +later and
> +  replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05.
> +As
> +  ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05,
> +``RTE_MBUF_INDIRECT()``
> +  can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the
> +new
> +  experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of
> +the macro
> +  is to fix this semantic inconsistency.
> +
>  * ethdev: a new Tx and Rx offload API was introduced on 17.11.
>    In the new API, offloads are divided into per-port and per-queue offloads.
>    Offloads are disabled by default and enabled per application request.
> diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h index
> e136d12b7..8e6b4d292 100644
> --- a/lib/librte_mbuf/rte_mbuf.h
> +++ b/lib/librte_mbuf/rte_mbuf.h
> @@ -738,7 +738,8 @@ rte_mbuf_to_baddr(struct rte_mbuf *md)
>  #define RTE_MBUF_CLONED(mb)     ((mb)->ol_flags &
> IND_ATTACHED_MBUF)
> 
>  /**
> - * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
> + * Deprecated.
> + * Use RTE_MBUF_CLONED().
>   */
>  #define RTE_MBUF_INDIRECT(mb)   RTE_MBUF_CLONED(mb)

Acked-by: Shahaf Shuler <shahafs@mellanox.com>

> 
> --
> 2.11.0
Thomas Monjalon May 28, 2018, 12:54 a.m. UTC | #4 
25/05/2018 09:20, Olivier Matz:
> On Thu, May 24, 2018 at 06:20:06PM -0700, Yongseok Koh wrote:
> > Link: http://dpdk.org/ml/archives/dev/2018-April/099476.html
> > 
> > Signed-off-by: Yongseok Koh <yskoh@mellanox.com>
> 
> Acked-by: Olivier Matz <olivier.matz@6wind.com>

Applied, thanks
diff mbox

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 1e2443c76..e1630c2cf 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -42,6 +42,13 @@  Deprecation Notices
   is defined in librte_sched in a non-generic way. The new generic format
   will contain: queue ID, traffic class, color. Field size will not change.
 
+* mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and
+  replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As
+  ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()``
+  can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the new
+  experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro
+  is to fix this semantic inconsistency.
+
 * ethdev: a new Tx and Rx offload API was introduced on 17.11.
   In the new API, offloads are divided into per-port and per-queue offloads.
   Offloads are disabled by default and enabled per application request.
diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h
index e136d12b7..8e6b4d292 100644
--- a/lib/librte_mbuf/rte_mbuf.h
+++ b/lib/librte_mbuf/rte_mbuf.h
@@ -738,7 +738,8 @@  rte_mbuf_to_baddr(struct rte_mbuf *md)
 #define RTE_MBUF_CLONED(mb)     ((mb)->ol_flags & IND_ATTACHED_MBUF)
 
 /**
- * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
+ * Deprecated.
+ * Use RTE_MBUF_CLONED().
  */
 #define RTE_MBUF_INDIRECT(mb)   RTE_MBUF_CLONED(mb)