[dpdk-dev,v8,11/14] ethdev: Add one dev_type parameter to rte_eth_dev_allocate
Commit Message
This new parameter is needed to keep device type like physical or virtual.
Port detaching processes are different between physical and virtual.
This parameter lets detaching function know a device type of the port.
v8:
- NONE_TRACE is replaced by NO_TRACE.
- Add missing symbol in version map.
(Thanks to Qiu, Michael and Iremonger, Bernard)
v4:
- Fix comments of rte_eth_dev_type.
Signed-off-by: Tetsuya Mukawa <mukawa@igel.co.jp>
---
app/test/virtual_pmd.c | 2 +-
lib/librte_ether/rte_ethdev.c | 25 +++++++++++++++++++++++--
lib/librte_ether/rte_ethdev.h | 25 ++++++++++++++++++++++++-
lib/librte_ether/rte_ether_version.map | 1 +
lib/librte_pmd_af_packet/rte_eth_af_packet.c | 2 +-
lib/librte_pmd_bond/rte_eth_bond_api.c | 2 +-
lib/librte_pmd_pcap/rte_eth_pcap.c | 2 +-
lib/librte_pmd_ring/rte_eth_ring.c | 2 +-
lib/librte_pmd_xenvirt/rte_eth_xenvirt.c | 2 +-
9 files changed, 54 insertions(+), 9 deletions(-)
Comments
> -----Original Message-----
> From: Tetsuya Mukawa [mailto:mukawa@igel.co.jp]
> Sent: Monday, February 16, 2015 4:15 AM
> To: dev@dpdk.org
> Cc: Qiu, Michael; Iremonger, Bernard; Tetsuya Mukawa
> Subject: [PATCH v8 11/14] ethdev: Add one dev_type parameter to rte_eth_dev_allocate
>
> This new parameter is needed to keep device type like physical or virtual.
> Port detaching processes are different between physical and virtual.
> This parameter lets detaching function know a device type of the port.
>
> v8:
> - NONE_TRACE is replaced by NO_TRACE.
> - Add missing symbol in version map.
> (Thanks to Qiu, Michael and Iremonger, Bernard)
> v4:
> - Fix comments of rte_eth_dev_type.
>
> Signed-off-by: Tetsuya Mukawa <mukawa@igel.co.jp>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2015-02-16 13:14, Tetsuya Mukawa:
> This new parameter is needed to keep device type like physical or virtual.
Actually types are "PCI" and "virtual".
> Port detaching processes are different between physical and virtual.
> This parameter lets detaching function know a device type of the port.
I think the type should be guessed automatically thanks to register infos.
On 2015/02/17 10:24, Thomas Monjalon wrote:
> 2015-02-16 13:14, Tetsuya Mukawa:
>> This new parameter is needed to keep device type like physical or virtual.
> Actually types are "PCI" and "virtual".
OK, I will change above sentence to explain it more clearly.
>> Port detaching processes are different between physical and virtual.
>> This parameter lets detaching function know a device type of the port.
> I think the type should be guessed automatically thanks to register infos.
>
It seems I forgot rewrite this comment, I will change it.
This patch series adds a dynamic port hotplug framework to DPDK.
With the patches, DPDK apps can attach or detach ports at runtime.
The basic concept of the port hotplug is like followings.
- DPDK apps must have responsibility to manage ports.
DPDK apps only know which ports are attached or detached at the moment.
The port hotplug framework is implemented to allow DPDK apps to manage ports.
For example, when DPDK apps call port attach function, attached port number
will be returned. Also, DPDK apps can detach port by port number.
- Kernel support is needed for attaching or detaching physical device ports.
To attach a new physical device port, the device will be recognized by
userspace directly I/O framework in kernel at first. Then DPDK apps can
call the port hotplug functions to attach ports.
For detaching, steps are vice versa.
- Before detach ports, ports must be stopped and closed.
DPDK application must call rte_eth_dev_stop() and rte_eth_dev_close() before
detaching ports. These function will call finalization codes of PMDs.
But so far, no PMD frees all resources allocated by initialization.
It means PMDs are needed to be fixed to support the port hotplug.
'RTE_PCI_DRV_DETACHABLE' is a new flag indicating a PMD supports detaching.
Without this flag, detaching will be failed.
- Mustn't affect legacy DPDK apps.
No DPDK EAL behavior is changed, if the port hotplug functions are't called.
So all legacy DPDK apps can still work without modifications.
And a few limitations.
- The port hotplug functions are not thread safe.
DPDK apps should handle it.
- Only support Linux and igb_uio so far.
BSD and VFIO is not supported. I will send VFIO patches at least, but I don't
have a plan to submit BSD patch so far.
Here is port hotplug APIs.
-------------------------------------------------------------------------------
/**
* Attach a new device.
*
* @param devargs
* A pointer to a strings array describing the new device
* to be attached. The strings should be a pci address like
* '0000:01:00.0' or virtual device name like 'eth_pcap0'.
* @param port_id
* A pointer to a port identifier actually attached.
* @return
* 0 on success and port_id is filled, negative on error
*/
int rte_eal_dev_attach(const char *devargs, uint8_t *port_id);
/**
* Detach a device.
*
* @param port_id
* The port identifier of the device to detach.
* @param addr
* A pointer to a device name actually detached.
* @return
* 0 on success and devname is filled, negative on error
*/
int rte_eal_dev_detach(uint8_t port_id, char *devname);
-------------------------------------------------------------------------------
This patch series are for DPDK EAL. To use port hotplug function by DPDK apps,
each PMD should be fixed to support 'RTE_PCI_DRV_DETACHABLE' flag. Please check
a patch for pcap PMD.
Also, please check testpmd patch. It will show you how to fix your legacy
applications to support port hotplug feature.
PATCH v9 changes
- Fix commit title.
- Fix commit log.
- Fix comments.
- Define CONFIG_RTE_LIBRTE_EAL_HOTPLUG at the top of this patch series.
- DEV_INVALID/VALID are removed.
- DEV_DISCONNECTED is replaced by DEV_DETACHED.
- DEV_CONNECTED is replaced by DEV_ATTACHED.
- rte_eth_dev_allocate_new_port() is renamed to
rte_eth_dev_find_free_port().
- rte_eth_dev_validate_port() is renamed to rte_eth_dev_is_valid_port().
- rte_eth_dev_is_valid_port() is changed not to handle log toggle.
- eal_compare_pci_addr() is replaced by rte_eal_compare_pci_addr().
- rte_eth_dev_free() is replaced by rte_eth_dev_release_port().
- Add a function to create a unique device name.
- Change parameter of pci_devuninit_t and rte_eth_dev_uninit.
- Remove code that initiaize callback of ethdev from
rte_eth_dev_uninit().
- Remove pci_unmap_device(). It will be implemented in later patch.
- rte_eth_dev_check_detachable() is replaced by
rte_eth_dev_is_detachable().
- strncpy() is replaced by strcpy().
- Implement pci_unmap_device() in this patch.
- Remove "rte_dev_hotplug.h".
- Remove needless "#ifdef".
- Remove RTE_EAL_INVOKE_TYPE_PROBE/CLOSE.
- RTE_ETH_DEV_PHYSICAL is replaced by RTE_ETH_DEV_PCI.
- Use strcmp() instead of strncmp().
- Remove RTE_EAL_INVOKE_TYPE_PROBE/CLOSE.
(Thanks to Thomas Monjalon)
- Change definition of rte_dev_uninit_t.
(Thanks to Thomas Monjalon and Maxime Leroy)
- Add missing symbol in version map.
(Thanks to Nail Horman)
PATCH v8 changes
- Fix Makefile and add version map file.
- Add missing symbol in version map.
- Fix pci_scan_one() to update sysfs values.
(Thanks to Qiu, Michael and Iremonger, Bernard)
- NONE_TRACE is replaced by NO_TRACE.
- Fix typo.
- Add size parameter to rte_eth_dev_save().
(Thanks to Iremonger, Bernard)
PATCH v7 changes
- Add a new section to programmer's guide.
(Thanks to Iremonger, Bernard)
- Fix port checking implementation of star_port().
- Fix typo of warning messages.
- Add pt_driver checking to rte_eth_dev_check_detachable().
(Thanks to Qiu, Michael)
PATCH v6 changes
- Fix rte_eth_dev_uninit() to handle a return value of uninit
function of PMD. To do this, below changes also be applied.
- Fix a parameter of rte_eth_dev_free().
- Use rte_eth_dev structure as the paramter of rte_eth_dev_free().
PATCH v5 changes
- Add runtime check passthrough driver type, like vfio-pci, igb_uio
and uio_pci_generic.
This was done by Qiu, Michael. Thanks a lot.
- Change function names like below.
- rte_eal_dev_find_and_invoke() to rte_eal_vdev_find_and_invoke().
- rte_eal_dev_invoke() to rte_eal_vdev_invoke().
- Add code to handle a return value of rte_eal_devargs_remove().
- Fix pci address format in rte_eal_dev_detach().
- Remove RTE_EAL_INVOKE_TYPE_UNKNOWN, because it's unused.
- Change function definition of rte_eal_devargs_remove().
- Fix pci_unmap_device() to check pt_driver.
- Fix return value of below functions.
- rte_eth_dev_get_changed_port().
- rte_eth_dev_get_port_by_addr().
- Change paramters of rte_eth_dev_validate_port() to cleanup code.
- Fix pci_scan_one to handle pt_driver correctly.
(Thanks to Qiu, Michael for above suggestions)
PATCH v4 changes
- Merge patches to review easier.
- Fix indent of 'if' statement.
- Fix calculation method of eal_compare_pci_addr().
- Fix header file declaration.
- Add header file to determine if hotplug can be enabled.
(Thanks to Qiu, Michael)
- Use braces with 'for' loop.
- Add parameter checking.
- Fix sanity check code
- Fix comments of rte_eth_dev_type.
- Change function names.
(Thanks to Iremonger, Bernard)
PATCH v3 changes:
- Fix enum definition used in rte_ethdev.c.
(Thanks to Zhang, Helin)
PATCH v2 changes:
- Replace rte_eal_dev_attach_pdev(), rte_eal_dev_detach_pdev,
rte_eal_dev_attach_vdev() and rte_eal_dev_detach_vdev() to
rte_eal_dev_attach() and rte_eal_dev_detach().
- Add parameter values checking.
- Refashion a few functions.
(Thanks to Iremonger, Bernard)
PATCH v1 Changes:
- Fix error checking code of librte_eth APIs.
- Fix issue that port from pcap PMD cannot be detached correctly.
- Fix issue that testpmd could hang after forwarding, if attaching and detaching
is repeatedly.
- Fix if-condition of rte_eth_dev_get_port_by_addr().
(Thanks to Mark Enright)
RFC PATCH v2 Changes:
- remove 'rte_eth_dev_validate_port()', and cleanup codes.
Michael Qiu (2):
eal_pci: Add flag to hold kernel driver type
eal_pci: pci memory map work with driver type
Tetsuya Mukawa (12):
eal: Enable port Hotplug framework in Linux
eal/pci,ethdev: Remove assumption that port will not be detached
eal/pci: Consolidate pci address comparison APIs
ethdev: Add rte_eth_dev_release_port to release specified port
eal,ethdev: Add a function and function pointers to close ether device
ethdev: Add functions that will be used by port hotplug functions
eal/linux/pci: Add functions for unmapping igb_uio resources
eal/pci: Add a function to remove the entry of devargs list
eal/pci: Add probe and close functions of pci driver
ethdev: Add one dev_type parameter to rte_eth_dev_allocate
eal/pci: Add rte_eal_dev_attach/detach() functions
doc: Add port hotplug framework section to programmers guide
app/test/virtual_pmd.c | 2 +-
config/common_bsdapp | 6 +
config/common_linuxapp | 5 +
doc/guides/prog_guide/index.rst | 1 +
doc/guides/prog_guide/port_hotplug_framework.rst | 110 ++++++
lib/librte_eal/bsdapp/eal/eal_pci.c | 29 +-
lib/librte_eal/common/eal_common_dev.c | 307 +++++++++++++++
lib/librte_eal/common/eal_common_devargs.c | 61 +++
lib/librte_eal/common/eal_common_pci.c | 100 ++++-
lib/librte_eal/common/eal_private.h | 26 ++
lib/librte_eal/common/include/rte_dev.h | 33 ++
lib/librte_eal/common/include/rte_devargs.h | 21 +
lib/librte_eal/common/include/rte_pci.h | 82 ++++
lib/librte_eal/linuxapp/eal/Makefile | 1 +
lib/librte_eal/linuxapp/eal/eal_pci.c | 230 +++++++++--
lib/librte_eal/linuxapp/eal/eal_pci_init.h | 7 +
lib/librte_eal/linuxapp/eal/eal_pci_uio.c | 67 +++-
lib/librte_eal/linuxapp/eal/rte_eal_version.map | 2 +
lib/librte_ether/rte_ethdev.c | 474 +++++++++++++++++------
lib/librte_ether/rte_ethdev.h | 149 ++++++-
lib/librte_ether/rte_ether_version.map | 8 +
lib/librte_pmd_af_packet/rte_eth_af_packet.c | 2 +-
lib/librte_pmd_bond/rte_eth_bond_api.c | 2 +-
lib/librte_pmd_pcap/rte_eth_pcap.c | 2 +-
lib/librte_pmd_ring/rte_eth_ring.c | 2 +-
lib/librte_pmd_xenvirt/rte_eth_xenvirt.c | 2 +-
26 files changed, 1563 insertions(+), 168 deletions(-)
create mode 100644 doc/guides/prog_guide/port_hotplug_framework.rst
@@ -556,7 +556,7 @@ virtual_ethdev_create(const char *name, struct ether_addr *mac_addr,
goto err;
/* reserve an ethdev entry */
- eth_dev = rte_eth_dev_allocate(name);
+ eth_dev = rte_eth_dev_allocate(name, RTE_ETH_DEV_PHYSICAL);
if (eth_dev == NULL)
goto err;
@@ -232,7 +232,7 @@ rte_eth_dev_allocate_new_port(void)
}
struct rte_eth_dev *
-rte_eth_dev_allocate(const char *name)
+rte_eth_dev_allocate(const char *name, enum rte_eth_dev_type type)
{
uint8_t port_id;
struct rte_eth_dev *eth_dev;
@@ -256,6 +256,7 @@ rte_eth_dev_allocate(const char *name)
snprintf(eth_dev->data->name, sizeof(eth_dev->data->name), "%s", name);
eth_dev->data->port_id = port_id;
eth_dev->attached = DEV_CONNECTED;
+ eth_dev->dev_type = type;
nb_ports++;
return eth_dev;
}
@@ -267,6 +268,7 @@ rte_eth_dev_free(struct rte_eth_dev *eth_dev)
return -EINVAL;
eth_dev->attached = 0;
+ eth_dev->dev_type = RTE_ETH_DEV_UNKNOWN;
nb_ports--;
return 0;
}
@@ -287,7 +289,7 @@ rte_eth_dev_init(struct rte_pci_driver *pci_drv,
snprintf(ethdev_name, RTE_ETH_NAME_MAX_LEN, "%d:%d.%d",
pci_dev->addr.bus, pci_dev->addr.devid, pci_dev->addr.function);
- eth_dev = rte_eth_dev_allocate(ethdev_name);
+ eth_dev = rte_eth_dev_allocate(ethdev_name, RTE_ETH_DEV_PHYSICAL);
if (eth_dev == NULL)
return -ENOMEM;
@@ -426,6 +428,14 @@ rte_eth_dev_count(void)
return (nb_ports);
}
+enum rte_eth_dev_type
+rte_eth_dev_get_device_type(uint8_t port_id)
+{
+ if (rte_eth_dev_validate_port(port_id, NO_TRACE) == DEV_INVALID)
+ return -1;
+ return rte_eth_devices[port_id].dev_type;
+}
+
int
rte_eth_dev_save(struct rte_eth_dev *devs, size_t size)
{
@@ -519,6 +529,17 @@ rte_eth_dev_check_detachable(uint8_t port_id)
return -EINVAL;
}
+ if (rte_eth_devices[port_id].dev_type == RTE_ETH_DEV_PHYSICAL) {
+ switch (rte_eth_devices[port_id].pci_dev->pt_driver) {
+ case RTE_PT_IGB_UIO:
+ case RTE_PT_UIO_GENERIC:
+ break;
+ case RTE_PT_VFIO:
+ default:
+ return -ENOTSUP;
+ }
+ }
+
drv_flags = rte_eth_devices[port_id].driver->pci_drv.drv_flags;
return !(drv_flags & RTE_PCI_DRV_DETACHABLE);
}
@@ -1522,6 +1522,17 @@ struct eth_dev_ops {
};
/**
+ * The eth device type
+ */
+enum rte_eth_dev_type {
+ RTE_ETH_DEV_UNKNOWN, /**< unknown device type */
+ RTE_ETH_DEV_PHYSICAL,
+ /**< Physical function and Virtual function devices of NIC */
+ RTE_ETH_DEV_VIRTUAL, /**< non hardware device */
+ RTE_ETH_DEV_MAX /**< max value of this enum */
+};
+
+/**
* @internal
* The generic data structure associated with each ethernet device.
*
@@ -1540,6 +1551,7 @@ struct rte_eth_dev {
struct rte_pci_device *pci_dev; /**< PCI info. supplied by probing */
struct rte_eth_dev_cb_list callbacks; /**< User application callbacks */
uint8_t attached; /**< Flag indicating the port is attached */
+ enum rte_eth_dev_type dev_type; /**< Flag indicating the device type */
};
struct rte_eth_dev_sriov {
@@ -1617,6 +1629,15 @@ extern uint8_t rte_eth_dev_count(void);
/**
* Function for internal use by port hotplug functions.
+ * Get the device type to know whether the device is physical or virtual.
+ * @param port_id The pointer to the port id
+ * @return
+ * - Device type.
+ */
+extern enum rte_eth_dev_type rte_eth_dev_get_device_type(uint8_t port_id);
+
+/**
+ * Function for internal use by port hotplug functions.
* Copies current ethdev structures to the specified pointer.
*
* @param devs The pointer to the ethdev structures
@@ -1705,10 +1726,12 @@ extern struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
* to that slot for the driver to use.
*
* @param name Unique identifier name for each Ethernet device
+ * @param type Device type of this Ethernet device
* @return
* - Slot in the rte_dev_devices array for a new device;
*/
-struct rte_eth_dev *rte_eth_dev_allocate(const char *name);
+struct rte_eth_dev *rte_eth_dev_allocate(const char *name,
+ enum rte_eth_dev_type type);
/**
* Function for internal use by dummy drivers primarily, e.g. ring-based
@@ -115,6 +115,7 @@ DPDK_2.0 {
rte_eth_dev_get_port_by_addr;
rte_eth_dev_get_changed_port;
rte_eth_dev_save;
+ rte_eth_dev_get_device_type;
local: *;
};
@@ -649,7 +649,7 @@ rte_pmd_init_internals(const char *name,
}
/* reserve an ethdev entry */
- *eth_dev = rte_eth_dev_allocate(name);
+ *eth_dev = rte_eth_dev_allocate(name, RTE_ETH_DEV_VIRTUAL);
if (*eth_dev == NULL)
goto error;
@@ -235,7 +235,7 @@ rte_eth_bond_create(const char *name, uint8_t mode, uint8_t socket_id)
}
/* reserve an ethdev entry */
- eth_dev = rte_eth_dev_allocate(name);
+ eth_dev = rte_eth_dev_allocate(name, RTE_ETH_DEV_VIRTUAL);
if (eth_dev == NULL) {
RTE_BOND_LOG(ERR, "Unable to allocate rte_eth_dev");
goto err;
@@ -709,7 +709,7 @@ rte_pmd_init_internals(const char *name, const unsigned nb_rx_queues,
goto error;
/* reserve an ethdev entry */
- *eth_dev = rte_eth_dev_allocate(name);
+ *eth_dev = rte_eth_dev_allocate(name, RTE_ETH_DEV_VIRTUAL);
if (*eth_dev == NULL)
goto error;
@@ -255,7 +255,7 @@ rte_eth_from_rings(const char *name, struct rte_ring *const rx_queues[],
goto error;
/* reserve an ethdev entry */
- eth_dev = rte_eth_dev_allocate(name);
+ eth_dev = rte_eth_dev_allocate(name, RTE_ETH_DEV_VIRTUAL);
if (eth_dev == NULL)
goto error;
@@ -648,7 +648,7 @@ eth_dev_xenvirt_create(const char *name, const char *params,
goto err;
/* reserve an ethdev entry */
- eth_dev = rte_eth_dev_allocate(name);
+ eth_dev = rte_eth_dev_allocate(name, RTE_ETH_DEV_VIRTUAL);
if (eth_dev == NULL)
goto err;