Skip to contentSkip to conversation

Promote some API to stable

PATCH In review Haiyue Wang 4 participants 12 messages Sep 1, 2021 – Sep 15, 2021 Network drivers

lore
Share & tools
lore
#0 lore raw

cover Promote some API to stable

According to DPDK ABI Policy, section 3.5.3.
https://doc.dpdk.org/guides/contributing/abi_policy.html

Promote some API reported by DPDK Symbol Bot to stable.

Haiyue Wang (3):
net/ixgbe: promote some API to stable
net/ice: promote some API to stable
ethdev: promote burst mode API to stable

 drivers/net/ice/rte_pmd_ice.h     |  3 ---
 drivers/net/ice/version.map       | 11 ++++-------
 drivers/net/ixgbe/rte_pmd_ixgbe.h |  5 -----
 drivers/net/ixgbe/version.map     | 10 +++++-----
 lib/ethdev/rte_ethdev.h           |  2 --
 lib/ethdev/version.map            |  4 ++--
 6 files changed, 11 insertions(+), 24 deletions(-)
Signature · 1 line
2.33.0
#1 lore raw

PATCH 1/3 net/ixgbe: promote some API to stable

The DPDK Symbol Bot reports:
Please note the symbols listed below have expired. In line with the DPDK ABI policy, they should be scheduled for removal, in the next DPDK release.

Symbol
rte_pmd_ixgbe_mdio_lock
rte_pmd_ixgbe_mdio_unlock
rte_pmd_ixgbe_mdio_unlocked_read
rte_pmd_ixgbe_mdio_unlocked_write
rte_pmd_ixgbe_upd_fctrl_sbp

---
 drivers/net/ixgbe/rte_pmd_ixgbe.h |  5 -----
 drivers/net/ixgbe/version.map     | 10 +++++-----
 2 files changed, 5 insertions(+), 10 deletions(-)
drivers/net/ixgbe/rte_pmd_ixgbe.h +0 -5
index 90fc8160b1..7fcdbe7452 100644
@@ -586,7 +586,6 @@ int rte_pmd_ixgbe_bypass_wd_reset(uint16_t port);
  *   - (-ENODEV) if *port* invalid.
  *   - (IXGBE_ERR_SWFW_SYNC) If sw/fw semaphore acquisition failed
  */
-__rte_experimental
 int
 rte_pmd_ixgbe_mdio_lock(uint16_t port);
 
@@ -600,7 +599,6 @@ rte_pmd_ixgbe_mdio_lock(uint16_t port);
  *   - (-ENOTSUP) if hardware doesn't support.
  *   - (-ENODEV) if *port* invalid.
  */
-__rte_experimental
 int
 rte_pmd_ixgbe_mdio_unlock(uint16_t port);
 
@@ -622,7 +620,6 @@ rte_pmd_ixgbe_mdio_unlock(uint16_t port);
  *   - (-ENODEV) if *port* invalid.
  *   - (IXGBE_ERR_PHY) If PHY read command failed
  */
-__rte_experimental
 int
 rte_pmd_ixgbe_mdio_unlocked_read(uint16_t port, uint32_t reg_addr,
 				 uint32_t dev_type, uint16_t *phy_data);
@@ -646,7 +643,6 @@ rte_pmd_ixgbe_mdio_unlocked_read(uint16_t port, uint32_t reg_addr,
  *   - (-ENODEV) if *port* invalid.
  *   - (IXGBE_ERR_PHY) If PHY read command failed
  */
-__rte_experimental
 int
 rte_pmd_ixgbe_mdio_unlocked_write(uint16_t port, uint32_t reg_addr,
 				  uint32_t dev_type, uint16_t phy_data);
@@ -725,7 +721,6 @@ enum {
  *   - (-ENODEV) if *port* invalid.
  *   - (-ENOTSUP) if hardware doesn't support this feature.
  */
-__rte_experimental
 int
 rte_pmd_ixgbe_upd_fctrl_sbp(uint16_t port, int enable);
 
drivers/net/ixgbe/version.map +5 -5
index bca5cc5826..f0f29d8749 100644
@@ -16,6 +16,10 @@ DPDK_22 {
 	rte_pmd_ixgbe_macsec_enable;
 	rte_pmd_ixgbe_macsec_select_rxsa;
 	rte_pmd_ixgbe_macsec_select_txsa;
+	rte_pmd_ixgbe_mdio_lock;
+	rte_pmd_ixgbe_mdio_unlock;
+	rte_pmd_ixgbe_mdio_unlocked_read;
+	rte_pmd_ixgbe_mdio_unlocked_write;
 	rte_pmd_ixgbe_ping_vf;
 	rte_pmd_ixgbe_set_all_queues_drop_en;
 	rte_pmd_ixgbe_set_tc_bw_alloc;
@@ -31,6 +35,7 @@ DPDK_22 {
 	rte_pmd_ixgbe_set_vf_vlan_filter;
 	rte_pmd_ixgbe_set_vf_vlan_insert;
 	rte_pmd_ixgbe_set_vf_vlan_stripq;
+	rte_pmd_ixgbe_upd_fctrl_sbp;
 
 	local: *;
 };
@@ -40,9 +45,4 @@ EXPERIMENTAL {
 
 	rte_pmd_ixgbe_get_fdir_info;
 	rte_pmd_ixgbe_get_fdir_stats;
-	rte_pmd_ixgbe_mdio_lock;
-	rte_pmd_ixgbe_mdio_unlock;
-	rte_pmd_ixgbe_mdio_unlocked_read;
-	rte_pmd_ixgbe_mdio_unlocked_write;
-	rte_pmd_ixgbe_upd_fctrl_sbp;
 };
Signature · 1 line
2.33.0
#2 lore raw

Re: [dpdk-dev] [PATCH v1 1/3] net/ixgbe: promote some API to stable

Quoted 11 lines · Haiyue Wang

The DPDK Symbol Bot reports:
Please note the symbols listed below have expired. In line with the DPDK ABI policy, they should be scheduled for removal, in the next DPDK release.

Symbol
rte_pmd_ixgbe_mdio_lock
rte_pmd_ixgbe_mdio_unlock
rte_pmd_ixgbe_mdio_unlocked_read
rte_pmd_ixgbe_mdio_unlocked_write
rte_pmd_ixgbe_upd_fctrl_sbp

I wonder if we should keep PMD specific APIs as experimental (Not talking about mbuf 'dynfield' / 'dynflag' APIs, we can promote them).

If an application is using PMD specific API, not sure if it will concern about PMD specific APIs.
And keeping PMD specific APIs lets us remove them as soon as we can, also adds additional discourage for users to use them.

Quoted 2 lines

<...>

#3 lore raw

Re: [dpdk-dev] [PATCH v1 1/3] net/ixgbe: promote some API to stable

Quoted 20 lines

-----Original Message-----
From: Yigit, Ferruh <[email protected]>
Sent: Wednesday, September 1, 2021 17:02
To: Wang, Haiyue <[email protected]>; [email protected]
Cc: [email protected]; [email protected]
Subject: Re: [dpdk-dev] [PATCH v1 1/3] net/ixgbe: promote some API to stable

Quoted 11 lines · Haiyue Wang

The DPDK Symbol Bot reports:
Please note the symbols listed below have expired. In line with the DPDK ABI policy, they should be scheduled for removal, in the next DPDK release.

Symbol
rte_pmd_ixgbe_mdio_lock
rte_pmd_ixgbe_mdio_unlock
rte_pmd_ixgbe_mdio_unlocked_read
rte_pmd_ixgbe_mdio_unlocked_write
rte_pmd_ixgbe_upd_fctrl_sbp

Quoted 2 lines

I wonder if we should keep PMD specific APIs as experimental (Not talking about mbuf 'dynfield' / 'dynflag' APIs, we can promote them).

Yes, makes sense.

Quoted 5 lines

If an application is using PMD specific API, not sure if it will concern about PMD specific APIs.
And keeping PMD specific APIs lets us remove them as soon as we can, also adds additional discourage for users to use them.

Can update this to DPDK ABI Policy, section 3.5.3.
https://doc.dpdk.org/guides/contributing/abi_policy.html

Quoted 7 lines
Quoted 3 lines

<...>

#4 lore raw

Re: [dpdk-dev] [PATCH v1 1/3] net/ixgbe: promote some API to stable

Quoted 26 lines · Haiyue
Quoted 20 lines

-----Original Message-----
From: Yigit, Ferruh <[email protected]>
Sent: Wednesday, September 1, 2021 17:02
To: Wang, Haiyue <[email protected]>; [email protected]
Cc: [email protected]; [email protected]
Subject: Re: [dpdk-dev] [PATCH v1 1/3] net/ixgbe: promote some API to stable

Quoted 11 lines · Haiyue Wang

The DPDK Symbol Bot reports:
Please note the symbols listed below have expired. In line with the DPDK ABI policy, they should be scheduled for removal, in the next DPDK release.

Symbol
rte_pmd_ixgbe_mdio_lock
rte_pmd_ixgbe_mdio_unlock
rte_pmd_ixgbe_mdio_unlocked_read
rte_pmd_ixgbe_mdio_unlocked_write
rte_pmd_ixgbe_upd_fctrl_sbp

Quoted 2 lines

I wonder if we should keep PMD specific APIs as experimental (Not talking about mbuf 'dynfield' / 'dynflag' APIs, we can promote them).

Yes, makes sense.

Quoted 1 line
Quoted 7 lines
Quoted 4 lines

If an application is using PMD specific API, not sure if it will concern about PMD specific APIs.
And keeping PMD specific APIs lets us remove them as soon as we can, also adds additional discourage for users to use them.

Can update this to DPDK ABI Policy, section 3.5.3.
https://doc.dpdk.org/guides/contributing/abi_policy.html

I understand and agree.
However we never made any exceptions for PMD specific APIs in the policy.

Leave them as experimental for the moment.
I will add a clause to the policy ....

Thomas / David - any opinion?

Quoted 9 lines
Quoted 8 lines
Quoted 4 lines

<...>

#5 lore raw

PATCH 2/3 net/ice: promote some API to stable

In reply to Haiyue Wang

The DPDK Symbol Bot reports:
Please note the symbols listed below have expired. In line with the DPDK ABI policy, they should be scheduled for removal, in the next DPDK release.

Symbol
rte_net_ice_dynfield_proto_xtr_metadata_offs
rte_net_ice_dynflag_proto_xtr_vlan_mask
rte_net_ice_dynflag_proto_xtr_ipv4_mask
rte_net_ice_dynflag_proto_xtr_ipv6_mask
rte_net_ice_dynflag_proto_xtr_ipv6_flow_mask
rte_net_ice_dynflag_proto_xtr_tcp_mask

---
 drivers/net/ice/rte_pmd_ice.h |  3 ---
 drivers/net/ice/version.map   | 11 ++++-------
 2 files changed, 4 insertions(+), 10 deletions(-)
drivers/net/ice/rte_pmd_ice.h +0 -3
index 9a436a140b..c0f19fcc89 100644
@@ -149,7 +149,6 @@ extern uint64_t rte_net_ice_dynflag_proto_xtr_ip_offset_mask;
  * @return
  *   True if registered, false otherwise.
  */
-__rte_experimental
 static __rte_always_inline int
 rte_net_ice_dynf_proto_xtr_metadata_avail(void)
 {
@@ -164,7 +163,6 @@ rte_net_ice_dynf_proto_xtr_metadata_avail(void)
  * @return
  *   The saved protocol extraction metadata.
  */
-__rte_experimental
 static __rte_always_inline uint32_t
 rte_net_ice_dynf_proto_xtr_metadata_get(struct rte_mbuf *m)
 {
@@ -177,7 +175,6 @@ rte_net_ice_dynf_proto_xtr_metadata_get(struct rte_mbuf *m)
  * @param m
  *    The pointer to the mbuf.
  */
-__rte_experimental
 static inline void
 rte_net_ice_dump_proto_xtr_metadata(struct rte_mbuf *m)
 {
drivers/net/ice/version.map +4 -7
index cc837f1c00..1a633fd95e 100644
@@ -1,16 +1,13 @@
 DPDK_22 {
-	local: *;
-};
-
-EXPERIMENTAL {
 	global:
 
-	# added in 19.11
 	rte_net_ice_dynfield_proto_xtr_metadata_offs;
-	rte_net_ice_dynflag_proto_xtr_vlan_mask;
+	rte_net_ice_dynflag_proto_xtr_ip_offset_mask;
 	rte_net_ice_dynflag_proto_xtr_ipv4_mask;
 	rte_net_ice_dynflag_proto_xtr_ipv6_mask;
 	rte_net_ice_dynflag_proto_xtr_ipv6_flow_mask;
 	rte_net_ice_dynflag_proto_xtr_tcp_mask;
-	rte_net_ice_dynflag_proto_xtr_ip_offset_mask;
+	rte_net_ice_dynflag_proto_xtr_vlan_mask;
+
+	local: *;
 };
Signature · 1 line
2.33.0
#6 lore raw

PATCH 3/3 ethdev: promote burst mode API to stable

In reply to Haiyue Wang

The DPDK Symbol Bot reports:
Please note the symbols listed below have expired. In line with the DPDK ABI policy, they should be scheduled for removal, in the next DPDK release.

Symbol
rte_eth_rx_burst_mode_get
rte_eth_tx_burst_mode_get

---
 lib/ethdev/rte_ethdev.h | 2 --
 lib/ethdev/version.map  | 4 ++--
 2 files changed, 2 insertions(+), 4 deletions(-)
lib/ethdev/rte_ethdev.h +0 -2
index d2b27c351f..3277e8f8fb 100644
@@ -4361,7 +4361,6 @@ int rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id,
  *   - -ENOTSUP: routine is not supported by the device PMD.
  *   - -EINVAL:  The queue_id is out of range.
  */
-__rte_experimental
 int rte_eth_rx_burst_mode_get(uint16_t port_id, uint16_t queue_id,
 	struct rte_eth_burst_mode *mode);
 
@@ -4383,7 +4382,6 @@ int rte_eth_rx_burst_mode_get(uint16_t port_id, uint16_t queue_id,
  *   - -ENOTSUP: routine is not supported by the device PMD.
  *   - -EINVAL:  The queue_id is out of range.
  */
-__rte_experimental
 int rte_eth_tx_burst_mode_get(uint16_t port_id, uint16_t queue_id,
 	struct rte_eth_burst_mode *mode);
 
lib/ethdev/version.map +2 -2
index 3eece75b72..6a12b0664a 100644
@@ -87,6 +87,7 @@ DPDK_22 {
 	rte_eth_promiscuous_get;
 	rte_eth_remove_rx_callback;
 	rte_eth_remove_tx_callback;
+	rte_eth_rx_burst_mode_get;
 	rte_eth_rx_queue_info_get;
 	rte_eth_rx_queue_setup;
 	rte_eth_set_queue_rate_limit;
@@ -104,6 +105,7 @@ DPDK_22 {
 	rte_eth_tx_buffer_drop_callback;
 	rte_eth_tx_buffer_init;
 	rte_eth_tx_buffer_set_err_callback;
+	rte_eth_tx_burst_mode_get;
 	rte_eth_tx_done_cleanup;
 	rte_eth_tx_queue_info_get;
 	rte_eth_tx_queue_setup;
@@ -166,9 +168,7 @@ EXPERIMENTAL {
 
 	# added in 19.11
 	rte_eth_dev_hairpin_capability_get;
-	rte_eth_rx_burst_mode_get;
 	rte_eth_rx_hairpin_queue_setup;
-	rte_eth_tx_burst_mode_get;
 	rte_eth_tx_hairpin_queue_setup;
 	rte_flow_dynf_metadata_offs;
 	rte_flow_dynf_metadata_mask;
Signature · 1 line
2.33.0
Acked-by on v1 3/3
#7 lore raw

Re: [dpdk-dev] [PATCH v1 3/3] ethdev: promote burst mode API to stable

Quoted 10 lines · Haiyue Wang

The DPDK Symbol Bot reports:
Please note the symbols listed below have expired. In line with the DPDK ABI policy, they should be scheduled for removal, in the next DPDK release.

Symbol
rte_eth_rx_burst_mode_get
rte_eth_tx_burst_mode_get

Acked-by
#8 lore raw

Re: [dpdk-dev] [PATCH v1 3/3] ethdev: promote burst mode API to stable

Quoted 6 lines · Ferruh Yigit
Quoted 5 lines · Haiyue Wang

The DPDK Symbol Bot reports:
Please note the symbols listed below have expired. In line with the DPDK ABI policy, they should be scheduled for removal, in the next DPDK release.

Quoted 8 lines
Quoted 5 lines

Symbol
rte_eth_rx_burst_mode_get
rte_eth_tx_burst_mode_get

#9 lore raw

PATCH v2 1/1 ethdev: promote burst mode API to stable

In reply to Haiyue Wang

The DPDK Symbol Bot reports:
Please note the symbols listed below have expired. In line with the DPDK ABI policy, they should be scheduled for removal, in the next DPDK release.

Symbol
rte_eth_rx_burst_mode_get
rte_eth_tx_burst_mode_get

---

v2: Drop the PMD API promote to stable

---
 lib/ethdev/rte_ethdev.h | 2 --
 lib/ethdev/version.map  | 4 ++--
 2 files changed, 2 insertions(+), 4 deletions(-)
lib/ethdev/rte_ethdev.h +0 -2
index d2b27c351f..3277e8f8fb 100644
@@ -4361,7 +4361,6 @@ int rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id,
  *   - -ENOTSUP: routine is not supported by the device PMD.
  *   - -EINVAL:  The queue_id is out of range.
  */
-__rte_experimental
 int rte_eth_rx_burst_mode_get(uint16_t port_id, uint16_t queue_id,
 	struct rte_eth_burst_mode *mode);
 
@@ -4383,7 +4382,6 @@ int rte_eth_rx_burst_mode_get(uint16_t port_id, uint16_t queue_id,
  *   - -ENOTSUP: routine is not supported by the device PMD.
  *   - -EINVAL:  The queue_id is out of range.
  */
-__rte_experimental
 int rte_eth_tx_burst_mode_get(uint16_t port_id, uint16_t queue_id,
 	struct rte_eth_burst_mode *mode);
 
lib/ethdev/version.map +2 -2
index 3eece75b72..6a12b0664a 100644
@@ -87,6 +87,7 @@ DPDK_22 {
 	rte_eth_promiscuous_get;
 	rte_eth_remove_rx_callback;
 	rte_eth_remove_tx_callback;
+	rte_eth_rx_burst_mode_get;
 	rte_eth_rx_queue_info_get;
 	rte_eth_rx_queue_setup;
 	rte_eth_set_queue_rate_limit;
@@ -104,6 +105,7 @@ DPDK_22 {
 	rte_eth_tx_buffer_drop_callback;
 	rte_eth_tx_buffer_init;
 	rte_eth_tx_buffer_set_err_callback;
+	rte_eth_tx_burst_mode_get;
 	rte_eth_tx_done_cleanup;
 	rte_eth_tx_queue_info_get;
 	rte_eth_tx_queue_setup;
@@ -166,9 +168,7 @@ EXPERIMENTAL {
 
 	# added in 19.11
 	rte_eth_dev_hairpin_capability_get;
-	rte_eth_rx_burst_mode_get;
 	rte_eth_rx_hairpin_queue_setup;
-	rte_eth_tx_burst_mode_get;
 	rte_eth_tx_hairpin_queue_setup;
 	rte_flow_dynf_metadata_offs;
 	rte_flow_dynf_metadata_mask;
Signature · 1 line
2.33.0
Acked-by on v2 1/1
#10 lore raw

Re: [dpdk-dev] [PATCH v2] ethdev: promote burst mode API to stable

Quoted 5 lines · Haiyue Wang

The DPDK Symbol Bot reports:
Please note the symbols listed below have expired. In line with the DPDK ABI policy, they should be scheduled for removal, in the next DPDK release.

Quoted 7 lines

Symbol
rte_eth_rx_burst_mode_get
rte_eth_tx_burst_mode_get

Applied
#11 lore raw

Re: [dpdk-dev] [PATCH v2] ethdev: promote burst mode API to stable

Quoted 10 lines · Andrew Rybchenko
Quoted 9 lines · Haiyue Wang

The DPDK Symbol Bot reports:
Please note the symbols listed below have expired. In line with the DPDK ABI policy, they should be scheduled for removal, in the next DPDK release.

Symbol
rte_eth_rx_burst_mode_get
rte_eth_tx_burst_mode_get

Quoted 6 lines
Quoted 3 lines

Applied to dpdk-next-net/main, thanks.