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

Message ID 1516713784-11605-1-git-send-email-arybchenko@solarflare.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

Andrew Rybchenko Jan. 23, 2018, 1:23 p.m. UTC
  An API/ABI changes are planned for 18.05 [1]:

 * Allow to customize how mempool objects are stored in memory.
 * Deprecate mempool XMEM API.
 * Add mempool driver ops to get information from mempool driver and
   dequeue contiguous blocks of objects if driver supports it.

[1] http://dpdk.org/ml/archives/dev/2018-January/088698.html

Signed-off-by: Andrew Rybchenko <arybchenko@solarflare.com>
---
 doc/guides/rel_notes/deprecation.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
  

Comments

Olivier Matz Jan. 31, 2018, 4:46 p.m. UTC | #1
On Tue, Jan 23, 2018 at 01:23:04PM +0000, Andrew Rybchenko wrote:
> An API/ABI changes are planned for 18.05 [1]:
> 
>  * Allow to customize how mempool objects are stored in memory.
>  * Deprecate mempool XMEM API.
>  * Add mempool driver ops to get information from mempool driver and
>    dequeue contiguous blocks of objects if driver supports it.
> 
> [1] http://dpdk.org/ml/archives/dev/2018-January/088698.html
> 
> Signed-off-by: Andrew Rybchenko <arybchenko@solarflare.com>

Acked-by: Olivier Matz <olivier.matz@6wind.com>
  
Jerin Jacob Feb. 1, 2018, 6:40 a.m. UTC | #2
-----Original Message-----
> Date: Wed, 31 Jan 2018 17:46:51 +0100
> From: Olivier Matz <olivier.matz@6wind.com>
> To: Andrew Rybchenko <arybchenko@solarflare.com>
> CC: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: announce API/ABI changes for mempool
> User-Agent: NeoMutt/20170113 (1.7.2)
> 
> On Tue, Jan 23, 2018 at 01:23:04PM +0000, Andrew Rybchenko wrote:
> > An API/ABI changes are planned for 18.05 [1]:
> > 
> >  * Allow to customize how mempool objects are stored in memory.
> >  * Deprecate mempool XMEM API.
> >  * Add mempool driver ops to get information from mempool driver and
> >    dequeue contiguous blocks of objects if driver supports it.
> > 
> > [1] http://dpdk.org/ml/archives/dev/2018-January/088698.html
> > 
> > Signed-off-by: Andrew Rybchenko <arybchenko@solarflare.com>
> 
> Acked-by: Olivier Matz <olivier.matz@6wind.com>

Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
  
Hemant Agrawal Feb. 1, 2018, 12:53 p.m. UTC | #3
On 2/1/2018 12:10 PM, Jerin Jacob wrote:
> -----Original Message-----
>> Date: Wed, 31 Jan 2018 17:46:51 +0100
>> From: Olivier Matz <olivier.matz@6wind.com>
>> To: Andrew Rybchenko <arybchenko@solarflare.com>
>> CC: dev@dpdk.org
>> Subject: Re: [dpdk-dev] [PATCH] doc: announce API/ABI changes for mempool
>> User-Agent: NeoMutt/20170113 (1.7.2)
>>
>> On Tue, Jan 23, 2018 at 01:23:04PM +0000, Andrew Rybchenko wrote:
>>> An API/ABI changes are planned for 18.05 [1]:
>>>
>>>   * Allow to customize how mempool objects are stored in memory.
>>>   * Deprecate mempool XMEM API.
>>>   * Add mempool driver ops to get information from mempool driver and
>>>     dequeue contiguous blocks of objects if driver supports it.
>>>
>>> [1] http://dpdk.org/ml/archives/dev/2018-January/088698.html
>>>
>>> Signed-off-by: Andrew Rybchenko <arybchenko@solarflare.com>
>>
>> Acked-by: Olivier Matz <olivier.matz@6wind.com>
> 
> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> 
> 
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
  
Thomas Monjalon Feb. 14, 2018, 3:23 p.m. UTC | #4
> >>> An API/ABI changes are planned for 18.05 [1]:
> >>>
> >>>   * Allow to customize how mempool objects are stored in memory.
> >>>   * Deprecate mempool XMEM API.
> >>>   * Add mempool driver ops to get information from mempool driver and
> >>>     dequeue contiguous blocks of objects if driver supports it.
> >>>
> >>> [1] http://dpdk.org/ml/archives/dev/2018-January/088698.html
> >>>
> >>> Signed-off-by: Andrew Rybchenko <arybchenko@solarflare.com>
> >>
> >> Acked-by: Olivier Matz <olivier.matz@6wind.com>
> > 
> > Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> > 
> Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>

Applied
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index d59ad59..9db80da 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -59,3 +59,20 @@  Deprecation Notices
   be added between the producer and consumer structures. The size of the
   structure and the offset of the fields will remain the same on
   platforms with 64B cache line, but will change on other platforms.
+
+* mempool: several API and ABI changes are planned in v18.05.
+  The following functions, introduced for Xen, which is not supported
+  anymore since v17.11, are hard to use, not used anywhere else in DPDK.
+  Therefore they will be deprecated in v18.05 and removed in v18.08:
+
+  - ``rte_mempool_xmem_create``
+  - ``rte_mempool_xmem_size``
+  - ``rte_mempool_xmem_usage``
+
+  The following changes are planned:
+
+  - removal of ``get_capabilities`` mempool ops and related flags.
+  - substitute ``register_memory_area`` with ``populate`` ops.
+  - addition of new ops to customize required memory chunk calculation,
+    customize objects population and allocate contiguous
+    block of objects if underlying driver supports it.