[dpdk-dev,v2] doc: announce API/ABI changes for mempool

Message ID 20170720102915.14497-1-santosh.shukla@caviumnetworks.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 fail Compilation issues

Commit Message

Santosh Shukla July 20, 2017, 10:29 a.m. UTC
  An API/ABI change is planned for 17.11 to change following

* Remove unused flag param from rte_mempool_generic_get and _put.
* Change data type for mempool 'flag' from int to unsigned int.
  Refer [1].
* Add struct rte_mempool * param into func rte_mempool_xmem_size,
  rte_mempool_xmem_usage to make it mempool aware.
  Refer [2].

[1] http://dpdk.org/dev/patchwork/patch/25603/
[2] http://dpdk.org/dev/patchwork/patch/25605/

Signed-off-by: Santosh Shukla <santosh.shukla@caviumnetworks.com>
---
v1 --> v2:
- Changed the title.
- Added empty line between 'mempool:' and - ``.
(Both suggested by Olivier)

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

Comments

Santosh Shukla July 21, 2017, 6:26 a.m. UTC | #1
On Thursday 20 July 2017 03:59 PM, Santosh Shukla wrote:

> An API/ABI change is planned for 17.11 to change following
>
> * Remove unused flag param from rte_mempool_generic_get and _put.
> * Change data type for mempool 'flag' from int to unsigned int.
>   Refer [1].
> * Add struct rte_mempool * param into func rte_mempool_xmem_size,
>   rte_mempool_xmem_usage to make it mempool aware.
>   Refer [2].
>
> [1] http://dpdk.org/dev/patchwork/patch/25603/
> [2] http://dpdk.org/dev/patchwork/patch/25605/
>
> Signed-off-by: Santosh Shukla <santosh.shukla@caviumnetworks.com>
> ---
> v1 --> v2:
> - Changed the title.
> - Added empty line between 'mempool:' and - ``.
> (Both suggested by Olivier)

Thomas, Olivier, all:
If no objection on mempool deprecation notice then
can we plan to get it merged to 17.08?
  
Jerin Jacob Aug. 3, 2017, 2:21 p.m. UTC | #2
-----Original Message-----
> Date: Thu, 20 Jul 2017 15:59:15 +0530
> From: Santosh Shukla <santosh.shukla@caviumnetworks.com>
> To: olivier.matz@6wind.com, dev@dpdk.org
> CC: thomas.monjalon@6wind.com, Santosh Shukla
>  <santosh.shukla@caviumnetworks.com>
> Subject: [dpdk-dev] [PATCH v2] doc: announce API/ABI changes for mempool
> X-Mailer: git-send-email 2.11.0
> 
> An API/ABI change is planned for 17.11 to change following
> 
> * Remove unused flag param from rte_mempool_generic_get and _put.
> * Change data type for mempool 'flag' from int to unsigned int.
>   Refer [1].
> * Add struct rte_mempool * param into func rte_mempool_xmem_size,
>   rte_mempool_xmem_usage to make it mempool aware.
>   Refer [2].
> 
> [1] http://dpdk.org/dev/patchwork/patch/25603/
> [2] http://dpdk.org/dev/patchwork/patch/25605/
> 
> Signed-off-by: Santosh Shukla <santosh.shukla@caviumnetworks.com>

Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>

> ---
> v1 --> v2:
> - Changed the title.
> - Added empty line between 'mempool:' and - ``.
> (Both suggested by Olivier)
> 
>  doc/guides/rel_notes/deprecation.rst | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 257dcba32..1345b0e65 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -64,3 +64,12 @@ Deprecation Notices
>    be removed in 17.11:
>  
>    - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
> +
> +* mempool: The following will be modified in 17.11:
> +
> +  - ``rte_mempool_xmem_size`` and ``rte_mempool_xmem_usage`` need to know
> +    the mempool flag status so adding new param rte_mempool in those API.
> +  - Removing __rte_unused int flag param from ``rte_mempool_generic_put``
> +    and ``rte_mempool_generic_get`` API.
> +  - ``rte_mempool`` flags data type will changed from int to
> +    unsigned int.
> -- 
> 2.11.0
>
  
Santosh Shukla Aug. 3, 2017, 2:30 p.m. UTC | #3
On Thursday 03 August 2017 07:51 PM, Jerin Jacob wrote:

> -----Original Message-----
>> Date: Thu, 20 Jul 2017 15:59:15 +0530
>> From: Santosh Shukla <santosh.shukla@caviumnetworks.com>
>> To: olivier.matz@6wind.com, dev@dpdk.org
>> CC: thomas.monjalon@6wind.com, Santosh Shukla
>>  <santosh.shukla@caviumnetworks.com>
>> Subject: [dpdk-dev] [PATCH v2] doc: announce API/ABI changes for mempool
>> X-Mailer: git-send-email 2.11.0
>>
>> An API/ABI change is planned for 17.11 to change following
>>
>> * Remove unused flag param from rte_mempool_generic_get and _put.
>> * Change data type for mempool 'flag' from int to unsigned int.
>>   Refer [1].
>> * Add struct rte_mempool * param into func rte_mempool_xmem_size,
>>   rte_mempool_xmem_usage to make it mempool aware.
>>   Refer [2].
>>
>> [1] http://dpdk.org/dev/patchwork/patch/25603/
>> [2] http://dpdk.org/dev/patchwork/patch/25605/
>>
>> Signed-off-by: Santosh Shukla <santosh.shukla@caviumnetworks.com>
> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>

Olivier/Thomas, Review feedback pl.?

Thanks.
  
Olivier Matz Aug. 5, 2017, 8:24 p.m. UTC | #4
On Thu, Aug 03, 2017 at 07:51:34PM +0530, Jerin Jacob wrote:
> -----Original Message-----
> > Date: Thu, 20 Jul 2017 15:59:15 +0530
> > From: Santosh Shukla <santosh.shukla@caviumnetworks.com>
> > To: olivier.matz@6wind.com, dev@dpdk.org
> > CC: thomas.monjalon@6wind.com, Santosh Shukla
> >  <santosh.shukla@caviumnetworks.com>
> > Subject: [dpdk-dev] [PATCH v2] doc: announce API/ABI changes for mempool
> > X-Mailer: git-send-email 2.11.0
> > 
> > An API/ABI change is planned for 17.11 to change following
> > 
> > * Remove unused flag param from rte_mempool_generic_get and _put.
> > * Change data type for mempool 'flag' from int to unsigned int.
> >   Refer [1].
> > * Add struct rte_mempool * param into func rte_mempool_xmem_size,
> >   rte_mempool_xmem_usage to make it mempool aware.
> >   Refer [2].
> > 
> > [1] http://dpdk.org/dev/patchwork/patch/25603/
> > [2] http://dpdk.org/dev/patchwork/patch/25605/
> > 
> > Signed-off-by: Santosh Shukla <santosh.shukla@caviumnetworks.com>
> 
> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>

Acked-by: Olivier Matz <olivier.matz@6wind.com>
  
Thomas Monjalon Aug. 8, 2017, 12:10 a.m. UTC | #5
> > > An API/ABI change is planned for 17.11 to change following
> > > 
> > > * Remove unused flag param from rte_mempool_generic_get and _put.
> > > * Change data type for mempool 'flag' from int to unsigned int.
> > >   Refer [1].
> > > * Add struct rte_mempool * param into func rte_mempool_xmem_size,
> > >   rte_mempool_xmem_usage to make it mempool aware.
> > >   Refer [2].
> > > 
> > > [1] http://dpdk.org/dev/patchwork/patch/25603/
> > > [2] http://dpdk.org/dev/patchwork/patch/25605/
> > > 
> > > Signed-off-by: Santosh Shukla <santosh.shukla@caviumnetworks.com>
> > 
> > Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> 
> Acked-by: Olivier Matz <olivier.matz@6wind.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 257dcba32..1345b0e65 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -64,3 +64,12 @@  Deprecation Notices
   be removed in 17.11:
 
   - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
+
+* mempool: The following will be modified in 17.11:
+
+  - ``rte_mempool_xmem_size`` and ``rte_mempool_xmem_usage`` need to know
+    the mempool flag status so adding new param rte_mempool in those API.
+  - Removing __rte_unused int flag param from ``rte_mempool_generic_put``
+    and ``rte_mempool_generic_get`` API.
+  - ``rte_mempool`` flags data type will changed from int to
+    unsigned int.