doc: deprecation notice for change of ether struct alignment
PATCH 1/1 doc: deprecation notice for change of ether struct alignment
The ethernet address structure alignment will be changed to 2B alignment in 19.11. Flag this to users.
Impact is expected to be minimal for this change since ethernet addresses are generally 2B aligned anyway.
--- doc/guides/rel_notes/deprecation.rst | 5 +++++ 1 file changed, 5 insertions(+)
doc/guides/rel_notes/deprecation.rst +5 -0
@@ -11,6 +11,11 @@ API and ABI deprecation notices are to be posted here. Deprecation Notices ------------------- +* net: The alignment of the ethernet address structure in DPDK, + ``rte_ether_addr`` will be increased to two, i.e. 16-bit aligned, in the + 19.11 release. This will only affect any data structures where an ethernet + address is currently aligned on a single byte boundary. + * meson: The minimum supported version of meson for configuring and building DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For those users with a version earlier than 0.47.1, an updated copy of meson
Signature · 1 line
2.21.0
Quoted 17 lines · On Tue, 9 Jul 2019 15:58:36 +0100 Bruce Richardson…
The ethernet address structure alignment will be changed to 2B alignment in 19.11. Flag this to users.
Impact is expected to be minimal for this change since ethernet addresses are generally 2B aligned anyway.
Signed-off-by Bruce Richardson <[email protected]>--- doc/guides/rel_notes/deprecation.rst | 5 +++++ 1 file changed, 5 insertions(+)doc/guides/rel_notes/deprecation.rst +0
-0@@ -11,6 +11,11 @@ API and ABI deprecation notices are to be posted here. Deprecation Notices
doc/guides/rel_notes/deprecation.rst API and ABI deprecation notices are to be posted here. · line 21
Quoted 10 lines
doc/guides/rel_notes/deprecation.rst +5
-0------------------- +* net: The alignment of the ethernet address structure in DPDK, + ``rte_ether_addr`` will be increased to two, i.e. 16-bit aligned, in the + 19.11 release. This will only affect any data structures where an ethernet + address is currently aligned on a single byte boundary. + * meson: The minimum supported version of meson for configuring and building DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For those users with a version earlier than 0.47.1, an updated copy of meson
We should also take the packed off of ether_header and ether_addr. Packed is meaningless on ether_addr anyway.
Quoted 22 lines · Stephen Hemminger
Quoted 19 lines · On Tue, 9 Jul 2019 15:58:36 +0100 Bruce Richardson…
The ethernet address structure alignment will be changed to 2B alignment in 19.11. Flag this to users.
Impact is expected to be minimal for this change since ethernet addresses are generally 2B aligned anyway.
Signed-off-by Bruce Richardson <[email protected]>--- doc/guides/rel_notes/deprecation.rst | 5 +++++ 1 file changed, 5 insertions(+)doc/guides/rel_notes/deprecation.rst +0
-0@@ -11,6 +11,11 @@ API and ABI deprecation notices are to be posted here. Deprecation Notices -------------------
Quoted 11 lines
doc/guides/rel_notes/deprecation.rst API and ABI deprecation notices are to be posted here. · line 21
Quoted 8 lines
doc/guides/rel_notes/deprecation.rst +5
-0+* net: The alignment of the ethernet address structure in DPDK, + ``rte_ether_addr`` will be increased to two, i.e. 16-bit aligned, in the + 19.11 release. This will only affect any data structures where an ethernet + address is currently aligned on a single byte boundary. + * meson: The minimum supported version of meson for configuring and building DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For those users with a version earlier than 0.47.1, an updated copy of mesonWe should also take the packed off of
ether_headerandether_addr. Packed is meaningless onether_addranyway.
Agreed. However, I don't think that needs to be called out here as it's a code change with zero impact. The user-impacting change is the alignment one.
/Bruce
PATCH 1/1 doc: add deprecation notice about changes to ethernet structures
Tell users about upcoming changes to rte_ether_addr and rte_ether_header.
--- doc/guides/rel_notes/deprecation.rst | 9 +++++++++ 1 file changed, 9 insertions(+)
doc/guides/rel_notes/deprecation.rst +9 -0
@@ -82,3 +82,12 @@ Deprecation Notices to set new power environment if power environment was already initialized. In this case the function will return -1 unless the environment is unset first (using ``rte_power_unset_env``). Other function usage scenarios will not change. + +* net: the Ethernet address and header defintions will change attributes. + The Ethernet address struct will no longer be marked as packed since + since the packed attribute is meaningless on a byte array. + The Etherne header will be marked as aligned on a 2 byte boundary (and + no longer packed). This allows for efficient access on all CPU's. + These changes should not impact normal usage drivers naturally + align the Ethernet header on receive, and almost every encapsulation + preserves the alignment.
Signature · 1 line
2.17.1
Re: [dpdk-dev] [PATCH] doc: add deprecation notice about changes to ethernet structures
Quoted 27 lines · Stephen Hemminger
Tell users about upcoming changes to
rte_ether_addrandrte_ether_header.Signed-off-by Stephen Hemminger <[email protected]>--- doc/guides/rel_notes/deprecation.rst | 9 +++++++++ 1 file changed, 9 insertions(+)doc/guides/rel_notes/deprecation.rst +9
-0@@ -82,3 +82,12 @@ Deprecation Notices to set new power environment if power environment was already initialized. In this case the function will return -1 unless the environment is unset first (using ``rte_power_unset_env``). Other function usage scenarios will not change. + +* net: the Ethernet address and header defintions will change attributes. + The Ethernet address struct will no longer be marked as packed since + since the packed attribute is meaningless on a byte array. + The Etherne header will be marked as aligned on a 2 byte boundary (and + no longer packed). This allows for efficient access on all CPU's. + These changes should not impact normal usage drivers naturally + align the Ethernet header on receive, and almost every encapsulation + preserves the alignment.Signature · 1 line
2.17.1
More comprehensive deprecation notice than mine, so:
One suggested change, rather than "almost every encapsulation" can we put it down as "all known encapsulations". If there is even a single public spec, in-real-use encapsulation that is used that does not preserve alignment, we should not do this. Saying "almost every" implies that we know of ones that don't, which I don't believe is the case.
/Bruce
PATCH v2 1/1 doc: add deprecation notice about changes to ethernet structures
In reply to Bruce RichardsonTell users about upcoming changes to rte_ether_addr and rte_ether_header.
---
v2 - reword and fix spelling
doc/guides/rel_notes/deprecation.rst | 10 ++++++++++ 1 file changed, 10 insertions(+)
doc/guides/rel_notes/deprecation.rst +10 -0
@@ -82,3 +82,13 @@ Deprecation Notices to set new power environment if power environment was already initialized. In this case the function will return -1 unless the environment is unset first (using ``rte_power_unset_env``). Other function usage scenarios will not change. + +* net: the Ethernet address and header definitions will change + attributes. The Ethernet address struct will no longer be marked as + packed since the packed attribute is meaningless on a byte + array. The Ethernet header will be marked as aligned on a 2-byte + boundary and will no longer have the packed attribute. This allows + for efficient access on CPU architectures where unaligned access is + expensive. These changes should not impact normal usage because drivers + naturally align the Ethernet header on receive and all known + encapsulations preserve the alignment of the header.
Signature · 1 line
2.20.1
Re: [dpdk-dev] [PATCH v2] doc: add deprecation notice about changes to ethernet structures
Quoted 5 lines · Stephen Hemminger
Tell users about upcoming changes to
rte_ether_addrandrte_ether_header.Signed-off-by Stephen Hemminger <[email protected]>Acked-by Bruce Richardson <[email protected]>
Ferruh Yigit
Acked-byRe: [dpdk-dev] [PATCH v2] doc: add deprecation notice about changes to ethernet structures
Quoted 9 lines · Andrew Rybchenko
Quoted 5 lines · Stephen Hemminger
Tell users about upcoming changes to
rte_ether_addrandrte_ether_header.Signed-off-by Stephen Hemminger <[email protected]>Acked-by Bruce Richardson <[email protected]>Acked-by Andrew Rybchenko <[email protected]>
Thomas Monjalon
Acked-byRe: [dpdk-dev] [PATCH v2] doc: add deprecation notice about changes to ethernet structures
Quoted 9 lines
Quoted 7 lines
Quoted 5 lines
Tell users about upcoming changes to
rte_ether_addrandrte_ether_header.Signed-off-by Stephen Hemminger <[email protected]>Acked-by Bruce Richardson <[email protected]>Acked-by Andrew Rybchenko <[email protected]>Acked-by Ferruh Yigit <[email protected]>
Thomas Monjalon
AppliedRe: [dpdk-dev] [PATCH v2] doc: add deprecation notice about changes to ethernet structures
06/08/2019 13:26, Thomas Monjalon:
Quoted 11 lines
Quoted 9 lines
Quoted 7 lines
Quoted 5 lines
Tell users about upcoming changes to
rte_ether_addrandrte_ether_header.Signed-off-by Stephen Hemminger <[email protected]>Acked-by Bruce Richardson <[email protected]>Acked-by Andrew Rybchenko <[email protected]>Acked-by Ferruh Yigit <[email protected]>Acked-by Thomas Monjalon <[email protected]>
Applied, thanks