[v3,29/29] ethdev: allow close function to return an error
Checks
Commit Message
The API function rte_eth_dev_close() was returning void.
The return type is changed to int for notifying of errors.
If an error happens during a close operation,
the status of the port is undefined,
a maximum of resources having been freed.
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Reviewed-by: Liron Himi <lironh@marvell.com>
---
doc/guides/rel_notes/deprecation.rst | 1 -
doc/guides/rel_notes/release_20_11.rst | 4 +++-
drivers/net/cxgbe/cxgbe_ethdev.c | 5 +++--
drivers/net/cxgbe/cxgbevf_ethdev.c | 5 +++--
drivers/net/failsafe/failsafe_ether.c | 6 +++++-
drivers/net/failsafe/failsafe_ops.c | 5 ++++-
drivers/net/memif/rte_eth_memif.c | 4 +---
drivers/net/mlx5/mlx5.c | 7 ++++---
drivers/net/mvneta/mvneta_ethdev.c | 5 +++--
drivers/net/mvpp2/mrvl_ethdev.c | 5 +++--
drivers/net/netvsc/hn_ethdev.c | 6 ++++--
drivers/net/netvsc/hn_var.h | 2 +-
drivers/net/netvsc/hn_vf.c | 7 +++++--
drivers/net/virtio/virtio_user_ethdev.c | 4 +---
lib/librte_ethdev/rte_ethdev.c | 13 ++++++++-----
lib/librte_ethdev/rte_ethdev.h | 5 ++++-
16 files changed, 52 insertions(+), 32 deletions(-)
Comments
On 9/29/20 2:14 AM, Thomas Monjalon wrote:
> The API function rte_eth_dev_close() was returning void.
> The return type is changed to int for notifying of errors.
>
> If an error happens during a close operation,
> the status of the port is undefined,
> a maximum of resources having been freed.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> Reviewed-by: Liron Himi <lironh@marvell.com>
[snip]
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index d07b4eeb47..1a61bd671a 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -135,7 +135,6 @@ Deprecation Notices
> invalid port ID, unsupported operation, failed operation):
>
> - ``rte_eth_dev_stop``
> - - ``rte_eth_dev_close``
Many thanks for continuing my unfinished job.
>
> * ethdev: New offload flags ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
> This will allow application to enable or disable PMDs from updating
[snip]
> diff --git a/drivers/net/mvneta/mvneta_ethdev.c b/drivers/net/mvneta/mvneta_ethdev.c
> index 607771149a..13d4b6af6b 100644
> --- a/drivers/net/mvneta/mvneta_ethdev.c
> +++ b/drivers/net/mvneta/mvneta_ethdev.c
> @@ -964,14 +964,15 @@ static int
> rte_pmd_mvneta_remove(struct rte_vdev_device *vdev)
> {
> uint16_t port_id;
> + int ret = 0;
>
> RTE_ETH_FOREACH_DEV(port_id) {
> if (rte_eth_devices[port_id].device != &vdev->device)
> continue;
> - rte_eth_dev_close(port_id);
> + ret = rte_eth_dev_close(port_id);
I guess |= should be used here as well (similar as above).
> }
>
> - return 0;
> + return ret == 0 ? 0 : -EIO;
> }
>
> static struct rte_vdev_driver pmd_mvneta_drv = {
> diff --git a/drivers/net/mvpp2/mrvl_ethdev.c b/drivers/net/mvpp2/mrvl_ethdev.c
> index a230a96840..acc8c70a95 100644
> --- a/drivers/net/mvpp2/mrvl_ethdev.c
> +++ b/drivers/net/mvpp2/mrvl_ethdev.c
> @@ -3022,14 +3022,15 @@ static int
> rte_pmd_mrvl_remove(struct rte_vdev_device *vdev)
> {
> uint16_t port_id;
> + int ret = 0;
>
> RTE_ETH_FOREACH_DEV(port_id) {
> if (rte_eth_devices[port_id].device != &vdev->device)
> continue;
> - rte_eth_dev_close(port_id);
> + ret = rte_eth_dev_close(port_id);
I guess |= should be used here as well (similar as above).
> }
>
> - return 0;
> + return ret == 0 ? 0 : -EIO;
> }
>
> static struct rte_vdev_driver pmd_mrvl_drv = {
[snip]
> diff --git a/lib/librte_ethdev/rte_ethdev.c b/lib/librte_ethdev/rte_ethdev.c
> index e68943b461..1459ac1ad5 100644
> --- a/lib/librte_ethdev/rte_ethdev.c
> +++ b/lib/librte_ethdev/rte_ethdev.c
> @@ -1704,19 +1704,22 @@ rte_eth_dev_set_link_down(uint16_t port_id)
> return eth_err(port_id, (*dev->dev_ops->dev_set_link_down)(dev));
> }
>
> -void
> +int
> rte_eth_dev_close(uint16_t port_id)
> {
> struct rte_eth_dev *dev;
> + int ret;
>
> - RTE_ETH_VALID_PORTID_OR_RET(port_id);
> + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
> dev = &rte_eth_devices[port_id];
>
> - RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_close);
> - (*dev->dev_ops->dev_close)(dev);
> + RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
> + ret = (*dev->dev_ops->dev_close)(dev);
>
> rte_ethdev_trace_close(port_id);
> - rte_eth_dev_release_port(dev);
> + ret = rte_eth_dev_release_port(dev);
It does not look good that it overwrites close return status.
> +
> + return ret;
> }
>
> int
[snip]
29/09/2020 13:05, Andrew Rybchenko:
> On 9/29/20 2:14 AM, Thomas Monjalon wrote:
> > The API function rte_eth_dev_close() was returning void.
> > The return type is changed to int for notifying of errors.
> >
> > If an error happens during a close operation,
> > the status of the port is undefined,
> > a maximum of resources having been freed.
[...]
> > @@ -135,7 +135,6 @@ Deprecation Notices
> > invalid port ID, unsupported operation, failed operation):
> >
> > - ``rte_eth_dev_stop``
> > - - ``rte_eth_dev_close``
>
> Many thanks for continuing my unfinished job.
It is not finished.
Would you take rte_eth_dev_stop?
> > rte_pmd_mvneta_remove(struct rte_vdev_device *vdev)
> > {
> > uint16_t port_id;
> > + int ret = 0;
> >
> > RTE_ETH_FOREACH_DEV(port_id) {
> > if (rte_eth_devices[port_id].device != &vdev->device)
> > continue;
> > - rte_eth_dev_close(port_id);
> > + ret = rte_eth_dev_close(port_id);
>
> I guess |= should be used here as well (similar as above).
Yes
> > -void
> > +int
> > rte_eth_dev_close(uint16_t port_id)
> > {
> > struct rte_eth_dev *dev;
> > + int ret;
> >
> > - RTE_ETH_VALID_PORTID_OR_RET(port_id);
> > + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
> > dev = &rte_eth_devices[port_id];
> >
> > - RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_close);
> > - (*dev->dev_ops->dev_close)(dev);
> > + RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
> > + ret = (*dev->dev_ops->dev_close)(dev);
> >
> > rte_ethdev_trace_close(port_id);
> > - rte_eth_dev_release_port(dev);
> > + ret = rte_eth_dev_release_port(dev);
>
> It does not look good that it overwrites close return status.
Indeed, it seems I did not finish this patch,
or maybe I was drunk ;)
What do you think is the best strategy?
I think we must call rte_eth_dev_release_port()
even if dev_close returns an error.
Then which error to return? I would return the first non-zero one.
On 9/29/20 2:47 PM, Thomas Monjalon wrote:
> 29/09/2020 13:05, Andrew Rybchenko:
>> On 9/29/20 2:14 AM, Thomas Monjalon wrote:
>>> The API function rte_eth_dev_close() was returning void.
>>> The return type is changed to int for notifying of errors.
>>>
>>> If an error happens during a close operation,
>>> the status of the port is undefined,
>>> a maximum of resources having been freed.
> [...]
>>> @@ -135,7 +135,6 @@ Deprecation Notices
>>> invalid port ID, unsupported operation, failed operation):
>>>
>>> - ``rte_eth_dev_stop``
>>> - - ``rte_eth_dev_close``
>>
>> Many thanks for continuing my unfinished job.
>
> It is not finished.
> Would you take rte_eth_dev_stop?
Sorry, I can't promise that I find time. I'll try.
If anyone else is ready, welcome.
>>> -void
>>> +int
>>> rte_eth_dev_close(uint16_t port_id)
>>> {
>>> struct rte_eth_dev *dev;
>>> + int ret;
>>>
>>> - RTE_ETH_VALID_PORTID_OR_RET(port_id);
>>> + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
>>> dev = &rte_eth_devices[port_id];
>>>
>>> - RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_close);
>>> - (*dev->dev_ops->dev_close)(dev);
>>> + RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
>>> + ret = (*dev->dev_ops->dev_close)(dev);
>>>
>>> rte_ethdev_trace_close(port_id);
>>> - rte_eth_dev_release_port(dev);
>>> + ret = rte_eth_dev_release_port(dev);
>>
>> It does not look good that it overwrites close return status.
>
> Indeed, it seems I did not finish this patch,
> or maybe I was drunk ;)
>
> What do you think is the best strategy?
> I think we must call rte_eth_dev_release_port()
> even if dev_close returns an error.
> Then which error to return? I would return the first non-zero one.
Yes, exactly. Return the first non-zero error code.
@@ -135,7 +135,6 @@ Deprecation Notices
invalid port ID, unsupported operation, failed operation):
- ``rte_eth_dev_stop``
- - ``rte_eth_dev_close``
* ethdev: New offload flags ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
This will allow application to enable or disable PMDs from updating
@@ -156,7 +156,9 @@ API Changes
* ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
-* Renamed internal ethdev APIs:
+* ethdev: Added ``int`` return type to ``rte_eth_dev_close()``.
+
+* ethdev: Renamed internal functions:
* ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
* ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
@@ -1296,12 +1296,13 @@ static int eth_cxgbe_dev_uninit(struct rte_eth_dev *eth_dev)
{
struct rte_pci_device *pci_dev = RTE_ETH_DEV_TO_PCI(eth_dev);
uint16_t port_id;
+ int err = 0;
/* Free up other ports and all resources */
RTE_ETH_FOREACH_DEV_OF(port_id, &pci_dev->device)
- rte_eth_dev_close(port_id);
+ err |= rte_eth_dev_close(port_id);
- return 0;
+ return err == 0 ? 0 : -EIO;
}
static int eth_cxgbe_pci_probe(struct rte_pci_driver *pci_drv __rte_unused,
@@ -183,12 +183,13 @@ static int eth_cxgbevf_dev_uninit(struct rte_eth_dev *eth_dev)
{
struct rte_pci_device *pci_dev = RTE_ETH_DEV_TO_PCI(eth_dev);
uint16_t port_id;
+ int err = 0;
/* Free up other ports and all resources */
RTE_ETH_FOREACH_DEV_OF(port_id, &pci_dev->device)
- rte_eth_dev_close(port_id);
+ err |= rte_eth_dev_close(port_id);
- return 0;
+ return err == 0 ? 0 : -EIO;
}
static int eth_cxgbevf_pci_probe(struct rte_pci_driver *pci_drv __rte_unused,
@@ -287,7 +287,11 @@ fs_dev_remove(struct sub_device *sdev)
/* fallthrough */
case DEV_ACTIVE:
failsafe_eth_dev_unregister_callbacks(sdev);
- rte_eth_dev_close(PORT_ID(sdev));
+ ret = rte_eth_dev_close(PORT_ID(sdev));
+ if (ret < 0) {
+ ERROR("Port close failed for sub-device %u",
+ PORT_ID(sdev));
+ }
sdev->state = DEV_PROBED;
/* fallthrough */
case DEV_PROBED:
@@ -648,7 +648,10 @@ failsafe_eth_dev_close(struct rte_eth_dev *dev)
FOREACH_SUBDEV_STATE(sdev, i, dev, DEV_ACTIVE) {
DEBUG("Closing sub_device %d", i);
failsafe_eth_dev_unregister_callbacks(sdev);
- rte_eth_dev_close(PORT_ID(sdev));
+ ret = rte_eth_dev_close(PORT_ID(sdev));
+ if (ret)
+ ERROR("Error while closing sub-device %u",
+ PORT_ID(sdev));
sdev->state = DEV_ACTIVE - 1;
}
rte_eth_dev_callback_unregister(RTE_ETH_ALL, RTE_ETH_EVENT_NEW,
@@ -1798,9 +1798,7 @@ rte_pmd_memif_remove(struct rte_vdev_device *vdev)
if (eth_dev == NULL)
return 0;
- rte_eth_dev_close(eth_dev->data->port_id);
-
- return 0;
+ return rte_eth_dev_close(eth_dev->data->port_id);
}
static struct rte_vdev_driver pmd_memif_drv = {
@@ -2010,6 +2010,7 @@ static int
mlx5_pci_remove(struct rte_pci_device *pci_dev)
{
uint16_t port_id;
+ int ret = 0;
RTE_ETH_FOREACH_DEV_OF(port_id, &pci_dev->device) {
/*
@@ -2017,11 +2018,11 @@ mlx5_pci_remove(struct rte_pci_device *pci_dev)
* call the close function explicitly for secondary process.
*/
if (rte_eal_process_type() == RTE_PROC_SECONDARY)
- mlx5_dev_close(&rte_eth_devices[port_id]);
+ ret |= mlx5_dev_close(&rte_eth_devices[port_id]);
else
- rte_eth_dev_close(port_id);
+ ret |= rte_eth_dev_close(port_id);
}
- return 0;
+ return ret == 0 ? 0 : -EIO;
}
static const struct rte_pci_id mlx5_pci_id_map[] = {
@@ -964,14 +964,15 @@ static int
rte_pmd_mvneta_remove(struct rte_vdev_device *vdev)
{
uint16_t port_id;
+ int ret = 0;
RTE_ETH_FOREACH_DEV(port_id) {
if (rte_eth_devices[port_id].device != &vdev->device)
continue;
- rte_eth_dev_close(port_id);
+ ret = rte_eth_dev_close(port_id);
}
- return 0;
+ return ret == 0 ? 0 : -EIO;
}
static struct rte_vdev_driver pmd_mvneta_drv = {
@@ -3022,14 +3022,15 @@ static int
rte_pmd_mrvl_remove(struct rte_vdev_device *vdev)
{
uint16_t port_id;
+ int ret = 0;
RTE_ETH_FOREACH_DEV(port_id) {
if (rte_eth_devices[port_id].device != &vdev->device)
continue;
- rte_eth_dev_close(port_id);
+ ret = rte_eth_dev_close(port_id);
}
- return 0;
+ return ret == 0 ? 0 : -EIO;
}
static struct rte_vdev_driver pmd_mrvl_drv = {
@@ -841,14 +841,16 @@ hn_dev_stop(struct rte_eth_dev *dev)
static int
hn_dev_close(struct rte_eth_dev *dev)
{
+ int ret;
+
PMD_INIT_FUNC_TRACE();
if (rte_eal_process_type() != RTE_PROC_PRIMARY)
return 0;
- hn_vf_close(dev);
+ ret = hn_vf_close(dev);
hn_dev_free_queues(dev);
- return 0;
+ return ret;
}
static const struct eth_dev_ops hn_eth_dev_ops = {
@@ -217,7 +217,7 @@ const uint32_t *hn_vf_supported_ptypes(struct rte_eth_dev *dev);
int hn_vf_start(struct rte_eth_dev *dev);
void hn_vf_reset(struct rte_eth_dev *dev);
void hn_vf_stop(struct rte_eth_dev *dev);
-void hn_vf_close(struct rte_eth_dev *dev);
+int hn_vf_close(struct rte_eth_dev *dev);
int hn_vf_allmulticast_enable(struct rte_eth_dev *dev);
int hn_vf_allmulticast_disable(struct rte_eth_dev *dev);
@@ -316,18 +316,21 @@ void hn_vf_reset(struct rte_eth_dev *dev)
VF_ETHDEV_FUNC(dev, rte_eth_dev_reset);
}
-void hn_vf_close(struct rte_eth_dev *dev)
+int hn_vf_close(struct rte_eth_dev *dev)
{
struct hn_data *hv = dev->data->dev_private;
uint16_t vf_port;
+ int ret = 0;
rte_rwlock_read_lock(&hv->vf_lock);
vf_port = hv->vf_port;
if (vf_port != HN_INVALID_PORT)
- rte_eth_dev_close(vf_port);
+ ret = rte_eth_dev_close(vf_port);
hv->vf_port = HN_INVALID_PORT;
rte_rwlock_read_unlock(&hv->vf_lock);
+
+ return ret;
}
int hn_vf_stats_reset(struct rte_eth_dev *dev)
@@ -813,9 +813,7 @@ virtio_user_pmd_remove(struct rte_vdev_device *vdev)
return rte_eth_dev_release_port(eth_dev);
/* make sure the device is stopped, queues freed */
- rte_eth_dev_close(eth_dev->data->port_id);
-
- return 0;
+ return rte_eth_dev_close(eth_dev->data->port_id);
}
static struct rte_vdev_driver virtio_user_driver = {
@@ -1704,19 +1704,22 @@ rte_eth_dev_set_link_down(uint16_t port_id)
return eth_err(port_id, (*dev->dev_ops->dev_set_link_down)(dev));
}
-void
+int
rte_eth_dev_close(uint16_t port_id)
{
struct rte_eth_dev *dev;
+ int ret;
- RTE_ETH_VALID_PORTID_OR_RET(port_id);
+ RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
dev = &rte_eth_devices[port_id];
- RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_close);
- (*dev->dev_ops->dev_close)(dev);
+ RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
+ ret = (*dev->dev_ops->dev_close)(dev);
rte_ethdev_trace_close(port_id);
- rte_eth_dev_release_port(dev);
+ ret = rte_eth_dev_release_port(dev);
+
+ return ret;
}
int
@@ -2281,8 +2281,11 @@ int rte_eth_dev_set_link_down(uint16_t port_id);
*
* @param port_id
* The port identifier of the Ethernet device.
+ * @return
+ * - Zero if the port is closed successfully.
+ * - Negative if something went wrong.
*/
-void rte_eth_dev_close(uint16_t port_id);
+int rte_eth_dev_close(uint16_t port_id);
/**
* Reset a Ethernet device and keep its port id.