[dpdk-dev,v7,3/9] ethdev: add generic create/destroy ethdev APIs

Message ID 20180416130605.6509-4-declan.doherty@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail apply patch file failure

Commit Message

Doherty, Declan April 16, 2018, 1:05 p.m. UTC
Add new bus generic ethdev create/destroy APIs which are bus independent
and provide hooks for bus specific initialisation.

Signed-off-by: Declan Doherty <declan.doherty@intel.com>
---
 lib/librte_ether/rte_ethdev.c           | 95 ++++++++++++++++++++++++++++++++-
 lib/librte_ether/rte_ethdev_driver.h    | 57 ++++++++++++++++++++
 lib/librte_ether/rte_ethdev_pci.h       | 12 +++++
 lib/librte_ether/rte_ethdev_version.map |  8 +++
 4 files changed, 171 insertions(+), 1 deletion(-)
  

Comments

Ananyev, Konstantin April 20, 2018, 1:01 p.m. UTC | #1
Hi Declan,

> Add new bus generic ethdev create/destroy APIs which are bus independent
> and provide hooks for bus specific initialisation.
> 
> Signed-off-by: Declan Doherty <declan.doherty@intel.com>
> ---
>  lib/librte_ether/rte_ethdev.c           | 95 ++++++++++++++++++++++++++++++++-
>  lib/librte_ether/rte_ethdev_driver.h    | 57 ++++++++++++++++++++
>  lib/librte_ether/rte_ethdev_pci.h       | 12 +++++
>  lib/librte_ether/rte_ethdev_version.map |  8 +++
>  4 files changed, 171 insertions(+), 1 deletion(-)
> 
> diff --git a/lib/librte_ether/rte_ethdev.c b/lib/librte_ether/rte_ethdev.c
> index 3c049ef43..b16d23b9a 100644
> --- a/lib/librte_ether/rte_ethdev.c
> +++ b/lib/librte_ether/rte_ethdev.c
> @@ -348,7 +348,8 @@ rte_eth_dev_release_port(struct rte_eth_dev *eth_dev)
>  	rte_eth_dev_shared_data_prepare();
> 
>  	rte_spinlock_lock(&rte_eth_dev_shared_data->ownership_lock);
> -
> +	eth_dev->device = NULL;
> +	eth_dev->intr_handle = NULL;
>  	eth_dev->state = RTE_ETH_DEV_UNUSED;
> 
>  	memset(eth_dev->data, 0, sizeof(struct rte_eth_dev_data));
> @@ -3439,6 +3440,98 @@ rte_eth_dma_zone_reserve(const struct rte_eth_dev *dev, const char *ring_name,
>  			RTE_MEMZONE_IOVA_CONTIG, align);
>  }
> 
> +int __rte_experimental
> +rte_eth_dev_create(struct rte_device *device, const char *name,
> +	size_t priv_data_size,
> +	ethdev_bus_specific_init ethdev_bus_specific_init,
> +	void *bus_init_params,
> +	ethdev_init_t ethdev_init, void *init_params)
> +{
> +	struct rte_eth_dev *ethdev;
> +	int retval;
> +
> +	if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
> +		ethdev = rte_eth_dev_allocate(name);
> +		if (!ethdev) {
> +			retval = -ENODEV;
> +			goto probe_failed;
> +		}
> +
> +		if (priv_data_size) {
> +			ethdev->data->dev_private = rte_zmalloc_socket(
> +				name, priv_data_size, RTE_CACHE_LINE_SIZE,
> +				device->numa_node);
> +
> +			if (!ethdev->data->dev_private) {
> +				RTE_LOG(ERR, EAL, "failed to allocate private data");
> +				retval = -ENOMEM;
> +				goto probe_failed;
> +			}
> +		}
> +	} else {
> +		ethdev = rte_eth_dev_attach_secondary(name);
> +		if (!ethdev) {
> +			RTE_LOG(ERR, EAL, "secondary process attach failed, "
> +				"ethdev doesn't exist");
> +			retval = -ENODEV;
> +			goto probe_failed;
> +		}
> +	}
> +
> +	ethdev->device = device;
> +
> +	if (ethdev_bus_specific_init) {
> +		retval = ethdev_bus_specific_init(ethdev, bus_init_params);
> +		if (retval) {
> +			RTE_LOG(ERR, EAL,
> +				"ethdev bus specific initialisation failed");
> +			goto probe_failed;
> +		}
> +	}
> +
> +	RTE_FUNC_PTR_OR_ERR_RET(*ethdev_init, -EINVAL);

You probably have to do it at the start - before allocating ethdev, etc.

> +	retval = ethdev_init(ethdev, init_params);
> +	if (retval) {
> +		RTE_LOG(ERR, EAL, "ethdev initialisation failed");
> +		goto probe_failed;
> +	}
> +
> +	return retval;
> +probe_failed:
> +	/* free ports private data if primary process */
> +	if (rte_eal_process_type() == RTE_PROC_PRIMARY)
> +		rte_free(ethdev->data->dev_private);
> +
> +	rte_eth_dev_release_port(ethdev);
> +
> +	return retval;
> +}
> +
> +int  __rte_experimental
> +rte_eth_dev_destroy(struct rte_eth_dev *ethdev,
> +	ethdev_uninit_t ethdev_uninit)
> +{
> +	int ret;
> +
> +	ethdev = rte_eth_dev_allocated(ethdev->data->name);
> +	if (!ethdev)
> +		return -ENODEV;
> +
> +	RTE_FUNC_PTR_OR_ERR_RET(*ethdev_uninit, -EINVAL);
> +	if (ethdev_uninit) {
> +		ret = ethdev_uninit(ethdev);
> +		if (ret)
> +			return ret;
> +	}
> +
> +	if (rte_eal_process_type() == RTE_PROC_PRIMARY)
> +		rte_free(ethdev->data->dev_private);
> +
> +	ethdev->data->dev_private = NULL;
> +
> +	return rte_eth_dev_release_port(ethdev);
> +}
> +
>  int
>  rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
>  			  int epfd, int op, void *data)
> diff --git a/lib/librte_ether/rte_ethdev_driver.h b/lib/librte_ether/rte_ethdev_driver.h
> index a406ef123..e52add0ad 100644
> --- a/lib/librte_ether/rte_ethdev_driver.h
> +++ b/lib/librte_ether/rte_ethdev_driver.h
> @@ -188,6 +188,63 @@ rte_eth_linkstatus_get(const struct rte_eth_dev *dev,
>  #endif
>  }
> 
> +
> +typedef int (*ethdev_init_t)(struct rte_eth_dev *ethdev, void *init_params);
> +typedef int (*ethdev_bus_specific_init)(struct rte_eth_dev *ethdev,
> +	void *bus_specific_init_params);
> +
> +/**
> + * @warning
> + * @b EXPERIMENTAL: this API may change without prior notice.
> + *
> + * PMD helper function for the creation of a new ethdev ports.
> + *
> + * @param device
> + *  rte_device handle.
> + * @param	name
> + *  port name.
> + * @param priv_data_size
> + *  size of private data required for port.
> + * @param bus_specific_init
> + *  port bus specific initialisation callback function
> + * @param bus_init_params
> + *  port bus specific initialisation parameters
> + * @param ethdev_init
> + *  device specific port initialization callback function
> + * @param init_params
> + *  port initialisation parameters
> + *
> + * @return
> + *   Negative errno value on error, 0 on success.
> + */
> +int __rte_experimental
> +rte_eth_dev_create(struct rte_device *device, const char *name,
> +	size_t priv_data_size,
> +	ethdev_bus_specific_init bus_specific_init, void *bus_init_params,
> +	ethdev_init_t ethdev_init, void *init_params);
> +
> +
> +typedef int (*ethdev_uninit_t)(struct rte_eth_dev *ethdev);
> +
> +/**
> + * @warning
> + * @b EXPERIMENTAL: this API may change without prior notice.
> + *
> + * PMD helper function for cleaing up the resources of a ethdev port on it's
> + * destruction.
> + *
> + * @param ethdev
> + *   ethdev handle of port.
> + * @param ethdev
> + *   device specific port un-initialise callback function
> + *
> + * @return
> + *   Negative errno value on error, 0 on success.
> + */
> +int __rte_experimental
> +rte_eth_dev_destroy(struct rte_eth_dev *ethdev,
> +	ethdev_uninit_t ethdev_uninit);
> +
>  #ifdef __cplusplus
>  }
>  #endif
> diff --git a/lib/librte_ether/rte_ethdev_pci.h b/lib/librte_ether/rte_ethdev_pci.h
> index 6565ae7d3..603287c28 100644
> --- a/lib/librte_ether/rte_ethdev_pci.h
> +++ b/lib/librte_ether/rte_ethdev_pci.h
> @@ -70,6 +70,18 @@ rte_eth_copy_pci_info(struct rte_eth_dev *eth_dev,
>  	eth_dev->data->numa_node = pci_dev->device.numa_node;
>  }
> 
> +static inline int
> +eth_dev_pci_specific_init(struct rte_eth_dev *eth_dev, void *bus_device) {
> +	struct rte_pci_device *pci_dev = bus_device;
> +
> +	if (!pci_dev)
> +		return -ENODEV;
> +
> +	rte_eth_copy_pci_info(eth_dev, pci_dev);
> +
> +	return 0;
> +}
> +
>  /**
>   * @internal
>   * Allocates a new ethdev slot for an ethernet device and returns the pointer
> diff --git a/lib/librte_ether/rte_ethdev_version.map b/lib/librte_ether/rte_ethdev_version.map
> index 34df6c8b5..bd7232923 100644
> --- a/lib/librte_ether/rte_ethdev_version.map
> +++ b/lib/librte_ether/rte_ethdev_version.map
> @@ -229,3 +229,11 @@ EXPERIMENTAL {
>  	rte_mtr_stats_update;
> 
>  } DPDK_17.11;
> +
> +EXPERIMENTAL {
> +	global:
> +
> +	rte_eth_dev_create;
> +	rte_eth_dev_destroy;
> +
> +} DPDK_18.05;
> --
> 2.14.3
  
Thomas Monjalon April 24, 2018, 5:48 p.m. UTC | #2
16/04/2018 15:05, Declan Doherty:
> --- a/lib/librte_ether/rte_ethdev.c
> +++ b/lib/librte_ether/rte_ethdev.c
> @@ -348,7 +348,8 @@ rte_eth_dev_release_port(struct rte_eth_dev *eth_dev)
>  	rte_eth_dev_shared_data_prepare();
>  
>  	rte_spinlock_lock(&rte_eth_dev_shared_data->ownership_lock);
> -
> +	eth_dev->device = NULL;
> +	eth_dev->intr_handle = NULL;
>  	eth_dev->state = RTE_ETH_DEV_UNUSED;

Shouldn't it be in a separate patch with a proper explanation?


> + * @param device
> + *  rte_device handle.
> + * @param	name

There is a tab between param and name.


> --- a/lib/librte_ether/rte_ethdev_version.map
> +++ b/lib/librte_ether/rte_ethdev_version.map
> @@ -229,3 +229,11 @@ EXPERIMENTAL {
>  	rte_mtr_stats_update;
>  
>  } DPDK_17.11;
> +
> +EXPERIMENTAL {
> +	global:
> +
> +	rte_eth_dev_create;
> +	rte_eth_dev_destroy;
> +
> +} DPDK_18.05;

There is already an EXPERIMENTAL block.
Maybe you need to rebase.
  

Patch

diff --git a/lib/librte_ether/rte_ethdev.c b/lib/librte_ether/rte_ethdev.c
index 3c049ef43..b16d23b9a 100644
--- a/lib/librte_ether/rte_ethdev.c
+++ b/lib/librte_ether/rte_ethdev.c
@@ -348,7 +348,8 @@  rte_eth_dev_release_port(struct rte_eth_dev *eth_dev)
 	rte_eth_dev_shared_data_prepare();
 
 	rte_spinlock_lock(&rte_eth_dev_shared_data->ownership_lock);
-
+	eth_dev->device = NULL;
+	eth_dev->intr_handle = NULL;
 	eth_dev->state = RTE_ETH_DEV_UNUSED;
 
 	memset(eth_dev->data, 0, sizeof(struct rte_eth_dev_data));
@@ -3439,6 +3440,98 @@  rte_eth_dma_zone_reserve(const struct rte_eth_dev *dev, const char *ring_name,
 			RTE_MEMZONE_IOVA_CONTIG, align);
 }
 
+int __rte_experimental
+rte_eth_dev_create(struct rte_device *device, const char *name,
+	size_t priv_data_size,
+	ethdev_bus_specific_init ethdev_bus_specific_init,
+	void *bus_init_params,
+	ethdev_init_t ethdev_init, void *init_params)
+{
+	struct rte_eth_dev *ethdev;
+	int retval;
+
+	if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
+		ethdev = rte_eth_dev_allocate(name);
+		if (!ethdev) {
+			retval = -ENODEV;
+			goto probe_failed;
+		}
+
+		if (priv_data_size) {
+			ethdev->data->dev_private = rte_zmalloc_socket(
+				name, priv_data_size, RTE_CACHE_LINE_SIZE,
+				device->numa_node);
+
+			if (!ethdev->data->dev_private) {
+				RTE_LOG(ERR, EAL, "failed to allocate private data");
+				retval = -ENOMEM;
+				goto probe_failed;
+			}
+		}
+	} else {
+		ethdev = rte_eth_dev_attach_secondary(name);
+		if (!ethdev) {
+			RTE_LOG(ERR, EAL, "secondary process attach failed, "
+				"ethdev doesn't exist");
+			retval = -ENODEV;
+			goto probe_failed;
+		}
+	}
+
+	ethdev->device = device;
+
+	if (ethdev_bus_specific_init) {
+		retval = ethdev_bus_specific_init(ethdev, bus_init_params);
+		if (retval) {
+			RTE_LOG(ERR, EAL,
+				"ethdev bus specific initialisation failed");
+			goto probe_failed;
+		}
+	}
+
+	RTE_FUNC_PTR_OR_ERR_RET(*ethdev_init, -EINVAL);
+	retval = ethdev_init(ethdev, init_params);
+	if (retval) {
+		RTE_LOG(ERR, EAL, "ethdev initialisation failed");
+		goto probe_failed;
+	}
+
+	return retval;
+probe_failed:
+	/* free ports private data if primary process */
+	if (rte_eal_process_type() == RTE_PROC_PRIMARY)
+		rte_free(ethdev->data->dev_private);
+
+	rte_eth_dev_release_port(ethdev);
+
+	return retval;
+}
+
+int  __rte_experimental
+rte_eth_dev_destroy(struct rte_eth_dev *ethdev,
+	ethdev_uninit_t ethdev_uninit)
+{
+	int ret;
+
+	ethdev = rte_eth_dev_allocated(ethdev->data->name);
+	if (!ethdev)
+		return -ENODEV;
+
+	RTE_FUNC_PTR_OR_ERR_RET(*ethdev_uninit, -EINVAL);
+	if (ethdev_uninit) {
+		ret = ethdev_uninit(ethdev);
+		if (ret)
+			return ret;
+	}
+
+	if (rte_eal_process_type() == RTE_PROC_PRIMARY)
+		rte_free(ethdev->data->dev_private);
+
+	ethdev->data->dev_private = NULL;
+
+	return rte_eth_dev_release_port(ethdev);
+}
+
 int
 rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
 			  int epfd, int op, void *data)
diff --git a/lib/librte_ether/rte_ethdev_driver.h b/lib/librte_ether/rte_ethdev_driver.h
index a406ef123..e52add0ad 100644
--- a/lib/librte_ether/rte_ethdev_driver.h
+++ b/lib/librte_ether/rte_ethdev_driver.h
@@ -188,6 +188,63 @@  rte_eth_linkstatus_get(const struct rte_eth_dev *dev,
 #endif
 }
 
+
+typedef int (*ethdev_init_t)(struct rte_eth_dev *ethdev, void *init_params);
+typedef int (*ethdev_bus_specific_init)(struct rte_eth_dev *ethdev,
+	void *bus_specific_init_params);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice.
+ *
+ * PMD helper function for the creation of a new ethdev ports.
+ *
+ * @param device
+ *  rte_device handle.
+ * @param	name
+ *  port name.
+ * @param priv_data_size
+ *  size of private data required for port.
+ * @param bus_specific_init
+ *  port bus specific initialisation callback function
+ * @param bus_init_params
+ *  port bus specific initialisation parameters
+ * @param ethdev_init
+ *  device specific port initialization callback function
+ * @param init_params
+ *  port initialisation parameters
+ *
+ * @return
+ *   Negative errno value on error, 0 on success.
+ */
+int __rte_experimental
+rte_eth_dev_create(struct rte_device *device, const char *name,
+	size_t priv_data_size,
+	ethdev_bus_specific_init bus_specific_init, void *bus_init_params,
+	ethdev_init_t ethdev_init, void *init_params);
+
+
+typedef int (*ethdev_uninit_t)(struct rte_eth_dev *ethdev);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice.
+ *
+ * PMD helper function for cleaing up the resources of a ethdev port on it's
+ * destruction.
+ *
+ * @param ethdev
+ *   ethdev handle of port.
+ * @param ethdev
+ *   device specific port un-initialise callback function
+ *
+ * @return
+ *   Negative errno value on error, 0 on success.
+ */
+int __rte_experimental
+rte_eth_dev_destroy(struct rte_eth_dev *ethdev,
+	ethdev_uninit_t ethdev_uninit);
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/lib/librte_ether/rte_ethdev_pci.h b/lib/librte_ether/rte_ethdev_pci.h
index 6565ae7d3..603287c28 100644
--- a/lib/librte_ether/rte_ethdev_pci.h
+++ b/lib/librte_ether/rte_ethdev_pci.h
@@ -70,6 +70,18 @@  rte_eth_copy_pci_info(struct rte_eth_dev *eth_dev,
 	eth_dev->data->numa_node = pci_dev->device.numa_node;
 }
 
+static inline int
+eth_dev_pci_specific_init(struct rte_eth_dev *eth_dev, void *bus_device) {
+	struct rte_pci_device *pci_dev = bus_device;
+
+	if (!pci_dev)
+		return -ENODEV;
+
+	rte_eth_copy_pci_info(eth_dev, pci_dev);
+
+	return 0;
+}
+
 /**
  * @internal
  * Allocates a new ethdev slot for an ethernet device and returns the pointer
diff --git a/lib/librte_ether/rte_ethdev_version.map b/lib/librte_ether/rte_ethdev_version.map
index 34df6c8b5..bd7232923 100644
--- a/lib/librte_ether/rte_ethdev_version.map
+++ b/lib/librte_ether/rte_ethdev_version.map
@@ -229,3 +229,11 @@  EXPERIMENTAL {
 	rte_mtr_stats_update;
 
 } DPDK_17.11;
+
+EXPERIMENTAL {
+	global:
+
+	rte_eth_dev_create;
+	rte_eth_dev_destroy;
+
+} DPDK_18.05;