[dpdk-dev] [PATCH] mempool: add notice to change mempool API/ABI

[dpdk-dev] [PATCH] mempool: add notice to change mempool API/ABI

[Santosh Shukla]

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>
---
 doc/guides/rel_notes/deprecation.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 257dcba32..7abb30f5f 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -64,3 +64,11 @@ 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.13.0

Re: [dpdk-dev] [PATCH] mempool: add notice to change mempool API/ABI

[Olivier Matz]

On Thu, 13 Jul 2017 09:12:31 +0000, Santosh Shukla <santosh.shukla@caviumnetworks.com> wrote:
> [PATCH] mempool: add notice to change mempool API/ABI

I think the usual titles for these notices are more:

doc: announce API/ABI changes for mempool

Ideally, the title should describe more precisely the kind of
changes. In that particular case, it looks quite difficult,
so just saying "mempool" looks okay. Maybe Thomas will prefer
one entry per change, I don't know.


> 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>
> ---
>  doc/guides/rel_notes/deprecation.rst | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 257dcba32..7abb30f5f 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -64,3 +64,11 @@ 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:

I think an empty line is required here, else the generated pdf will
be incorrect.

> +  - ``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.

Re: [dpdk-dev] [PATCH] mempool: add notice to change mempool API/ABI

[santosh]

On Thursday 20 July 2017 02:16 PM, Olivier Matz wrote:

> On Thu, 13 Jul 2017 09:12:31 +0000, Santosh Shukla <santosh.shukla@caviumnetworks.com> wrote:
>> [PATCH] mempool: add notice to change mempool API/ABI
> I think the usual titles for these notices are more:
>
> doc: announce API/ABI changes for mempool

in v2.

> Ideally, the title should describe more precisely the kind of
> changes. In that particular case, it looks quite difficult,
> so just saying "mempool" looks okay. Maybe Thomas will prefer
> one entry per change, I don't know.
>
Thomas, Are you fine with approach?

>> 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>
>> ---
>>  doc/guides/rel_notes/deprecation.rst | 8 ++++++++
>>  1 file changed, 8 insertions(+)
>>
>> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
>> index 257dcba32..7abb30f5f 100644
>> --- a/doc/guides/rel_notes/deprecation.rst
>> +++ b/doc/guides/rel_notes/deprecation.rst
>> @@ -64,3 +64,11 @@ 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:
> I think an empty line is required here, else the generated pdf will
> be incorrect.

in v2. Thanks.

>> +  - ``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.

Re: [dpdk-dev] [PATCH] mempool: add notice to change mempool API/ABI

[Thomas Monjalon]

20/07/2017 12:27, santosh:
> On Thursday 20 July 2017 02:16 PM, Olivier Matz wrote:
> 
> > On Thu, 13 Jul 2017 09:12:31 +0000, Santosh Shukla <santosh.shukla@caviumnetworks.com> wrote:
> >> [PATCH] mempool: add notice to change mempool API/ABI
> > I think the usual titles for these notices are more:
> >
> > doc: announce API/ABI changes for mempool
> 
> in v2.
> 
> > Ideally, the title should describe more precisely the kind of
> > changes. In that particular case, it looks quite difficult,
> > so just saying "mempool" looks okay. Maybe Thomas will prefer
> > one entry per change, I don't know.
> >
> Thomas, Are you fine with approach?

Yes it is OK.
The important words are "announce", "API" and "mempool".
As you are breaking the API, no need to be explicit about ABI.

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

[Santosh Shukla]

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(+)

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

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

[santosh]

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? 

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

[Jerin Jacob]

-----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
> 

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

[santosh]

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.

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

[Olivier MATZ]

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>

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

[Thomas Monjalon]

> > > 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