doc: announce changes in bbdev related to enum extension
PATCH v2 1/1 doc: announce changes in bbdev related to enum extension
v2: indentation fix
Realizing when submitting new bbdev operation in this patch
(https://patchwork.dpdk.org/project/dpdk/list/?series=22111) that this is not workable in practice to extend this API into 22.07 without fundamental ABI breakage even by using existing versionning framework.
Some existing learnings to be applied here to prevent extension being blocked, hence accouncing changes in bbdev intended for 22.11 to make this more future-proof, including dropping max value from enum, as well as deferring extension of the API for FFT operation into DPDK 22.11.
Let me know if any comments or in case this should be captured differently. Thanks
Nic
Nicolas Chautru (1):
doc: announce changes in bbdev related to enum extension
doc/guides/rel_notes/deprecation.rst | 8 ++++++++ 1 file changed, 8 insertions(+)
Signature · 1 line
1.8.3.1
PATCH v2 1/1 doc: announce changes in bbdev related to enum extension
Intent to resolve in DPDK 22.11 historical usage which prevents graceful extension of enum and API without troublesome ABI breakage as well as extending API RTE_BBDEV_OP_FFT for new operation type in bbdev.
--- doc/guides/rel_notes/deprecation.rst | 8 ++++++++ 1 file changed, 8 insertions(+)
doc/guides/rel_notes/deprecation.rst +8 -0
@@ -112,6 +112,14 @@ Deprecation Notices session and the private data of session. An opaque pointer can be exposed directly to application which can be attached to the ``rte_crypto_op``. +* bbdev: Will fix extending some enum breaking the ABI. Notably + deprecating ``RTE_BBDEV_OP_TYPE_COUNT`` terminating the ``rte_bbdev_op_type`` + and use fixed array size when required to allow for future enum extension. + Will also remove some of the inlining when causing ABI future-proof concerns. + Will extend API to support new operation type ``RTE_BBDEV_OP_FFT`` as per this + RFC https://patchwork.dpdk.org/project/dpdk/list/?series=22111 + This should be updated in DPDK 22.11. + * security: Hide structure ``rte_security_session`` and expose an opaque pointer for the private data to the application which can be attached to the packet while enqueuing.
Signature · 1 line
1.8.3.1
PATCH v3 1/1 doc: announce changes in bbdev related to enum extension
v3: being more explicit wrt the list of intended changes for 22.11
v2: indentation fix
Realizing when submitting new bbdev operation in this patch
(https://patchwork.dpdk.org/project/dpdk/list/?series=22111) that this is not workable in practice to extend this API into 22.07 without fundamental ABI breakage even by using existing versionning framework.
Some existing learnings to be applied here to prevent extension being blocked, hence accouncing changes in bbdev intended for 22.11 to make this more future-proof, including dropping max value from enum, as well as deferring extension of the API for FFT operation into DPDK 22.11.
Let me know if any comments or in case this should be captured differently. Thanks
Nic
Nicolas Chautru (1):
doc: announce changes in bbdev related to enum extension
doc/guides/rel_notes/deprecation.rst | 10 ++++++++++ 1 file changed, 10 insertions(+)
Signature · 1 line
1.8.3.1
PATCH v3 1/1 doc: announce changes in bbdev related to enum extension
Intent to resolve in DPDK 22.11 historical usage which prevents graceful extension of enum and API without troublesome ABI breakage as well as extending API RTE_BBDEV_OP_FFT for new operation type in bbdev as well as other new members in existing structures.
--- doc/guides/rel_notes/deprecation.rst | 10 ++++++++++ 1 file changed, 10 insertions(+)
doc/guides/rel_notes/deprecation.rst +10 -0
@@ -112,6 +112,16 @@ Deprecation Notices session and the private data of session. An opaque pointer can be exposed directly to application which can be attached to the ``rte_crypto_op``. +* bbdev: Will be deprecating ``RTE_BBDEV_OP_TYPE_COUNT`` terminating the ``rte_bbdev_op_type`` + and use fixed array size when required to allow for future enum extension. + Will extend API to support new operation type ``RTE_BBDEV_OP_FFT`` as per this + RFC https://patchwork.dpdk.org/project/dpdk/list/?series=22111 + Will be adding new members in ``rte_bbdev_driver_info`` to expose PMD queue topology inspired + by this RFC https://patches.dpdk.org/project/dpdk/list/?series=22076 + Will be adding new member in ``rte_bbdev_driver_info`` to expose the device status as per + this RFC https://patches.dpdk.org/project/dpdk/list/?series=23367 + This should be updated in DPDK 22.11. + * security: Hide structure ``rte_security_session`` and expose an opaque pointer for the private data to the application which can be attached to the packet while enqueuing.
Signature · 1 line
1.8.3.1
PATCH v4 1/1 doc: announce changes in bbdev related to enum extension
In reply to Nicolas Chautruv4: correcting typo. Hemant, Maxime kindly review/ack.
v3: being more explicit wrt the list of intended changes for 22.11
v2: indentation fix
Realizing when submitting new bbdev operation in this patch
(https://patchwork.dpdk.org/project/dpdk/list/?series=22111) that this is not workable in practice to extend this API into 22.07 without fundamental ABI breakage even by using existing versionning framework.
Some existing learnings to be applied here to prevent extension being blocked, hence accouncing changes in bbdev intended for 22.11 to make this more future-proof, including dropping max value from enum, as well as deferring extension of the API for FFT operation into DPDK 22.11.
Let me know if any comments or in case this should be captured differently. Thanks
Nic
Nicolas Chautru (1):
doc: announce changes in bbdev related to enum extension
doc/guides/rel_notes/deprecation.rst | 11 +++++++++++ 1 file changed, 11 insertions(+)
Signature · 1 line
1.8.3.1
PATCH v4 1/1 doc: announce changes in bbdev related to enum extension
Intent to resolve in DPDK 22.11 historical usage which prevents graceful extension of enum and API without troublesome ABI breakage as well as extending API RTE_BBDEV_OP_FFT for new operation type in bbdev as well as other new members in existing structures.
--- doc/guides/rel_notes/deprecation.rst | 11 +++++++++++ 1 file changed, 11 insertions(+)
doc/guides/rel_notes/deprecation.rst +11 -0
@@ -112,6 +112,17 @@ Deprecation Notices session and the private data of session. An opaque pointer can be exposed directly to application which can be attached to the ``rte_crypto_op``. +* bbdev: ``RTE_BBDEV_OP_TYPE_COUNT`` terminating the ``rte_bbdev_op_type`` + enum will be deprecated and instead use fixed array size when required to allow for + future enum extension. + Will extend API to support new operation type ``RTE_BBDEV_OP_FFT`` as per this + RFC https://patchwork.dpdk.org/project/dpdk/list/?series=22111 + New members will be added in ``rte_bbdev_driver_info`` to expose PMD queue topology inspired + by this RFC https://patches.dpdk.org/project/dpdk/list/?series=22076 + New member will be added in ``rte_bbdev_driver_info`` to expose the device status as per + this RFC https://patches.dpdk.org/project/dpdk/list/?series=23367 + This should be updated in DPDK 22.11. + * security: Hide structure ``rte_security_session`` and expose an opaque pointer for the private data to the application which can be attached to the packet while enqueuing.
Signature · 1 line
1.8.3.1
Quoted 87 lines
-----Original Message-----
From: Nicolas Chautru <[email protected]>
Sent: Thursday, June 9, 2022 6:05 AM
To: [email protected]; [email protected]; [email protected]; [email protected]
Cc: [email protected]; [email protected]; [email protected]; Hemant Agrawal <[email protected]>; [email protected]; [email protected]; Nicolas Chautru <[email protected]>
Subject: [PATCH v4] doc: announce changes in bbdev related to enum extension
Importance: HighIntent to resolve in DPDK 22.11 historical usage which prevents graceful extension of enum and API without troublesome ABI breakage as well as extending API
RTE_BBDEV_OP_FFTfor new operation type in bbdev as well as other new members in existing structures.Signed-off-by Nicolas Chautru <[email protected]>--- doc/guides/rel_notes/deprecation.rst | 11 +++++++++++ 1 file changed, 11 insertions(+)doc/guides/rel_notes/deprecation.rst +9
-0@@ -112,6 +112,17 @@ Deprecation Notices session and the private data of session. An opaque pointer can be exposed directly to application which can be attached to the ``rte_crypto_op``. +* bbdev: ``RTE_BBDEV_OP_TYPE_COUNT`` terminating the +``rte_bbdev_op_type`` + enum will be deprecated and instead use fixed array size when +required to allow for + future enum extension. + Will extend API to support new operation type ``RTE_BBDEV_OP_FFT`` as +per this + RFC +https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fpatch +work.dpdk.org%2Fproject%2Fdpdk%2Flist%2F%3Fseries%3D22111&da ta=05%7 +C01%7Chemant.agrawal%40nxp.com%7Ce8c1b946f9ba4152d02d08da49b1 5297%7C686 +ea1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C637903323196944926%7C Unknown%7C +TWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwi LCJXVCI +6Mn0%3D%7C3000%7C%7C%7C&sdata=zDwsoIF4tF0eP2py43nwUHUz pS3XlDTQDiRMd
doc/guides/rel_notes/deprecation.rst +5
-0+JxBqwg%3D&reserved=0 + New members will be added in ``rte_bbdev_driver_info`` to expose PMD +queue topology inspired + by this RFC +https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fpatch +es.dpdk.org%2Fproject%2Fdpdk%2Flist%2F%3Fseries%3D22076&data= 05%7C0 +1%7Chemant.agrawal%40nxp.com%7Ce8c1b946f9ba4152d02d08da49b152 97%7C686ea +1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C637903323196944926%7CUn known%7CTW +FpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJ XVCI6M +n0%3D%7C3000%7C%7C%7C&sdata=tx8iueWoLEbbCyFQFQHKsvs9nkib c0ANem5dyai
doc/guides/rel_notes/deprecation.rst +5
-0+mspQ%3D&reserved=0 + New member will be added in ``rte_bbdev_driver_info`` to expose the +device status as per + this RFC +https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fpatch +es.dpdk.org%2Fproject%2Fdpdk%2Flist%2F%3Fseries%3D23367&data= 05%7C0 +1%7Chemant.agrawal%40nxp.com%7Ce8c1b946f9ba4152d02d08da49b152 97%7C686ea +1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C637903323196944926%7CUn known%7CTW +FpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJ XVCI6M +n0%3D%7C3000%7C%7C%7C&sdata=rHnuL7B63SoFIIo1M4kdRnnDm0 xqmCwML8CEo%2
doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 128
Quoted 6 lines
doc/guides/rel_notes/deprecation.rst +3
-0+BsxDBA%3D&reserved=0 + This should be updated in DPDK 22.11. + * security: Hide structure ``rte_security_session`` and expose an opaque pointer for the private data to the application which can be attached to the packet while enqueuing.
Hi Nicolas,
Quoted 22 lines · Nicolas Chautru
Intent to resolve in DPDK 22.11 historical usage which prevents graceful extension of enum and API without troublesome ABI breakage as well as extending API
RTE_BBDEV_OP_FFTfor new operation type in bbdev as well as other new members in existing structures.Signed-off-by Nicolas Chautru <[email protected]>--- doc/guides/rel_notes/deprecation.rst | 11 +++++++++++ 1 file changed, 11 insertions(+)doc/guides/rel_notes/deprecation.rst +4
-0@@ -112,6 +112,17 @@ Deprecation Notices session and the private data of session. An opaque pointer can be exposed directly to application which can be attached to the ``rte_crypto_op``. +* bbdev: ``RTE_BBDEV_OP_TYPE_COUNT`` terminating the ``rte_bbdev_op_type`` + enum will be deprecated and instead use fixed array size when required to allow for + future enum extension. + Will extend API to support new operation type ``RTE_BBDEV_OP_FFT`` as per this
doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 128
Quoted 10 lines
doc/guides/rel_notes/deprecation.rst +7
-0+ RFC https://patchwork.dpdk.org/project/dpdk/list/?series=22111 + New members will be added in ``rte_bbdev_driver_info`` to expose PMD queue topology inspired + by this RFC https://patches.dpdk.org/project/dpdk/list/?series=22076 + New member will be added in ``rte_bbdev_driver_info`` to expose the device status as per + this RFC https://patches.dpdk.org/project/dpdk/list/?series=23367 + This should be updated in DPDK 22.11. + * security: Hide structure ``rte_security_session`` and expose an opaque pointer for the private data to the application which can be attached to the packet while enqueuing.
Thanks for rewording the notice.
Maxime
Hi Thomas,
Can this one be applied based on your review?
Thanks
Nic
Quoted 59 lines
-----Original Message-----
From: Maxime Coquelin <[email protected]>
Sent: Thursday, June 9, 2022 12:54 AM
To: Chautru, Nicolas <[email protected]>; [email protected]; [email protected]; [email protected]
Cc: [email protected]; Kinsella, Ray <[email protected]>; Richardson, Bruce <[email protected]>; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH v4] doc: announce changes in bbdev related to enum extensionHi Nicolas,
Quoted 29 lines · Nicolas Chautru
Intent to resolve in DPDK 22.11 historical usage which prevents graceful extension of enum and API without troublesome ABI breakage as well as extending API
RTE_BBDEV_OP_FFTfor new operation type in bbdev as well as other new members in existing structures.Signed-off-by Nicolas Chautru <[email protected]>--- doc/guides/rel_notes/deprecation.rst | 11 +++++++++++ 1 file changed, 11 insertions(+)doc/guides/rel_notes/deprecation.rst +10
-0@@ -112,6 +112,17 @@ Deprecation Notices session and the private data of session. An opaque pointer can be exposed directly to application which can be attached to the ``rte_crypto_op``. +* bbdev: ``RTE_BBDEV_OP_TYPE_COUNT`` terminating the +``rte_bbdev_op_type`` + enum will be deprecated and instead use fixed array size when +required to allow for + future enum extension. + Will extend API to support new operation type ``RTE_BBDEV_OP_FFT`` +as per this + RFC https://patchwork.dpdk.org/project/dpdk/list/?series=22111 + New members will be added in ``rte_bbdev_driver_info`` to expose +PMD queue topology inspireddoc/guides/rel_notes/deprecation.rst Deprecation Notices
Quoted 10 lines
doc/guides/rel_notes/deprecation.rst +7
-0+ by this RFC +https://patches.dpdk.org/project/dpdk/list/?series=22076 + New member will be added in ``rte_bbdev_driver_info`` to expose the +device status as per + this RFC https://patches.dpdk.org/project/dpdk/list/?series=23367 + This should be updated in DPDK 22.11. + * security: Hide structure ``rte_security_session`` and expose an opaque pointer for the private data to the application which can be attached to the packet while enqueuing.Thanks for rewording the notice.
Acked-by Maxime Coquelin <[email protected]>Maxime
Hi Thomas,
Kind reminder on this one.
Thanks
Nic
Quoted 77 lines
-----Original Message-----
From: Chautru, Nicolas
Sent: Friday, June 17, 2022 9:13 AM
To: [email protected]; [email protected]
Cc: [email protected]; Kinsella, Ray <[email protected]>; Richardson, Bruce <[email protected]>; [email protected]; [email protected]; [email protected]; Maxime Coquelin <[email protected]>; [email protected]
Subject: RE: [PATCH v4] doc: announce changes in bbdev related to enum extensionHi Thomas,
Can this one be applied based on your review?
Thanks
NicQuoted 25 lines
-----Original Message-----
From: Maxime Coquelin <[email protected]>
Sent: Thursday, June 9, 2022 12:54 AM
To: Chautru, Nicolas <[email protected]>; [email protected]; [email protected]; [email protected]
Cc: [email protected]; Kinsella, Ray <[email protected]>; Richardson, Bruce <[email protected]>; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH v4] doc: announce changes in bbdev related to enum extensionHi Nicolas,
Quoted 10 lines · Nicolas Chautru
Intent to resolve in DPDK 22.11 historical usage which prevents graceful extension of enum and API without troublesome ABI breakage as well as extending API
RTE_BBDEV_OP_FFTfor new operation type in bbdev as well as other new members in existing structures.Signed-off-by Nicolas Chautru <[email protected]>--- doc/guides/rel_notes/deprecation.rst | 11 +++++++++++ 1 file changed, 11 insertions(+)Quoted 7 lines
doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 112
Quoted 7 lines
doc/guides/rel_notes/deprecation.rst +0
-0@@ -112,6 +112,17 @@ Deprecation Notices session and the private data of session. An opaque pointer can beexposed
Quoted 28 lines
Quoted 12 lines
doc/guides/rel_notes/deprecation.rst +10
-0directly to application which can be attached to the ``rte_crypto_op``. +* bbdev: ``RTE_BBDEV_OP_TYPE_COUNT`` terminating the +``rte_bbdev_op_type`` + enum will be deprecated and instead use fixed array size when +required to allow for + future enum extension. + Will extend API to support new operation type +``RTE_BBDEV_OP_FFT`` as per this + RFC https://patchwork.dpdk.org/project/dpdk/list/?series=22111 + New members will be added in ``rte_bbdev_driver_info`` to expose +PMD queue topology inspireddoc/guides/rel_notes/deprecation.rst Deprecation Notices
Quoted 10 lines
doc/guides/rel_notes/deprecation.rst +7
-0+ by this RFC +https://patches.dpdk.org/project/dpdk/list/?series=22076 + New member will be added in ``rte_bbdev_driver_info`` to expose +the device status as per + this RFC https://patches.dpdk.org/project/dpdk/list/?series=23367 + This should be updated in DPDK 22.11. + * security: Hide structure ``rte_security_session`` and expose an opaque pointer for the private data to the application which can be attached to the packet while enqueuing.Thanks for rewording the notice.
Acked-by Maxime Coquelin <[email protected]>Maxime
Hi Thomas,
Any concern with that deprecation notice please?
Thanks
Nic
Quoted 99 lines
-----Original Message-----
From: Chautru, Nicolas <[email protected]>
Sent: Monday, June 27, 2022 1:48 PM
To: [email protected]; [email protected]
Cc: [email protected]; Kinsella, Ray <[email protected]>; Richardson, Bruce <[email protected]>; [email protected]; [email protected]; [email protected]; Maxime Coquelin <[email protected]>; [email protected]
Subject: RE: [PATCH v4] doc: announce changes in bbdev related to enum extensionHi Thomas,
Kind reminder on this one.
Thanks
NicQuoted 12 lines
-----Original Message-----
From: Chautru, Nicolas
Sent: Friday, June 17, 2022 9:13 AM
To: [email protected]; [email protected]
Cc: [email protected]; Kinsella, Ray <[email protected]>; Richardson, Bruce <[email protected]>; [email protected]; [email protected]; [email protected]; Maxime Coquelin <[email protected]>; [email protected]
Subject: RE: [PATCH v4] doc: announce changes in bbdev related to enum extensionQuoted 24 lines
Hi Thomas,
Can this one be applied based on your review?
Thanks
NicQuoted 19 lines
-----Original Message-----
From: Maxime Coquelin <[email protected]>
Sent: Thursday, June 9, 2022 12:54 AM
To: Chautru, Nicolas <[email protected]>; [email protected]; [email protected]; [email protected]
Cc: [email protected]; Kinsella, Ray <[email protected]>; Richardson, Bruce <[email protected]>; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH v4] doc: announce changes in bbdev related to enum extensionHi Nicolas,
Quoted 4 lines · Nicolas Chautru
Intent to resolve in DPDK 22.11 historical usage which prevents graceful extension of enum and API without troublesome ABI breakage as well as extending API
RTE_BBDEV_OP_FFTfor new operation type in bbdev as well as other new members in existingstructures.
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Signed-off-by Nicolas Chautru <[email protected]>--- doc/guides/rel_notes/deprecation.rst | 11 +++++++++++ 1 file changed, 11 insertions(+)Quoted 10 lines
Quoted 8 lines
Quoted 8 lines
doc/guides/rel_notes/deprecation.rst +0
-0@@ -112,6 +112,17 @@ Deprecation Notices session and the private data of session. An opaque pointer canbe
exposed
Quoted 1 line
Quoted 1 line
directly to application which can be attached to the
``rte_crypto_op``.
Quoted 12 lines
Quoted 12 lines
Quoted 12 lines
doc/guides/rel_notes/deprecation.rst +11
-0+* bbdev: ``RTE_BBDEV_OP_TYPE_COUNT`` terminating the +``rte_bbdev_op_type`` + enum will be deprecated and instead use fixed array size when +required to allow for + future enum extension. + Will extend API to support new operation type +``RTE_BBDEV_OP_FFT`` as per this + RFC https://patchwork.dpdk.org/project/dpdk/list/?series=22111 + New members will be added in ``rte_bbdev_driver_info`` to +expose PMD queue topology inspired + by this RFCQuoted 8 lines
Quoted 8 lines
doc/guides/rel_notes/deprecation.rst
Quoted 8 lines
doc/guides/rel_notes/deprecation.rst +7
-0+https://patches.dpdk.org/project/dpdk/list/?series=22076 + New member will be added in ``rte_bbdev_driver_info`` to expose +the device status as per + this RFC +https://patches.dpdk.org/project/dpdk/list/?series=23367 + This should be updated in DPDK 22.11. + * security: Hide structure ``rte_security_session`` and expose anopaque
Quoted 8 lines
Quoted 8 lines
Quoted 2 lines
pointer for the private data to the application which can be attached to the packet while enqueuing.
Thanks for rewording the notice.
Acked-by Maxime Coquelin <[email protected]>Maxime
Quoted 7 lines · Nicolas Chautru
Intent to resolve in DPDK 22.11 historical usage which prevents graceful extension of enum and API without troublesome ABI breakage as well as extending API
RTE_BBDEV_OP_FFTfor new operation type in bbdev as well as other new members in existing structures.Signed-off-by Nicolas Chautru <[email protected]>---
Thomas Monjalon
Acked-by Hemant Agrawal Acked-by Maxime Coquelin Acked-by Bruce Richardson on v4 1/109/06/2022 02:34, Nicolas Chautru:
Quoted 6 lines
Intent to resolve in DPDK 22.11 historical usage which prevents graceful extension of enum and API without troublesome ABI breakage as well as extending API
RTE_BBDEV_OP_FFTfor new operation type in bbdev as well as other new members in existing structures.Signed-off-by Nicolas Chautru <[email protected]>
Improved links and applied, thanks.