[dpdk-dev] doc: announce ABI change for ring structure

Message ID 20170911133913.28737-1-olivier.matz@6wind.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

Olivier Matz Sept. 11, 2017, 1:39 p.m. UTC
  As discussed on the mailing list, the alignment constraint of
the ring structure can be relaxed.

Link: http://dpdk.org/dev/patchwork/patch/25039
Link: http://dpdk.org/dev/patchwork/patch/26103

Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)
  

Comments

Bruce Richardson Sept. 18, 2017, 9:16 a.m. UTC | #1
On Mon, Sep 11, 2017 at 03:39:13PM +0200, Olivier Matz wrote:
> As discussed on the mailing list, the alignment constraint of
> the ring structure can be relaxed.
> 
> Link: http://dpdk.org/dev/patchwork/patch/25039
> Link: http://dpdk.org/dev/patchwork/patch/26103
> 
> Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
> ---
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
  
John McNamara Sept. 18, 2017, 9:24 a.m. UTC | #2
> -----Original Message-----
> From: Olivier Matz [mailto:olivier.matz@6wind.com]
> Sent: Monday, September 11, 2017 2:39 PM
> To: dev@dpdk.org
> Cc: Richardson, Bruce <bruce.richardson@intel.com>; Mcnamara, John
> <john.mcnamara@intel.com>; Verkamp, Daniel <daniel.verkamp@intel.com>;
> Ananyev, Konstantin <konstantin.ananyev@intel.com>
> Subject: [PATCH] doc: announce ABI change for ring structure
> 
> As discussed on the mailing list, the alignment constraint of the ring
> structure can be relaxed.
> 
> Link: http://dpdk.org/dev/patchwork/patch/25039
> Link: http://dpdk.org/dev/patchwork/patch/26103
> 
> Signed-off-by: Olivier Matz <olivier.matz@6wind.com>

Acked-by: John McNamara <john.mcnamara@intel.com>
  
Anatoly Burakov Sept. 18, 2017, 9:30 a.m. UTC | #3
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Olivier Matz
> Sent: Monday, September 11, 2017 2:39 PM
> To: dev@dpdk.org
> Cc: Richardson, Bruce <bruce.richardson@intel.com>; Mcnamara, John
> <john.mcnamara@intel.com>; Verkamp, Daniel
> <daniel.verkamp@intel.com>; Ananyev, Konstantin
> <konstantin.ananyev@intel.com>
> Subject: [dpdk-dev] [PATCH] doc: announce ABI change for ring structure
> 
> As discussed on the mailing list, the alignment constraint of the ring structure
> can be relaxed.
> 
> Link: http://dpdk.org/dev/patchwork/patch/25039
> Link: http://dpdk.org/dev/patchwork/patch/26103
> 
> Signed-off-by: Olivier Matz <olivier.matz@6wind.com>

Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
  
Olivier Matz Dec. 8, 2017, 2:14 p.m. UTC | #4
Hi,

On Mon, Sep 11, 2017 at 03:39:13PM +0200, Olivier Matz wrote:
> As discussed on the mailing list, the alignment constraint of
> the ring structure can be relaxed.
> 
> Link: http://dpdk.org/dev/patchwork/patch/25039
> Link: http://dpdk.org/dev/patchwork/patch/26103
> 
> Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 3362f3350..5a63c0277 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -120,3 +120,9 @@ Deprecation Notices
>    The non-"do-sig" versions of the hash tables will be removed
>    (including the ``signature_offset`` parameter)
>    and the "do-sig" versions renamed accordingly.
> +
> +* ring: The alignment constraints on the ring structure will be relaxed
> +  to one cache line instead of two, and an empty cache line padding will
> +  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.
> -- 
> 2.11.0
> 


It looks this patch was forgotten.
It has 3 acks but was not integrated in 17.11.
Or did I miss something?
  
Thomas Monjalon Dec. 8, 2017, 5:01 p.m. UTC | #5
08/12/2017 15:14, Olivier MATZ:
> > +* ring: The alignment constraints on the ring structure will be relaxed
> > +  to one cache line instead of two, and an empty cache line padding will
> > +  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.
> 
> It looks this patch was forgotten.
> It has 3 acks but was not integrated in 17.11.
> Or did I miss something?

It seems I missed something. Sorry about that.
The release 18.02 should be ABI stable.
While happy to experiment such stability on one release,
it seems I forgot to notify you on this thread.
Sorry again
  
Thomas Monjalon Jan. 17, 2018, 9:07 p.m. UTC | #6
08/12/2017 18:01, Thomas Monjalon:
> 08/12/2017 15:14, Olivier MATZ:
> > > +* ring: The alignment constraints on the ring structure will be relaxed
> > > +  to one cache line instead of two, and an empty cache line padding will
> > > +  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.
> > 
> > It looks this patch was forgotten.
> > It has 3 acks but was not integrated in 17.11.
> > Or did I miss something?
> 
> It seems I missed something. Sorry about that.
> The release 18.02 should be ABI stable.
> While happy to experiment such stability on one release,
> it seems I forgot to notify you on this thread.
> Sorry again

Applied for change planned in 18.05.
Sorry again for the delay.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 3362f3350..5a63c0277 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -120,3 +120,9 @@  Deprecation Notices
   The non-"do-sig" versions of the hash tables will be removed
   (including the ``signature_offset`` parameter)
   and the "do-sig" versions renamed accordingly.
+
+* ring: The alignment constraints on the ring structure will be relaxed
+  to one cache line instead of two, and an empty cache line padding will
+  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.