* [PATCH v3 3/4] hisi_acc_vfio_pci: register debugfs for hisilicon migration driver
@ 2024-03-07 6:36 Longfang Liu
2024-03-07 6:36 ` [PATCH v3 4/4] Documentation: add debugfs description for hisi migration Longfang Liu
0 siblings, 1 reply; 3+ messages in thread
From: Longfang Liu @ 2024-03-07 6:36 UTC (permalink / raw)
To: alex.williamson, jgg, shameerali.kolothum.thodi, jonathan.cameron
Cc: kvm, linux-kernel, linuxarm, liulongfang
On the debugfs framework of VFIO, if the CONFIG_VFIO_DEBUGFS macro is
enabled, the debug function is registered for the live migration driver
of the HiSilicon accelerator device.
After registering the HiSilicon accelerator device on the debugfs
framework of live migration of vfio, a directory file "hisi_acc"
of debugfs is created, and then three debug function files are
created in this directory:
vfio
|
+---<dev_name1>
| +---migration
| +--state
| +--hisi_acc
| +--attr
| +--data
| +--save
| +--cmd_state
|
+---<dev_name2>
+---migration
+--state
+--hisi_acc
+--attr
+--data
+--save
+--cmd_state
data file: used to get the migration data from the driver
attr file: used to get device attributes parameters from the driver
save file: used to read the data of the live migration device and save
it to the driver.
cmd_state: used to get the cmd channel state for the device.
+----------------+ +--------------+ +---------------+
| migration dev | | src dev | | dst dev |
+-------+--------+ +------+-------+ +-------+-------+
| | |
| | |
| | |
| | |
save | +------v-------+ +-------v-------+
| | saving_mif | | resuming_migf |
| | file | | file |
| +------+-------+ +-------+-------+
| | |
| mutex | |
+-------v--------+ | |
| | | |
| debug_migf file<---------------+-----------------------+
| | copy
+-------+--------+
|
cat |
|
+-------v--------+
| user |
+----------------+
In debugfs scheme. The driver creates a separate debug_migf file.
It is completely separated from the two files of live migration,
thus preventing debugfs data from interfering with migration data.
Moreover, it only performs read operations on the device.
For serialization of debugfs:
First, it only writes data when performing a debugfs save operation.
Second, it is only copied from the file on the migration device
when the live migration is complete.
These two operations are mutually exclusive through mutex.
Signed-off-by: Longfang Liu <liulongfang@huawei.com>
---
.../vfio/pci/hisilicon/hisi_acc_vfio_pci.c | 204 ++++++++++++++++++
.../vfio/pci/hisilicon/hisi_acc_vfio_pci.h | 11 +
2 files changed, 215 insertions(+)
diff --git a/drivers/vfio/pci/hisilicon/hisi_acc_vfio_pci.c b/drivers/vfio/pci/hisilicon/hisi_acc_vfio_pci.c
index 1881f3fa9266..fe954b2a0701 100644
--- a/drivers/vfio/pci/hisilicon/hisi_acc_vfio_pci.c
+++ b/drivers/vfio/pci/hisilicon/hisi_acc_vfio_pci.c
@@ -15,6 +15,7 @@
#include <linux/anon_inodes.h>
#include "hisi_acc_vfio_pci.h"
+#include "../../vfio.h"
/* Return 0 on VM acc device ready, -ETIMEDOUT hardware timeout */
static int qm_wait_dev_not_ready(struct hisi_qm *qm)
@@ -611,6 +612,22 @@ hisi_acc_check_int_state(struct hisi_acc_vf_core_device *hisi_acc_vdev)
}
}
+static void hisi_acc_vf_migf_save(struct hisi_acc_vf_core_device *hisi_acc_vdev,
+ struct hisi_acc_vf_migration_file *src_migf)
+{
+ struct hisi_acc_vf_migration_file *dst_migf = hisi_acc_vdev->debug_migf;
+
+ if (!dst_migf)
+ return;
+
+ mutex_lock(&hisi_acc_vdev->enable_mutex);
+ dst_migf->disabled = src_migf->disabled;
+ dst_migf->total_length = src_migf->total_length;
+ memcpy(&dst_migf->vf_data, &src_migf->vf_data,
+ sizeof(struct acc_vf_data));
+ mutex_unlock(&hisi_acc_vdev->enable_mutex);
+}
+
static void hisi_acc_vf_disable_fd(struct hisi_acc_vf_migration_file *migf)
{
mutex_lock(&migf->lock);
@@ -623,12 +640,14 @@ static void hisi_acc_vf_disable_fd(struct hisi_acc_vf_migration_file *migf)
static void hisi_acc_vf_disable_fds(struct hisi_acc_vf_core_device *hisi_acc_vdev)
{
if (hisi_acc_vdev->resuming_migf) {
+ hisi_acc_vf_migf_save(hisi_acc_vdev, hisi_acc_vdev->resuming_migf);
hisi_acc_vf_disable_fd(hisi_acc_vdev->resuming_migf);
fput(hisi_acc_vdev->resuming_migf->filp);
hisi_acc_vdev->resuming_migf = NULL;
}
if (hisi_acc_vdev->saving_migf) {
+ hisi_acc_vf_migf_save(hisi_acc_vdev, hisi_acc_vdev->saving_migf);
hisi_acc_vf_disable_fd(hisi_acc_vdev->saving_migf);
fput(hisi_acc_vdev->saving_migf->filp);
hisi_acc_vdev->saving_migf = NULL;
@@ -1137,6 +1156,7 @@ static int hisi_acc_vf_qm_init(struct hisi_acc_vf_core_device *hisi_acc_vdev)
if (!vf_qm->io_base)
return -EIO;
+ mutex_init(&hisi_acc_vdev->enable_mutex);
vf_qm->fun_type = QM_HW_VF;
vf_qm->pdev = vf_dev;
mutex_init(&vf_qm->mailbox_lock);
@@ -1287,6 +1307,181 @@ static long hisi_acc_vfio_pci_ioctl(struct vfio_device *core_vdev, unsigned int
return vfio_pci_core_ioctl(core_vdev, cmd, arg);
}
+static int hisi_acc_vf_debug_check(struct seq_file *seq, struct vfio_device *vdev)
+{
+ struct hisi_acc_vf_core_device *hisi_acc_vdev = hisi_acc_get_vf_dev(vdev);
+ struct hisi_acc_vf_migration_file *migf = hisi_acc_vdev->debug_migf;
+ struct hisi_qm *vf_qm = &hisi_acc_vdev->vf_qm;
+ int ret;
+
+ if (!vdev->mig_ops || !migf) {
+ seq_printf(seq, "%s\n", "device does not support live migration!");
+ return -EINVAL;
+ }
+
+ /**
+ * When the device is not opened, the io_base is not mapped.
+ * The driver cannot perform device read and write operations.
+ */
+ if (hisi_acc_vdev->dev_opened != DEV_OPEN) {
+ seq_printf(seq, "%s\n", "device not opened!");
+ return -EINVAL;
+ }
+
+ ret = qm_wait_dev_not_ready(vf_qm);
+ if (ret) {
+ seq_printf(seq, "%s\n", "VF device not ready!");
+ return -EINVAL;
+ }
+
+ return 0;
+}
+
+static int hisi_acc_vf_debug_cmd(struct seq_file *seq, void *data)
+{
+ struct device *vf_dev = seq->private;
+ struct vfio_pci_core_device *core_device = dev_get_drvdata(vf_dev);
+ struct vfio_device *vdev = &core_device->vdev;
+ struct hisi_acc_vf_core_device *hisi_acc_vdev = hisi_acc_get_vf_dev(vdev);
+ struct hisi_qm *vf_qm = &hisi_acc_vdev->vf_qm;
+ u64 value;
+ int ret;
+
+ mutex_lock(&hisi_acc_vdev->enable_mutex);
+ ret = hisi_acc_vf_debug_check(seq, vdev);
+ if (ret) {
+ mutex_unlock(&hisi_acc_vdev->enable_mutex);
+ return 0;
+ }
+
+ value = readl(vf_qm->io_base + QM_MB_CMD_SEND_BASE);
+ mutex_unlock(&hisi_acc_vdev->enable_mutex);
+ seq_printf(seq, "%s:0x%llx\n", "mailbox cmd channel state is OK", value);
+
+ return 0;
+}
+
+static int hisi_acc_vf_debug_save(struct seq_file *seq, void *data)
+{
+ struct device *vf_dev = seq->private;
+ struct vfio_pci_core_device *core_device = dev_get_drvdata(vf_dev);
+ struct vfio_device *vdev = &core_device->vdev;
+ struct hisi_acc_vf_core_device *hisi_acc_vdev = hisi_acc_get_vf_dev(vdev);
+ struct hisi_acc_vf_migration_file *migf = hisi_acc_vdev->debug_migf;
+ struct acc_vf_data *vf_data = &migf->vf_data;
+ int ret;
+
+ mutex_lock(&hisi_acc_vdev->enable_mutex);
+ ret = hisi_acc_vf_debug_check(seq, vdev);
+ if (ret) {
+ mutex_unlock(&hisi_acc_vdev->enable_mutex);
+ return 0;
+ }
+
+ vf_data->vf_qm_state = QM_READY;
+ ret = vf_qm_read_data(&hisi_acc_vdev->vf_qm, vf_data);
+ if (ret) {
+ mutex_unlock(&hisi_acc_vdev->enable_mutex);
+ seq_printf(seq, "%s\n", "failed to save device data!");
+ return 0;
+ }
+
+ migf->total_length = sizeof(struct acc_vf_data);
+ mutex_unlock(&hisi_acc_vdev->enable_mutex);
+ seq_printf(seq, "%s\n", "successful to save device data!");
+
+ return 0;
+}
+
+static int hisi_acc_vf_data_read(struct seq_file *seq, void *data)
+{
+ struct device *vf_dev = seq->private;
+ struct vfio_pci_core_device *core_device = dev_get_drvdata(vf_dev);
+ struct vfio_device *vdev = &core_device->vdev;
+ struct hisi_acc_vf_core_device *hisi_acc_vdev = hisi_acc_get_vf_dev(vdev);
+ struct hisi_acc_vf_migration_file *debug_migf = hisi_acc_vdev->debug_migf;
+ size_t vf_data_sz = offsetofend(struct acc_vf_data, padding);
+
+ if (debug_migf && debug_migf->total_length)
+ seq_hex_dump(seq, "Mig Data:", DUMP_PREFIX_OFFSET, 16, 1,
+ (unsigned char *)&debug_migf->vf_data,
+ vf_data_sz, false);
+ else
+ seq_printf(seq, "%s\n", "device not migrated!");
+
+ return 0;
+}
+
+static int hisi_acc_vf_attr_read(struct seq_file *seq, void *data)
+{
+ struct device *vf_dev = seq->private;
+ struct vfio_pci_core_device *core_device = dev_get_drvdata(vf_dev);
+ struct vfio_device *vdev = &core_device->vdev;
+ struct hisi_acc_vf_core_device *hisi_acc_vdev = hisi_acc_get_vf_dev(vdev);
+ struct hisi_acc_vf_migration_file *debug_migf = hisi_acc_vdev->debug_migf;
+
+ if (debug_migf && debug_migf->total_length) {
+ seq_printf(seq,
+ "acc device:\n"
+ "device state: %d\n"
+ "device ready: %u\n"
+ "data valid: %d\n"
+ "data size: %lu\n",
+ hisi_acc_vdev->mig_state,
+ hisi_acc_vdev->vf_qm_state,
+ debug_migf->disabled,
+ debug_migf->total_length);
+ } else {
+ seq_printf(seq, "%s\n", "device not migrated!");
+ }
+
+ return 0;
+}
+
+static int hisi_acc_vfio_debug_init(struct hisi_acc_vf_core_device *hisi_acc_vdev)
+{
+ struct vfio_device *vdev = &hisi_acc_vdev->core_device.vdev;
+ struct dentry *vfio_dev_migration = NULL;
+ struct dentry *vfio_hisi_acc = NULL;
+ struct device *dev = vdev->dev;
+ void *migf = NULL;
+
+ if (!debugfs_initialized())
+ return 0;
+
+ migf = kzalloc(sizeof(struct hisi_acc_vf_migration_file), GFP_KERNEL);
+ if (!migf)
+ return -ENOMEM;
+ hisi_acc_vdev->debug_migf = migf;
+
+ vfio_dev_migration = debugfs_lookup("migration", vdev->debug_root);
+ if (!vfio_dev_migration) {
+ kfree(migf);
+ dev_err(dev, "failed to lookup migration debugfs file!\n");
+ return -ENODEV;
+ }
+
+ vfio_hisi_acc = debugfs_create_dir("hisi_acc", vfio_dev_migration);
+ debugfs_create_devm_seqfile(dev, "data", vfio_hisi_acc,
+ hisi_acc_vf_data_read);
+ debugfs_create_devm_seqfile(dev, "attr", vfio_hisi_acc,
+ hisi_acc_vf_attr_read);
+ debugfs_create_devm_seqfile(dev, "cmd_state", vfio_hisi_acc,
+ hisi_acc_vf_debug_cmd);
+ debugfs_create_devm_seqfile(dev, "save", vfio_hisi_acc,
+ hisi_acc_vf_debug_save);
+
+ return 0;
+}
+
+static void hisi_acc_vf_debugfs_exit(struct hisi_acc_vf_core_device *hisi_acc_vdev)
+{
+ if (!debugfs_initialized())
+ return;
+
+ kfree(hisi_acc_vdev->debug_migf);
+}
+
static int hisi_acc_vfio_pci_open_device(struct vfio_device *core_vdev)
{
struct hisi_acc_vf_core_device *hisi_acc_vdev = hisi_acc_get_vf_dev(core_vdev);
@@ -1304,9 +1499,11 @@ static int hisi_acc_vfio_pci_open_device(struct vfio_device *core_vdev)
return ret;
}
hisi_acc_vdev->mig_state = VFIO_DEVICE_STATE_RUNNING;
+ hisi_acc_vdev->dev_opened = DEV_OPEN;
}
vfio_pci_core_finish_enable(vdev);
+
return 0;
}
@@ -1315,7 +1512,10 @@ static void hisi_acc_vfio_pci_close_device(struct vfio_device *core_vdev)
struct hisi_acc_vf_core_device *hisi_acc_vdev = hisi_acc_get_vf_dev(core_vdev);
struct hisi_qm *vf_qm = &hisi_acc_vdev->vf_qm;
+ hisi_acc_vdev->dev_opened = DEV_CLOSE;
+ mutex_lock(&hisi_acc_vdev->enable_mutex);
iounmap(vf_qm->io_base);
+ mutex_unlock(&hisi_acc_vdev->enable_mutex);
vfio_pci_core_close_device(core_vdev);
}
@@ -1406,6 +1606,9 @@ static int hisi_acc_vfio_pci_probe(struct pci_dev *pdev, const struct pci_device
ret = vfio_pci_core_register_device(&hisi_acc_vdev->core_device);
if (ret)
goto out_put_vdev;
+
+ if (ops == &hisi_acc_vfio_pci_migrn_ops)
+ hisi_acc_vfio_debug_init(hisi_acc_vdev);
return 0;
out_put_vdev:
@@ -1418,6 +1621,7 @@ static void hisi_acc_vfio_pci_remove(struct pci_dev *pdev)
struct hisi_acc_vf_core_device *hisi_acc_vdev = hisi_acc_drvdata(pdev);
vfio_pci_core_unregister_device(&hisi_acc_vdev->core_device);
+ hisi_acc_vf_debugfs_exit(hisi_acc_vdev);
vfio_put_device(&hisi_acc_vdev->core_device.vdev);
}
diff --git a/drivers/vfio/pci/hisilicon/hisi_acc_vfio_pci.h b/drivers/vfio/pci/hisilicon/hisi_acc_vfio_pci.h
index 7a9dc87627cd..3a20d81d105c 100644
--- a/drivers/vfio/pci/hisilicon/hisi_acc_vfio_pci.h
+++ b/drivers/vfio/pci/hisilicon/hisi_acc_vfio_pci.h
@@ -52,6 +52,11 @@
#define QM_EQC_DW0 0X8000
#define QM_AEQC_DW0 0X8020
+enum acc_dev_state {
+ DEV_CLOSE = 0x0,
+ DEV_OPEN,
+};
+
struct acc_vf_data {
#define QM_MATCH_SIZE offsetofend(struct acc_vf_data, qm_rsv_state)
/* QM match information */
@@ -114,5 +119,11 @@ struct hisi_acc_vf_core_device {
int vf_id;
struct hisi_acc_vf_migration_file *resuming_migf;
struct hisi_acc_vf_migration_file *saving_migf;
+
+ /* To make sure the device is enabled */
+ struct mutex enable_mutex;
+ bool dev_opened;
+ /* For debugfs */
+ struct hisi_acc_vf_migration_file *debug_migf;
};
#endif /* HISI_ACC_VFIO_PCI_H */
--
2.24.0
^ permalink raw reply [flat|nested] 3+ messages in thread* [PATCH v3 4/4] Documentation: add debugfs description for hisi migration
2024-03-07 6:36 [PATCH v3 3/4] hisi_acc_vfio_pci: register debugfs for hisilicon migration driver Longfang Liu
@ 2024-03-07 6:36 ` Longfang Liu
2024-03-30 7:53 ` liulongfang
0 siblings, 1 reply; 3+ messages in thread
From: Longfang Liu @ 2024-03-07 6:36 UTC (permalink / raw)
To: alex.williamson, jgg, shameerali.kolothum.thodi, jonathan.cameron
Cc: kvm, linux-kernel, linuxarm, liulongfang
Add a debugfs document description file to help users understand
how to use the hisilicon accelerator live migration driver's
debugfs.
Update the file paths that need to be maintained in MAINTAINERS
Signed-off-by: Longfang Liu <liulongfang@huawei.com>
---
.../ABI/testing/debugfs-hisi-migration | 34 +++++++++++++++++++
MAINTAINERS | 1 +
2 files changed, 35 insertions(+)
create mode 100644 Documentation/ABI/testing/debugfs-hisi-migration
diff --git a/Documentation/ABI/testing/debugfs-hisi-migration b/Documentation/ABI/testing/debugfs-hisi-migration
new file mode 100644
index 000000000000..7111af41ed05
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-hisi-migration
@@ -0,0 +1,34 @@
+What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/data
+Date: Mar 2024
+KernelVersion: 6.8
+Contact: Longfang Liu <liulongfang@huawei.com>
+Description: Read the live migration data of the vfio device.
+ These data include device status data, queue configuration
+ data and some task configuration data.
+ The output format of the data is defined by the live
+ migration driver.
+
+What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/attr
+Date: Mar 2024
+KernelVersion: 6.8
+Contact: Longfang Liu <liulongfang@huawei.com>
+Description: Read the live migration attributes of the vfio device.
+ it include device status attributes and data length attributes
+ The output format of the attributes is defined by the live
+ migration driver.
+
+What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/cmd_state
+Date: Mar 2024
+KernelVersion: 6.8
+Contact: Longfang Liu <liulongfang@huawei.com>
+Description: Used to obtain the device command sending and receiving
+ channel status. If successful, returns the command value.
+ If failed, return error log.
+
+What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/save
+Date: Mar 2024
+KernelVersion: 6.8
+Contact: Longfang Liu <liulongfang@huawei.com>
+Description: Trigger the Hisilicon accelerator device to perform
+ the state saving operation of live migration through the read
+ operation, and output the operation log results.
diff --git a/MAINTAINERS b/MAINTAINERS
index 7625911ec2f1..8c2d13b13273 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -23072,6 +23072,7 @@ M: Longfang Liu <liulongfang@huawei.com>
M: Shameer Kolothum <shameerali.kolothum.thodi@huawei.com>
L: kvm@vger.kernel.org
S: Maintained
+F: Documentation/ABI/testing/debugfs-hisi-migration
F: drivers/vfio/pci/hisilicon/
VFIO MEDIATED DEVICE DRIVERS
--
2.24.0
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH v3 4/4] Documentation: add debugfs description for hisi migration
2024-03-07 6:36 ` [PATCH v3 4/4] Documentation: add debugfs description for hisi migration Longfang Liu
@ 2024-03-30 7:53 ` liulongfang
0 siblings, 0 replies; 3+ messages in thread
From: liulongfang @ 2024-03-30 7:53 UTC (permalink / raw)
To: alex.williamson, jgg, shameerali.kolothum.thodi, jonathan.cameron
Cc: kvm, linux-kernel, linuxarm
On 2024/3/7 14:36, Longfang Liu wrote:
> Add a debugfs document description file to help users understand
> how to use the hisilicon accelerator live migration driver's
> debugfs.
>
> Update the file paths that need to be maintained in MAINTAINERS
>
> Signed-off-by: Longfang Liu <liulongfang@huawei.com>
> ---
> .../ABI/testing/debugfs-hisi-migration | 34 +++++++++++++++++++
> MAINTAINERS | 1 +
> 2 files changed, 35 insertions(+)
> create mode 100644 Documentation/ABI/testing/debugfs-hisi-migration
>
> diff --git a/Documentation/ABI/testing/debugfs-hisi-migration b/Documentation/ABI/testing/debugfs-hisi-migration
> new file mode 100644
> index 000000000000..7111af41ed05
> --- /dev/null
> +++ b/Documentation/ABI/testing/debugfs-hisi-migration
> @@ -0,0 +1,34 @@
> +What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/data
> +Date: Mar 2024
> +KernelVersion: 6.8
> +Contact: Longfang Liu <liulongfang@huawei.com>
> +Description: Read the live migration data of the vfio device.
> + These data include device status data, queue configuration
> + data and some task configuration data.
> + The output format of the data is defined by the live
> + migration driver.
> +
> +What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/attr
> +Date: Mar 2024
> +KernelVersion: 6.8
> +Contact: Longfang Liu <liulongfang@huawei.com>
> +Description: Read the live migration attributes of the vfio device.
> + it include device status attributes and data length attributes
> + The output format of the attributes is defined by the live
> + migration driver.
> +
> +What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/cmd_state
> +Date: Mar 2024
> +KernelVersion: 6.8
> +Contact: Longfang Liu <liulongfang@huawei.com>
> +Description: Used to obtain the device command sending and receiving
> + channel status. If successful, returns the command value.
> + If failed, return error log.
> +
> +What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/save
> +Date: Mar 2024
> +KernelVersion: 6.8
> +Contact: Longfang Liu <liulongfang@huawei.com>
> +Description: Trigger the Hisilicon accelerator device to perform
> + the state saving operation of live migration through the read
> + operation, and output the operation log results.
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 7625911ec2f1..8c2d13b13273 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -23072,6 +23072,7 @@ M: Longfang Liu <liulongfang@huawei.com>
> M: Shameer Kolothum <shameerali.kolothum.thodi@huawei.com>
> L: kvm@vger.kernel.org
> S: Maintained
> +F: Documentation/ABI/testing/debugfs-hisi-migration
> F: drivers/vfio/pci/hisilicon/
>
> VFIO MEDIATED DEVICE DRIVERS
>
Hi, Alex:
Are there any issues with this patchset that need to be modified?
Thanks,
Longfang.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2024-03-30 7:53 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-03-07 6:36 [PATCH v3 3/4] hisi_acc_vfio_pci: register debugfs for hisilicon migration driver Longfang Liu
2024-03-07 6:36 ` [PATCH v3 4/4] Documentation: add debugfs description for hisi migration Longfang Liu
2024-03-30 7:53 ` liulongfang
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®