[v1,1/1] doc: announce ethdev ABI change for rte_eth_dev_info.

Message ID 1542888549-24656-1-git-send-email-ian.stokes@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v1,1/1] doc: announce ethdev ABI change for rte_eth_dev_info. |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/mellanox-Performance-Testing success Performance Testing PASS
ci/intel-Performance-Testing success Performance Testing PASS

Commit Message

Ian Stokes Nov. 22, 2018, 12:09 p.m. UTC
  Maximum and minimum MTU values vary between hardware devices. In
hardware agnostic DPDK applications access to such information would
allow a more accurate way of validating and setting supported MTU values on
a per device basis rather than using a defined default for all devices.

The following solution was proposed:

http://mails.dpdk.org/archives/dev/2018-September/110959.html

This patch adds a depreciation notice for ``rte_eth_dev_info`` as new
members will be added to represent min and max MTU values. These can be
added to fit a hole in the existing structure for amd64 but not for 32 bit,
as such ABI change will occur as size of the structure will be impacted.

Signed-off-by: Ian Stokes <ian.stokes@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)
  

Comments

Ferruh Yigit Nov. 22, 2018, 12:11 p.m. UTC | #1
On 11/22/2018 12:09 PM, Ian Stokes wrote:
> Maximum and minimum MTU values vary between hardware devices. In
> hardware agnostic DPDK applications access to such information would
> allow a more accurate way of validating and setting supported MTU values on
> a per device basis rather than using a defined default for all devices.
> 
> The following solution was proposed:
> 
> http://mails.dpdk.org/archives/dev/2018-September/110959.html
> 
> This patch adds a depreciation notice for ``rte_eth_dev_info`` as new
> members will be added to represent min and max MTU values. These can be
> added to fit a hole in the existing structure for amd64 but not for 32 bit,
> as such ABI change will occur as size of the structure will be impacted.
> 
> Signed-off-by: Ian Stokes <ian.stokes@intel.com>

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

> ---
>  doc/guides/rel_notes/deprecation.rst | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 34b28234c..da2b1ce15 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -49,6 +49,18 @@ Deprecation Notices
>    Target release for removal of the legacy API will be defined once most
>    PMDs have switched to rte_flow.
>  
> +* ethdev: Maximum and minimum MTU values vary between hardware devices. In
> +  hardware agnostic DPDK applications access to such information would allow
> +  a more accurate way of validating and setting supported MTU values on a per
> +  device basis rather than using a defined default for all devices. To
> +  resolve this, the following members will be added to ``rte_eth_dev_info``.
> +  Note: these can be added to fit a hole in the existing structure for amd64
> +  but not for 32 bit, as such ABI change will occur as size of the structure
> +  will increase.
> +
> +  - Member ``uint16_t min_mtu`` the minimum MTU allowed.
> +  - Member ``uint16_t max_mtu`` the maximum MTU allowed.
> +
>  * pdump: As we changed to use generic IPC, some changes in APIs and structure
>    are expected in subsequent release.
>  
>
  
Thomas Monjalon Nov. 22, 2018, 5:15 p.m. UTC | #2
22/11/2018 13:11, Ferruh Yigit:
> On 11/22/2018 12:09 PM, Ian Stokes wrote:
> > Maximum and minimum MTU values vary between hardware devices. In
> > hardware agnostic DPDK applications access to such information would
> > allow a more accurate way of validating and setting supported MTU values on
> > a per device basis rather than using a defined default for all devices.
> > 
> > The following solution was proposed:
> > 
> > http://mails.dpdk.org/archives/dev/2018-September/110959.html
> > 
> > This patch adds a depreciation notice for ``rte_eth_dev_info`` as new
> > members will be added to represent min and max MTU values. These can be
> > added to fit a hole in the existing structure for amd64 but not for 32 bit,
> > as such ABI change will occur as size of the structure will be impacted.
> > 
> > Signed-off-by: Ian Stokes <ian.stokes@intel.com>
> 
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

Acked-by: Thomas Monjalon <thomas@monjalon.net>

[...]
> > +* ethdev: Maximum and minimum MTU values vary between hardware devices. In
> > +  hardware agnostic DPDK applications access to such information would allow
> > +  a more accurate way of validating and setting supported MTU values on a per
> > +  device basis rather than using a defined default for all devices. To
> > +  resolve this, the following members will be added to ``rte_eth_dev_info``.
> > +  Note: these can be added to fit a hole in the existing structure for amd64
> > +  but not for 32 bit, as such ABI change will occur as size of the structure
> > +  will increase.
> > +
> > +  - Member ``uint16_t min_mtu`` the minimum MTU allowed.
> > +  - Member ``uint16_t max_mtu`` the maximum MTU allowed.
> > +
  
Ferruh Yigit Nov. 22, 2018, 6:27 p.m. UTC | #3
On 11/22/2018 12:09 PM, Ian Stokes wrote:
> Maximum and minimum MTU values vary between hardware devices. In
> hardware agnostic DPDK applications access to such information would
> allow a more accurate way of validating and setting supported MTU values on
> a per device basis rather than using a defined default for all devices.
> 
> The following solution was proposed:
> 
> http://mails.dpdk.org/archives/dev/2018-September/110959.html
> 
> This patch adds a depreciation notice for ``rte_eth_dev_info`` as new
> members will be added to represent min and max MTU values. These can be
> added to fit a hole in the existing structure for amd64 but not for 32 bit,
> as such ABI change will occur as size of the structure will be impacted.
> 
> Signed-off-by: Ian Stokes <ian.stokes@intel.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 34b28234c..da2b1ce15 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -49,6 +49,18 @@ Deprecation Notices
>    Target release for removal of the legacy API will be defined once most
>    PMDs have switched to rte_flow.
>  
> +* ethdev: Maximum and minimum MTU values vary between hardware devices. In
> +  hardware agnostic DPDK applications access to such information would allow
> +  a more accurate way of validating and setting supported MTU values on a per
> +  device basis rather than using a defined default for all devices. To
> +  resolve this, the following members will be added to ``rte_eth_dev_info``.
> +  Note: these can be added to fit a hole in the existing structure for amd64
> +  but not for 32 bit, as such ABI change will occur as size of the structure
> +  will increase.
> +
> +  - Member ``uint16_t min_mtu`` the minimum MTU allowed.
> +  - Member ``uint16_t max_mtu`` the maximum MTU allowed.
> +
>  * pdump: As we changed to use generic IPC, some changes in APIs and structure
>    are expected in subsequent release.
>  
> 

cc'ed a few more folks.
  
Andrew Rybchenko Nov. 23, 2018, 8:08 a.m. UTC | #4
On 11/22/18 9:27 PM, Ferruh Yigit wrote:
> On 11/22/2018 12:09 PM, Ian Stokes wrote:
>> Maximum and minimum MTU values vary between hardware devices. In
>> hardware agnostic DPDK applications access to such information would
>> allow a more accurate way of validating and setting supported MTU values on
>> a per device basis rather than using a defined default for all devices.
>>
>> The following solution was proposed:
>>
>> http://mails.dpdk.org/archives/dev/2018-September/110959.html
>>
>> This patch adds a depreciation notice for ``rte_eth_dev_info`` as new
>> members will be added to represent min and max MTU values. These can be
>> added to fit a hole in the existing structure for amd64 but not for 32 bit,
>> as such ABI change will occur as size of the structure will be impacted.
>>
>> Signed-off-by: Ian Stokes <ian.stokes@intel.com>

Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
  
Thomas Monjalon Nov. 24, 2018, 5:37 p.m. UTC | #5
22/11/2018 18:15, Thomas Monjalon:
> 22/11/2018 13:11, Ferruh Yigit:
> > On 11/22/2018 12:09 PM, Ian Stokes wrote:
> > > Maximum and minimum MTU values vary between hardware devices. In
> > > hardware agnostic DPDK applications access to such information would
> > > allow a more accurate way of validating and setting supported MTU values on
> > > a per device basis rather than using a defined default for all devices.
> > > 
> > > The following solution was proposed:
> > > 
> > > http://mails.dpdk.org/archives/dev/2018-September/110959.html
> > > 
> > > This patch adds a depreciation notice for ``rte_eth_dev_info`` as new
> > > members will be added to represent min and max MTU values. These can be
> > > added to fit a hole in the existing structure for amd64 but not for 32 bit,
> > > as such ABI change will occur as size of the structure will be impacted.
> > > 
> > > Signed-off-by: Ian Stokes <ian.stokes@intel.com>
> > 
> > Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
> Acked-by: Thomas Monjalon <thomas@monjalon.net>
> Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>

Applied
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 34b28234c..da2b1ce15 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -49,6 +49,18 @@  Deprecation Notices
   Target release for removal of the legacy API will be defined once most
   PMDs have switched to rte_flow.
 
+* ethdev: Maximum and minimum MTU values vary between hardware devices. In
+  hardware agnostic DPDK applications access to such information would allow
+  a more accurate way of validating and setting supported MTU values on a per
+  device basis rather than using a defined default for all devices. To
+  resolve this, the following members will be added to ``rte_eth_dev_info``.
+  Note: these can be added to fit a hole in the existing structure for amd64
+  but not for 32 bit, as such ABI change will occur as size of the structure
+  will increase.
+
+  - Member ``uint16_t min_mtu`` the minimum MTU allowed.
+  - Member ``uint16_t max_mtu`` the maximum MTU allowed.
+
 * pdump: As we changed to use generic IPC, some changes in APIs and structure
   are expected in subsequent release.