ethdev: remove deprecated port count function

Message ID 20191028104934.21174-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series ethdev: remove deprecated port count function |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-compilation success Compile Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/Intel-compilation fail Compilation issues
ci/travis-robot success Travis build: passed

Commit Message

Thomas Monjalon Oct. 28, 2019, 10:49 a.m. UTC
  The function rte_eth_dev_count() was marked as deprecated in DPDK 18.05
in commit d9a42a69febf ("ethdev: deprecate port count function").
It was planned to be removed after 19.11 LTS release,
but given we must not break ABI between 19.11 and 20.11,
it is removed now.

Note the ABI version is not dumped in this commit
because other changes already did.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/rel_notes/deprecation.rst     |  5 -----
 doc/guides/rel_notes/release_19_11.rst   |  5 +++++
 lib/librte_ethdev/rte_ethdev.c           |  6 ------
 lib/librte_ethdev/rte_ethdev.h           | 15 ---------------
 lib/librte_ethdev/rte_ethdev_version.map |  1 -
 5 files changed, 5 insertions(+), 27 deletions(-)
  

Comments

David Marchand Oct. 28, 2019, 11:05 a.m. UTC | #1
On Mon, Oct 28, 2019 at 11:50 AM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> The function rte_eth_dev_count() was marked as deprecated in DPDK 18.05
> in commit d9a42a69febf ("ethdev: deprecate port count function").
> It was planned to be removed after 19.11 LTS release,
> but given we must not break ABI between 19.11 and 20.11,
> it is removed now.
>
> Note the ABI version is not dumped in this commit
> because other changes already did.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  doc/guides/rel_notes/deprecation.rst     |  5 -----
>  doc/guides/rel_notes/release_19_11.rst   |  5 +++++
>  lib/librte_ethdev/rte_ethdev.c           |  6 ------
>  lib/librte_ethdev/rte_ethdev.h           | 15 ---------------
>  lib/librte_ethdev/rte_ethdev_version.map |  1 -
>  5 files changed, 5 insertions(+), 27 deletions(-)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 4249aab833..c10dc301b2 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -48,11 +48,6 @@ Deprecation Notices
>    structure would be made internal (or removed if all dependencies are cleared)
>    in future releases.
>
> -* ethdev: The function ``rte_eth_dev_count`` will be removed in DPDK 20.02.
> -  It is replaced by the function ``rte_eth_dev_count_avail``.
> -  If the intent is to iterate over ports, ``RTE_ETH_FOREACH_*`` macros
> -  are better port iterators.
> -
>  * ethdev: the legacy filter API, including
>    ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
>    as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
> diff --git a/doc/guides/rel_notes/release_19_11.rst b/doc/guides/rel_notes/release_19_11.rst
> index ae8e7b2f09..fdba8af04a 100644
> --- a/doc/guides/rel_notes/release_19_11.rst
> +++ b/doc/guides/rel_notes/release_19_11.rst
> @@ -333,6 +333,11 @@ API Changes
>  * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
>    ``int`` to provide a way to report various error conditions.
>
> +* ethdev: The deprecated function ``rte_eth_dev_count`` was removed.
> +  The function ``rte_eth_dev_count_avail`` is a drop-in replacement.
> +  If the intent is to iterate over ports, ``RTE_ETH_FOREACH_*`` macros
> +  are better port iterators.
> +
>  * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
>    input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
>    has been introduced in this release is used when used when all the packets
> diff --git a/lib/librte_ethdev/rte_ethdev.c b/lib/librte_ethdev/rte_ethdev.c
> index 7743205d38..809da09cfc 100644
> --- a/lib/librte_ethdev/rte_ethdev.c
> +++ b/lib/librte_ethdev/rte_ethdev.c
> @@ -772,12 +772,6 @@ rte_eth_dev_get_sec_ctx(uint16_t port_id)
>         return rte_eth_devices[port_id].security_ctx;
>  }
>
> -uint16_t
> -rte_eth_dev_count(void)
> -{
> -       return rte_eth_dev_count_avail();
> -}
> -
>  uint16_t
>  rte_eth_dev_count_avail(void)
>  {
> diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
> index c36c1b631f..98b1db8a6e 100644
> --- a/lib/librte_ethdev/rte_ethdev.h
> +++ b/lib/librte_ethdev/rte_ethdev.h
> @@ -1653,21 +1653,6 @@ __rte_experimental
>  int rte_eth_dev_owner_get(const uint16_t port_id,
>                 struct rte_eth_dev_owner *owner);
>
> -/**
> - * Get the total number of Ethernet devices that have been successfully
> - * initialized by the matching Ethernet driver during the PCI probing phase
> - * and that are available for applications to use. These devices must be
> - * accessed by using the ``RTE_ETH_FOREACH_DEV()`` macro to deal with
> - * non-contiguous ranges of devices.
> - * These non-contiguous ranges can be created by calls to hotplug functions or
> - * by some PMDs.
> - *
> - * @return
> - *   - The total number of usable Ethernet devices.
> - */
> -__rte_deprecated
> -uint16_t rte_eth_dev_count(void);
> -
>  /**
>   * Get the number of ports which are usable for the application.
>   *
> diff --git a/lib/librte_ethdev/rte_ethdev_version.map b/lib/librte_ethdev/rte_ethdev_version.map
> index e59d51648f..4b31668a55 100644
> --- a/lib/librte_ethdev/rte_ethdev_version.map
> +++ b/lib/librte_ethdev/rte_ethdev_version.map
> @@ -12,7 +12,6 @@ DPDK_2.2 {
>         rte_eth_dev_callback_unregister;
>         rte_eth_dev_close;
>         rte_eth_dev_configure;
> -       rte_eth_dev_count;
>         rte_eth_dev_default_mac_addr_set;
>         rte_eth_dev_filter_supported;
>         rte_eth_dev_flow_ctrl_get;
> --
> 2.23.0
>

Reviewed-by: David Marchand <david.marchand@redhat.com>
  
Andrew Rybchenko Oct. 28, 2019, 11:38 a.m. UTC | #2
On 10/28/19 1:49 PM, Thomas Monjalon wrote:
> The function rte_eth_dev_count() was marked as deprecated in DPDK 18.05
> in commit d9a42a69febf ("ethdev: deprecate port count function").
> It was planned to be removed after 19.11 LTS release,
> but given we must not break ABI between 19.11 and 20.11,
> it is removed now.
>
> Note the ABI version is not dumped in this commit
> because other changes already did.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Reviewed-by: Andrew Rybchenko <arybchenko@solarflare.com>
  
Neil Horman Oct. 28, 2019, 1:03 p.m. UTC | #3
On Mon, Oct 28, 2019 at 11:49:34AM +0100, Thomas Monjalon wrote:
> The function rte_eth_dev_count() was marked as deprecated in DPDK 18.05
> in commit d9a42a69febf ("ethdev: deprecate port count function").
> It was planned to be removed after 19.11 LTS release,
> but given we must not break ABI between 19.11 and 20.11,
> it is removed now.
> 
> Note the ABI version is not dumped in this commit
> because other changes already did.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  doc/guides/rel_notes/deprecation.rst     |  5 -----
>  doc/guides/rel_notes/release_19_11.rst   |  5 +++++
>  lib/librte_ethdev/rte_ethdev.c           |  6 ------
>  lib/librte_ethdev/rte_ethdev.h           | 15 ---------------
>  lib/librte_ethdev/rte_ethdev_version.map |  1 -
>  5 files changed, 5 insertions(+), 27 deletions(-)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 4249aab833..c10dc301b2 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -48,11 +48,6 @@ Deprecation Notices
>    structure would be made internal (or removed if all dependencies are cleared)
>    in future releases.
>  
> -* ethdev: The function ``rte_eth_dev_count`` will be removed in DPDK 20.02.
> -  It is replaced by the function ``rte_eth_dev_count_avail``.
> -  If the intent is to iterate over ports, ``RTE_ETH_FOREACH_*`` macros
> -  are better port iterators.
> -
>  * ethdev: the legacy filter API, including
>    ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
>    as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
> diff --git a/doc/guides/rel_notes/release_19_11.rst b/doc/guides/rel_notes/release_19_11.rst
> index ae8e7b2f09..fdba8af04a 100644
> --- a/doc/guides/rel_notes/release_19_11.rst
> +++ b/doc/guides/rel_notes/release_19_11.rst
> @@ -333,6 +333,11 @@ API Changes
>  * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
>    ``int`` to provide a way to report various error conditions.
>  
> +* ethdev: The deprecated function ``rte_eth_dev_count`` was removed.
> +  The function ``rte_eth_dev_count_avail`` is a drop-in replacement.
> +  If the intent is to iterate over ports, ``RTE_ETH_FOREACH_*`` macros
> +  are better port iterators.
> +
>  * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
>    input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
>    has been introduced in this release is used when used when all the packets
> diff --git a/lib/librte_ethdev/rte_ethdev.c b/lib/librte_ethdev/rte_ethdev.c
> index 7743205d38..809da09cfc 100644
> --- a/lib/librte_ethdev/rte_ethdev.c
> +++ b/lib/librte_ethdev/rte_ethdev.c
> @@ -772,12 +772,6 @@ rte_eth_dev_get_sec_ctx(uint16_t port_id)
>  	return rte_eth_devices[port_id].security_ctx;
>  }
>  
> -uint16_t
> -rte_eth_dev_count(void)
> -{
> -	return rte_eth_dev_count_avail();
> -}
> -
>  uint16_t
>  rte_eth_dev_count_avail(void)
>  {
> diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
> index c36c1b631f..98b1db8a6e 100644
> --- a/lib/librte_ethdev/rte_ethdev.h
> +++ b/lib/librte_ethdev/rte_ethdev.h
> @@ -1653,21 +1653,6 @@ __rte_experimental
>  int rte_eth_dev_owner_get(const uint16_t port_id,
>  		struct rte_eth_dev_owner *owner);
>  
> -/**
> - * Get the total number of Ethernet devices that have been successfully
> - * initialized by the matching Ethernet driver during the PCI probing phase
> - * and that are available for applications to use. These devices must be
> - * accessed by using the ``RTE_ETH_FOREACH_DEV()`` macro to deal with
> - * non-contiguous ranges of devices.
> - * These non-contiguous ranges can be created by calls to hotplug functions or
> - * by some PMDs.
> - *
> - * @return
> - *   - The total number of usable Ethernet devices.
> - */
> -__rte_deprecated
> -uint16_t rte_eth_dev_count(void);
> -
>  /**
>   * Get the number of ports which are usable for the application.
>   *
> diff --git a/lib/librte_ethdev/rte_ethdev_version.map b/lib/librte_ethdev/rte_ethdev_version.map
> index e59d51648f..4b31668a55 100644
> --- a/lib/librte_ethdev/rte_ethdev_version.map
> +++ b/lib/librte_ethdev/rte_ethdev_version.map
> @@ -12,7 +12,6 @@ DPDK_2.2 {
>  	rte_eth_dev_callback_unregister;
>  	rte_eth_dev_close;
>  	rte_eth_dev_configure;
> -	rte_eth_dev_count;
>  	rte_eth_dev_default_mac_addr_set;
>  	rte_eth_dev_filter_supported;
>  	rte_eth_dev_flow_ctrl_get;
> -- 
> 2.23.0
> 
> 
Acked-by: Neil Horman <nhorman@tuxdriver.com>
  
Jerin Jacob Oct. 29, 2019, 8:43 a.m. UTC | #4
On Mon, Oct 28, 2019 at 5:09 PM Andrew Rybchenko
<arybchenko@solarflare.com> wrote:
>
> On 10/28/19 1:49 PM, Thomas Monjalon wrote:
> > The function rte_eth_dev_count() was marked as deprecated in DPDK 18.05
> > in commit d9a42a69febf ("ethdev: deprecate port count function").
> > It was planned to be removed after 19.11 LTS release,
> > but given we must not break ABI between 19.11 and 20.11,
> > it is removed now.
> >
> > Note the ABI version is not dumped in this commit
> > because other changes already did.
> >
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Reviewed-by: Jerin Jacob <jerinj@marvell.com>
  
Ferruh Yigit Oct. 31, 2019, 6:52 p.m. UTC | #5
On 10/28/2019 1:03 PM, Neil Horman wrote:
> On Mon, Oct 28, 2019 at 11:49:34AM +0100, Thomas Monjalon wrote:
>> The function rte_eth_dev_count() was marked as deprecated in DPDK 18.05
>> in commit d9a42a69febf ("ethdev: deprecate port count function").
>> It was planned to be removed after 19.11 LTS release,
>> but given we must not break ABI between 19.11 and 20.11,
>> it is removed now.
>>
>> Note the ABI version is not dumped in this commit
>> because other changes already did.
>>
>> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
>
> Acked-by: Neil Horman <nhorman@tuxdriver.com>
> 

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

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 4249aab833..c10dc301b2 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -48,11 +48,6 @@  Deprecation Notices
   structure would be made internal (or removed if all dependencies are cleared)
   in future releases.
 
-* ethdev: The function ``rte_eth_dev_count`` will be removed in DPDK 20.02.
-  It is replaced by the function ``rte_eth_dev_count_avail``.
-  If the intent is to iterate over ports, ``RTE_ETH_FOREACH_*`` macros
-  are better port iterators.
-
 * ethdev: the legacy filter API, including
   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
diff --git a/doc/guides/rel_notes/release_19_11.rst b/doc/guides/rel_notes/release_19_11.rst
index ae8e7b2f09..fdba8af04a 100644
--- a/doc/guides/rel_notes/release_19_11.rst
+++ b/doc/guides/rel_notes/release_19_11.rst
@@ -333,6 +333,11 @@  API Changes
 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
   ``int`` to provide a way to report various error conditions.
 
+* ethdev: The deprecated function ``rte_eth_dev_count`` was removed.
+  The function ``rte_eth_dev_count_avail`` is a drop-in replacement.
+  If the intent is to iterate over ports, ``RTE_ETH_FOREACH_*`` macros
+  are better port iterators.
+
 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
   input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
   has been introduced in this release is used when used when all the packets
diff --git a/lib/librte_ethdev/rte_ethdev.c b/lib/librte_ethdev/rte_ethdev.c
index 7743205d38..809da09cfc 100644
--- a/lib/librte_ethdev/rte_ethdev.c
+++ b/lib/librte_ethdev/rte_ethdev.c
@@ -772,12 +772,6 @@  rte_eth_dev_get_sec_ctx(uint16_t port_id)
 	return rte_eth_devices[port_id].security_ctx;
 }
 
-uint16_t
-rte_eth_dev_count(void)
-{
-	return rte_eth_dev_count_avail();
-}
-
 uint16_t
 rte_eth_dev_count_avail(void)
 {
diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
index c36c1b631f..98b1db8a6e 100644
--- a/lib/librte_ethdev/rte_ethdev.h
+++ b/lib/librte_ethdev/rte_ethdev.h
@@ -1653,21 +1653,6 @@  __rte_experimental
 int rte_eth_dev_owner_get(const uint16_t port_id,
 		struct rte_eth_dev_owner *owner);
 
-/**
- * Get the total number of Ethernet devices that have been successfully
- * initialized by the matching Ethernet driver during the PCI probing phase
- * and that are available for applications to use. These devices must be
- * accessed by using the ``RTE_ETH_FOREACH_DEV()`` macro to deal with
- * non-contiguous ranges of devices.
- * These non-contiguous ranges can be created by calls to hotplug functions or
- * by some PMDs.
- *
- * @return
- *   - The total number of usable Ethernet devices.
- */
-__rte_deprecated
-uint16_t rte_eth_dev_count(void);
-
 /**
  * Get the number of ports which are usable for the application.
  *
diff --git a/lib/librte_ethdev/rte_ethdev_version.map b/lib/librte_ethdev/rte_ethdev_version.map
index e59d51648f..4b31668a55 100644
--- a/lib/librte_ethdev/rte_ethdev_version.map
+++ b/lib/librte_ethdev/rte_ethdev_version.map
@@ -12,7 +12,6 @@  DPDK_2.2 {
 	rte_eth_dev_callback_unregister;
 	rte_eth_dev_close;
 	rte_eth_dev_configure;
-	rte_eth_dev_count;
 	rte_eth_dev_default_mac_addr_set;
 	rte_eth_dev_filter_supported;
 	rte_eth_dev_flow_ctrl_get;