[dpdk-dev,v2] doc: announce API and ABI change for ethdev
Checks
Commit Message
This is an API/ABI change notice for DPDK 17.11 on redefinition of
port_id. port_id is defined as uint8_t by now, which is just ranged
from 0 to 255. For more and more scenerioes, more than 256 ports are
needed to support for vdev scalability.
It is necessary for redefinition of port_id to extend from 1 bytes
to 2 bytes. All ethdev APIs and use cases related to port_id will be
changed at the same time.
cc: jianfeng.tan@intel.com
cc: yliu@fridaylinux.org
cc: jerin.jacob@caviumnetworks.com
cc: thomas@monjalon.net
Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
Acked-by: Jianfeng Tan <jianfeng.tan@intel.com>
Acked-by: Yuanhan Liu <yliu@fridaylinux.org>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
---
Change in V2.
1. remove indent of paragraph in commit log.
2. add more description about API/ABI according to yuanhan's comments.
doc/guides/rel_notes/deprecation.rst | 6 ++++++
1 file changed, 6 insertions(+)
Comments
On 04/08/2017 06:27, Zhiyong Yang wrote:
> This is an API/ABI change notice for DPDK 17.11 on redefinition of
> port_id. port_id is defined as uint8_t by now, which is just ranged
> from 0 to 255. For more and more scenerioes, more than 256 ports are
> needed to support for vdev scalability.
>
> It is necessary for redefinition of port_id to extend from 1 bytes
> to 2 bytes. All ethdev APIs and use cases related to port_id will be
> changed at the same time.
I think this reads a little better:
This is an API/ABI change notice for DPDK 17.11 announcing the
redefinition of port_id. port_id is currently defined as uint8_t, which
is limited to the range 0 to 255. A larger range is required for vdev
scalability.
It is necessary for a redefinition of port_id to extend it from 1 bytes
to 2 bytes. All ethdev APIs and usages related to port_id will be
changed at the same time.
> doc/guides/rel_notes/deprecation.rst | 6 ++++++
> 1 file changed, 6 insertions(+)
Acked-by: Remy Horton <remy.horton@intel.com>
Hi, Remy:
> -----Original Message-----
> From: Horton, Remy
> Sent: Friday, August 4, 2017 2:56 PM
> To: Yang, Zhiyong <zhiyong.yang@intel.com>; dev@dpdk.org
> Cc: Tan, Jianfeng <jianfeng.tan@intel.com>; yliu@fridaylinux.org;
> jerin.jacob@caviumnetworks.com; thomas@monjalon.net
> Subject: Re: [dpdk-dev] [PATCH v2] doc: announce API and ABI change for
> ethdev
>
>
> On 04/08/2017 06:27, Zhiyong Yang wrote:
> > This is an API/ABI change notice for DPDK 17.11 on redefinition of
> > port_id. port_id is defined as uint8_t by now, which is just ranged
> > from 0 to 255. For more and more scenerioes, more than 256 ports are
> > needed to support for vdev scalability.
> >
> > It is necessary for redefinition of port_id to extend from 1 bytes to
> > 2 bytes. All ethdev APIs and use cases related to port_id will be
> > changed at the same time.
>
> I think this reads a little better:
>
> This is an API/ABI change notice for DPDK 17.11 announcing the redefinition of
> port_id. port_id is currently defined as uint8_t, which is limited to the range 0 to
> 255. A larger range is required for vdev scalability.
>
> It is necessary for a redefinition of port_id to extend it from 1 bytes to 2 bytes.
> All ethdev APIs and usages related to port_id will be changed at the same time.
Thanks Remy, of course. Your statement is better. I have a lot of things to learn
when speaking in English. I hope I can describe things like you, a native speaker. :)
Thanks again for your ack.
Zhiyong
>
> > doc/guides/rel_notes/deprecation.rst | 6 ++++++
> > 1 file changed, 6 insertions(+)
>
> Acked-by: Remy Horton <remy.horton@intel.com>
Hi, Thomas:
Need I sent another V3 patch to update commit log according to Remy's suggestion?
Thanks
Zhiyong
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Yang, Zhiyong
> Sent: Saturday, August 5, 2017 6:35 PM
> To: Horton, Remy <remy.horton@intel.com>; dev@dpdk.org
> Cc: Tan, Jianfeng <jianfeng.tan@intel.com>; yliu@fridaylinux.org;
> jerin.jacob@caviumnetworks.com; thomas@monjalon.net
> Subject: Re: [dpdk-dev] [PATCH v2] doc: announce API and ABI change for
> ethdev
>
> Hi, Remy:
>
> > -----Original Message-----
> > From: Horton, Remy
> > Sent: Friday, August 4, 2017 2:56 PM
> > To: Yang, Zhiyong <zhiyong.yang@intel.com>; dev@dpdk.org
> > Cc: Tan, Jianfeng <jianfeng.tan@intel.com>; yliu@fridaylinux.org;
> > jerin.jacob@caviumnetworks.com; thomas@monjalon.net
> > Subject: Re: [dpdk-dev] [PATCH v2] doc: announce API and ABI change
> > for ethdev
> >
> >
> > On 04/08/2017 06:27, Zhiyong Yang wrote:
> > > This is an API/ABI change notice for DPDK 17.11 on redefinition of
> > > port_id. port_id is defined as uint8_t by now, which is just ranged
> > > from 0 to 255. For more and more scenerioes, more than 256 ports are
> > > needed to support for vdev scalability.
> > >
> > > It is necessary for redefinition of port_id to extend from 1 bytes
> > > to
> > > 2 bytes. All ethdev APIs and use cases related to port_id will be
> > > changed at the same time.
> >
> > I think this reads a little better:
> >
> > This is an API/ABI change notice for DPDK 17.11 announcing the
> > redefinition of port_id. port_id is currently defined as uint8_t,
> > which is limited to the range 0 to 255. A larger range is required for vdev
> scalability.
> >
> > It is necessary for a redefinition of port_id to extend it from 1 bytes to 2 bytes.
> > All ethdev APIs and usages related to port_id will be changed at the same time.
>
> Thanks Remy, of course. Your statement is better. I have a lot of things to learn
> when speaking in English. I hope I can describe things like you, a native
> speaker. :) Thanks again for your ack.
>
> Zhiyong
>
> >
> > > doc/guides/rel_notes/deprecation.rst | 6 ++++++
> > > 1 file changed, 6 insertions(+)
> >
> > Acked-by: Remy Horton <remy.horton@intel.com>
07/08/2017 05:07, Yang, Zhiyong:
> Hi, Thomas:
> Need I sent another V3 patch to update commit log according to Remy's suggestion?
Yes it would be better if you can do it please
Friday, August 4, 2017 9:56 AM, Remy Horton:
> On 04/08/2017 06:27, Zhiyong Yang wrote:
> > This is an API/ABI change notice for DPDK 17.11 on redefinition of
> > port_id. port_id is defined as uint8_t by now, which is just ranged
> > from 0 to 255. For more and more scenerioes, more than 256 ports are
> > needed to support for vdev scalability.
> >
> > It is necessary for redefinition of port_id to extend from 1 bytes to
> > 2 bytes. All ethdev APIs and use cases related to port_id will be
> > changed at the same time.
>
> I think this reads a little better:
>
> This is an API/ABI change notice for DPDK 17.11 announcing the redefinition
> of port_id. port_id is currently defined as uint8_t, which is limited to the
> range 0 to 255. A larger range is required for vdev scalability.
>
> It is necessary for a redefinition of port_id to extend it from 1 bytes to 2
> bytes. All ethdev APIs and usages related to port_id will be changed at the
> same time.
>
> > doc/guides/rel_notes/deprecation.rst | 6 ++++++
> > 1 file changed, 6 insertions(+)
>
> Acked-by: Remy Horton <remy.horton@intel.com>
Acked-by: Shahaf Shuler <shahafs@mellanox.com>
@@ -49,6 +49,12 @@ Deprecation Notices
Target release for removal of the legacy API will be defined once most
PMDs have switched to rte_flow.
+* ABI/API changes are planned for 17.11 in all structures which include port_id
+ definition such as "rte_eth_dev_data", "rte_port_ethdev_reader_params",
+ "rte_port_ethdev_writer_params", and so on. The definition of port_id will be
+ changed from 8 bits to 16 bits in order to support more than 256 ports in
+ DPDK. All APIs which have port_id parameter will be changed at the same time.
+
* librte_table: The ``key_mask`` parameter will be added to all the hash tables
that currently do not have it, as well as to the hash compute function prototype.
The non-"do-sig" versions of the hash tables will be removed