From nobody Sun Feb 8 13:53:04 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id C2C96C001E0 for ; Fri, 28 Jul 2023 07:23:53 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234143AbjG1HXv (ORCPT ); Fri, 28 Jul 2023 03:23:51 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53376 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234153AbjG1HXo (ORCPT ); Fri, 28 Jul 2023 03:23:44 -0400 Received: from szxga02-in.huawei.com (szxga02-in.huawei.com [45.249.212.188]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id AA41930C2 for ; Fri, 28 Jul 2023 00:23:42 -0700 (PDT) Received: from kwepemm600005.china.huawei.com (unknown [172.30.72.54]) by szxga02-in.huawei.com (SkyGuard) with ESMTP id 4RBzbb64YfzVjrR; Fri, 28 Jul 2023 15:22:03 +0800 (CST) Received: from huawei.com (10.50.163.32) by kwepemm600005.china.huawei.com (7.193.23.191) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.27; Fri, 28 Jul 2023 15:23:40 +0800 From: liulongfang To: , , , CC: , , , Subject: [PATCH v12 1/4] vfio/migration: Add debugfs to live migration driver Date: Fri, 28 Jul 2023 15:21:01 +0800 Message-ID: <20230728072104.64834-2-liulongfang@huawei.com> X-Mailer: git-send-email 2.24.0 In-Reply-To: <20230728072104.64834-1-liulongfang@huawei.com> References: <20230728072104.64834-1-liulongfang@huawei.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Originating-IP: [10.50.163.32] X-ClientProxiedBy: dggems704-chm.china.huawei.com (10.3.19.181) To kwepemm600005.china.huawei.com (7.193.23.191) X-CFilter-Loop: Reflected Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" From: Longfang Liu There are multiple devices, software and operational steps involved in the process of live migration. An error occurred on any node may cause the live migration operation to fail. This complex process makes it very difficult to locate and analyze the cause when the function fails. In order to quickly locate the cause of the problem when the live migration fails, I added a set of debugfs to the vfio live migration driver. +-------------------------------------------+ | | | | | QEMU | | | | | +---+----------------------------+----------+ | ^ | ^ | | | | | | | | v | v | +---------+--+ +---------+--+ |src vfio_dev| |dst vfio_dev| +--+---------+ +--+---------+ | ^ | ^ | | | | v | | | +-----------+----+ +-----------+----+ |src dev debugfs | |dst dev debugfs | +----------------+ +----------------+ The entire debugfs directory will be based on the definition of the CONFIG_DEBUG_FS macro. If this macro is not enabled, the interfaces in vfio.h will be empty definitions, and the creation and initialization of the debugfs directory will not be executed. vfio | +--- | +---migration | +--state | +--hisi_acc | +--attr | +--data | +--save | +--io_test | +--- +---migration +--state +--hisi_acc +--attr +--data +--save +--io_test debugfs will create a public root directory "vfio" file. then create a dev_name() file for each live migration device. First, create a unified state acquisition file of "migration" in this device directory. Then, create a public live migration state lookup file "state" Finally, create a directory file based on the device type, and then create the device's own debugging files under this directory file. Here, HiSilicon accelerator creates three debug files: attr: used to export the attribute parameters of the current live migration device. data: used to export the live migration data of the current live migration device. save: used to read the current live migration device's data and save it to the driver. io_test: used to test the IO read and write for the driver. The live migration function of the current device can be tested by operating the debug files, and the functional status of the equipment and software at each stage can be tested step by step without performing the complete live migration function. And after the live migration is performed, the migration device data of the live migration can be obtained through the debug files. Signed-off-by: Longfang Liu --- drivers/vfio/Makefile | 1 + drivers/vfio/vfio.h | 14 +++++++ drivers/vfio/vfio_debugfs.c | 80 +++++++++++++++++++++++++++++++++++++ drivers/vfio/vfio_main.c | 5 ++- include/linux/vfio.h | 7 ++++ 5 files changed, 106 insertions(+), 1 deletion(-) create mode 100644 drivers/vfio/vfio_debugfs.c diff --git a/drivers/vfio/Makefile b/drivers/vfio/Makefile index c82ea032d352..7934ac829989 100644 --- a/drivers/vfio/Makefile +++ b/drivers/vfio/Makefile @@ -8,6 +8,7 @@ vfio-$(CONFIG_VFIO_GROUP) +=3D group.o vfio-$(CONFIG_IOMMUFD) +=3D iommufd.o vfio-$(CONFIG_VFIO_CONTAINER) +=3D container.o vfio-$(CONFIG_VFIO_VIRQFD) +=3D virqfd.o +vfio-$(CONFIG_DEBUG_FS) +=3D vfio_debugfs.o =20 obj-$(CONFIG_VFIO_IOMMU_TYPE1) +=3D vfio_iommu_type1.o obj-$(CONFIG_VFIO_IOMMU_SPAPR_TCE) +=3D vfio_iommu_spapr_tce.o diff --git a/drivers/vfio/vfio.h b/drivers/vfio/vfio.h index 307e3f29b527..09b00757d0bb 100644 --- a/drivers/vfio/vfio.h +++ b/drivers/vfio/vfio.h @@ -448,4 +448,18 @@ static inline void vfio_device_put_kvm(struct vfio_dev= ice *device) } #endif =20 +#ifdef CONFIG_DEBUG_FS +void vfio_debugfs_create_root(void); +void vfio_debugfs_remove_root(void); + +void vfio_device_debugfs_init(struct vfio_device *vdev); +void vfio_device_debugfs_exit(struct vfio_device *vdev); +#else +static inline void vfio_debugfs_create_root(void) { } +static inline void vfio_debugfs_remove_root(void) { } + +static inline void vfio_device_debugfs_init(struct vfio_device *vdev) { } +static inline void vfio_device_debugfs_exit(struct vfio_device *vdev) { } +#endif /* CONFIG_DEBUG_FS */ + #endif diff --git a/drivers/vfio/vfio_debugfs.c b/drivers/vfio/vfio_debugfs.c new file mode 100644 index 000000000000..d903293ed9c7 --- /dev/null +++ b/drivers/vfio/vfio_debugfs.c @@ -0,0 +1,80 @@ +// SPDX-License-Identifier: GPL-2.0-only +/* + * Copyright (c) 2023, HiSilicon Ltd. + */ + +#include +#include +#include +#include +#include "vfio.h" + +static struct dentry *vfio_debugfs_root; + +static int vfio_device_state_read(struct seq_file *seq, void *data) +{ + struct device *vf_dev =3D seq->private; + struct vfio_device *vdev =3D container_of(vf_dev, struct vfio_device, dev= ice); + enum vfio_device_mig_state state; + int ret; + + ret =3D vdev->mig_ops->migration_get_state(vdev, &state); + if (ret) + return -EINVAL; + + switch (state) { + case VFIO_DEVICE_STATE_RUNNING: + seq_printf(seq, "%s\n", "RUNNING"); + break; + case VFIO_DEVICE_STATE_STOP_COPY: + seq_printf(seq, "%s\n", "STOP_COPY"); + break; + case VFIO_DEVICE_STATE_STOP: + seq_printf(seq, "%s\n", "STOP"); + break; + case VFIO_DEVICE_STATE_RESUMING: + seq_printf(seq, "%s\n", "RESUMING"); + break; + case VFIO_DEVICE_STATE_RUNNING_P2P: + seq_printf(seq, "%s\n", "RESUMING_P2P"); + break; + case VFIO_DEVICE_STATE_ERROR: + seq_printf(seq, "%s\n", "ERROR"); + break; + default: + seq_printf(seq, "%s\n", "Invalid"); + } + + return 0; +} + +void vfio_device_debugfs_init(struct vfio_device *vdev) +{ + struct dentry *vfio_dev_migration =3D NULL; + struct device *dev =3D &vdev->device; + + vdev->debug_root =3D debugfs_create_dir(dev_name(vdev->dev), vfio_debugfs= _root); + + if (vdev->mig_ops) { + vfio_dev_migration =3D debugfs_create_dir("migration", vdev->debug_root); + debugfs_create_devm_seqfile(dev, "state", vfio_dev_migration, + vfio_device_state_read); + } +} + +void vfio_device_debugfs_exit(struct vfio_device *vdev) +{ + debugfs_remove_recursive(vdev->debug_root); +} + +void vfio_debugfs_create_root(void) +{ + vfio_debugfs_root =3D debugfs_create_dir("vfio", NULL); +} + +void vfio_debugfs_remove_root(void) +{ + debugfs_remove_recursive(vfio_debugfs_root); + vfio_debugfs_root =3D NULL; +} + diff --git a/drivers/vfio/vfio_main.c b/drivers/vfio/vfio_main.c index 902f06e52c48..7f88532d0476 100644 --- a/drivers/vfio/vfio_main.c +++ b/drivers/vfio/vfio_main.c @@ -309,7 +309,7 @@ static int __vfio_register_dev(struct vfio_device *devi= ce, =20 /* Refcounting can't start until the driver calls register */ refcount_set(&device->refcount, 1); - + vfio_device_debugfs_init(device); vfio_device_group_register(device); =20 return 0; @@ -378,6 +378,7 @@ void vfio_unregister_group_dev(struct vfio_device *devi= ce) } } =20 + vfio_device_debugfs_exit(device); /* Balances vfio_device_set_group in register path */ vfio_device_remove_group(device); } @@ -1609,6 +1610,7 @@ static int __init vfio_init(void) if (ret) goto err_alloc_dev_chrdev; =20 + vfio_debugfs_create_root(); pr_info(DRIVER_DESC " version: " DRIVER_VERSION "\n"); return 0; =20 @@ -1631,6 +1633,7 @@ static void __exit vfio_cleanup(void) vfio_virqfd_exit(); vfio_group_cleanup(); xa_destroy(&vfio_device_set_xa); + vfio_debugfs_remove_root(); } =20 module_init(vfio_init); diff --git a/include/linux/vfio.h b/include/linux/vfio.h index 5a1dee983f17..10cd84a3e31c 100644 --- a/include/linux/vfio.h +++ b/include/linux/vfio.h @@ -69,6 +69,13 @@ struct vfio_device { u8 iommufd_attached:1; #endif u8 cdev_opened:1; +#ifdef CONFIG_DEBUG_FS + /* + * debug_root is a static property of the vfio_device + * which must be set prior to registering the vfio_device. + */ + struct dentry *debug_root; +#endif }; =20 /** --=20 2.24.0 From nobody Sun Feb 8 13:53:04 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 348B9C41513 for ; Fri, 28 Jul 2023 07:24:19 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234177AbjG1HYR (ORCPT ); Fri, 28 Jul 2023 03:24:17 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53816 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234172AbjG1HYO (ORCPT ); Fri, 28 Jul 2023 03:24:14 -0400 Received: from szxga02-in.huawei.com (szxga02-in.huawei.com [45.249.212.188]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BA8162736 for ; Fri, 28 Jul 2023 00:24:13 -0700 (PDT) Received: from kwepemm600005.china.huawei.com (unknown [172.30.72.55]) by szxga02-in.huawei.com (SkyGuard) with ESMTP id 4RBzZ80M0hzNmTG; Fri, 28 Jul 2023 15:20:48 +0800 (CST) Received: from huawei.com (10.50.163.32) by kwepemm600005.china.huawei.com (7.193.23.191) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.27; Fri, 28 Jul 2023 15:24:11 +0800 From: liulongfang To: , , , CC: , , , Subject: [PATCH v12 2/4] hisi_acc_vfio_pci: extract public functions for container_of Date: Fri, 28 Jul 2023 15:21:02 +0800 Message-ID: <20230728072104.64834-3-liulongfang@huawei.com> X-Mailer: git-send-email 2.24.0 In-Reply-To: <20230728072104.64834-1-liulongfang@huawei.com> References: <20230728072104.64834-1-liulongfang@huawei.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Originating-IP: [10.50.163.32] X-ClientProxiedBy: dggems701-chm.china.huawei.com (10.3.19.178) To kwepemm600005.china.huawei.com (7.193.23.191) X-CFilter-Loop: Reflected Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" From: Longfang Liu In the current driver, vdev is obtained from struct hisi_acc_vf_core_device through the container_of function. This method is used in many places in the driver. In order to reduce this repetitive operation, I extracted a public function to replace it. Signed-off-by: Longfang Liu Reviewed-by: Jason Gunthorpe --- .../vfio/pci/hisilicon/hisi_acc_vfio_pci.c | 21 ++++++++++--------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/drivers/vfio/pci/hisilicon/hisi_acc_vfio_pci.c b/drivers/vfio/= pci/hisilicon/hisi_acc_vfio_pci.c index b2f9778c8366..242ad319932a 100644 --- a/drivers/vfio/pci/hisilicon/hisi_acc_vfio_pci.c +++ b/drivers/vfio/pci/hisilicon/hisi_acc_vfio_pci.c @@ -630,6 +630,12 @@ static void hisi_acc_vf_disable_fds(struct hisi_acc_vf= _core_device *hisi_acc_vde } } =20 +static struct hisi_acc_vf_core_device *hisi_acc_get_vf_dev(struct vfio_dev= ice *vdev) +{ + return container_of(vdev, struct hisi_acc_vf_core_device, + core_device.vdev); +} + /* * This function is called in all state_mutex unlock cases to * handle a 'deferred_reset' if exists. @@ -1042,8 +1048,7 @@ static struct file * hisi_acc_vfio_pci_set_device_state(struct vfio_device *vdev, enum vfio_device_mig_state new_state) { - struct hisi_acc_vf_core_device *hisi_acc_vdev =3D container_of(vdev, - struct hisi_acc_vf_core_device, core_device.vdev); + struct hisi_acc_vf_core_device *hisi_acc_vdev =3D hisi_acc_get_vf_dev(vde= v); enum vfio_device_mig_state next_state; struct file *res =3D NULL; int ret; @@ -1084,8 +1089,7 @@ static int hisi_acc_vfio_pci_get_device_state(struct vfio_device *vdev, enum vfio_device_mig_state *curr_state) { - struct hisi_acc_vf_core_device *hisi_acc_vdev =3D container_of(vdev, - struct hisi_acc_vf_core_device, core_device.vdev); + struct hisi_acc_vf_core_device *hisi_acc_vdev =3D hisi_acc_get_vf_dev(vde= v); =20 mutex_lock(&hisi_acc_vdev->state_mutex); *curr_state =3D hisi_acc_vdev->mig_state; @@ -1301,8 +1305,7 @@ static long hisi_acc_vfio_pci_ioctl(struct vfio_devic= e *core_vdev, unsigned int =20 static int hisi_acc_vfio_pci_open_device(struct vfio_device *core_vdev) { - struct hisi_acc_vf_core_device *hisi_acc_vdev =3D container_of(core_vdev, - struct hisi_acc_vf_core_device, core_device.vdev); + struct hisi_acc_vf_core_device *hisi_acc_vdev =3D hisi_acc_get_vf_dev(cor= e_vdev); struct vfio_pci_core_device *vdev =3D &hisi_acc_vdev->core_device; int ret; =20 @@ -1325,8 +1328,7 @@ static int hisi_acc_vfio_pci_open_device(struct vfio_= device *core_vdev) =20 static void hisi_acc_vfio_pci_close_device(struct vfio_device *core_vdev) { - struct hisi_acc_vf_core_device *hisi_acc_vdev =3D container_of(core_vdev, - struct hisi_acc_vf_core_device, core_device.vdev); + struct hisi_acc_vf_core_device *hisi_acc_vdev =3D hisi_acc_get_vf_dev(cor= e_vdev); struct hisi_qm *vf_qm =3D &hisi_acc_vdev->vf_qm; =20 iounmap(vf_qm->io_base); @@ -1341,8 +1343,7 @@ static const struct vfio_migration_ops hisi_acc_vfio_= pci_migrn_state_ops =3D { =20 static int hisi_acc_vfio_pci_migrn_init_dev(struct vfio_device *core_vdev) { - struct hisi_acc_vf_core_device *hisi_acc_vdev =3D container_of(core_vdev, - struct hisi_acc_vf_core_device, core_device.vdev); + struct hisi_acc_vf_core_device *hisi_acc_vdev =3D hisi_acc_get_vf_dev(cor= e_vdev); struct pci_dev *pdev =3D to_pci_dev(core_vdev->dev); struct hisi_qm *pf_qm =3D hisi_acc_get_pf_qm(pdev); =20 --=20 2.24.0 From nobody Sun Feb 8 13:53:04 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2496AC0015E for ; Fri, 28 Jul 2023 07:24:54 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234186AbjG1HYv (ORCPT ); Fri, 28 Jul 2023 03:24:51 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54328 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234180AbjG1HYr (ORCPT ); Fri, 28 Jul 2023 03:24:47 -0400 Received: from szxga03-in.huawei.com (szxga03-in.huawei.com [45.249.212.189]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A27EC30E3 for ; Fri, 28 Jul 2023 00:24:44 -0700 (PDT) Received: from kwepemm600005.china.huawei.com (unknown [172.30.72.55]) by szxga03-in.huawei.com (SkyGuard) with ESMTP id 4RBzbd51jTzLnwD; Fri, 28 Jul 2023 15:22:05 +0800 (CST) Received: from huawei.com (10.50.163.32) by kwepemm600005.china.huawei.com (7.193.23.191) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.27; Fri, 28 Jul 2023 15:24:42 +0800 From: liulongfang To: , , , CC: , , , Subject: [PATCH v12 3/4] hisi_acc_vfio_pci: register debugfs for hisilicon migration driver Date: Fri, 28 Jul 2023 15:21:03 +0800 Message-ID: <20230728072104.64834-4-liulongfang@huawei.com> X-Mailer: git-send-email 2.24.0 In-Reply-To: <20230728072104.64834-1-liulongfang@huawei.com> References: <20230728072104.64834-1-liulongfang@huawei.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Originating-IP: [10.50.163.32] X-ClientProxiedBy: dggems703-chm.china.huawei.com (10.3.19.180) To kwepemm600005.china.huawei.com (7.193.23.191) X-CFilter-Loop: Reflected Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" From: Longfang Liu On the debugfs framework of VFIO, if the CONFIG_DEBUG_FS 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: 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. io_test: used to test IO read and write for the driver. Signed-off-by: Longfang Liu --- .../vfio/pci/hisilicon/hisi_acc_vfio_pci.c | 178 ++++++++++++++++++ .../vfio/pci/hisilicon/hisi_acc_vfio_pci.h | 3 + 2 files changed, 181 insertions(+) diff --git a/drivers/vfio/pci/hisilicon/hisi_acc_vfio_pci.c b/drivers/vfio/= pci/hisilicon/hisi_acc_vfio_pci.c index 242ad319932a..a811dc237a29 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 =20 #include "hisi_acc_vfio_pci.h" +#include "../../vfio.h" =20 /* Return 0 on VM acc device ready, -ETIMEDOUT hardware timeout */ static int qm_wait_dev_not_ready(struct hisi_qm *qm) @@ -606,6 +607,18 @@ hisi_acc_check_int_state(struct hisi_acc_vf_core_devic= e *hisi_acc_vdev) } } =20 +static void hisi_acc_vf_migf_save(struct hisi_acc_vf_migration_file *dst_m= igf, + struct hisi_acc_vf_migration_file *src_migf) +{ + if (!dst_migf) + return; + + dst_migf->disabled =3D false; + dst_migf->total_length =3D src_migf->total_length; + memcpy(&dst_migf->vf_data, &src_migf->vf_data, + sizeof(struct acc_vf_data)); +} + static void hisi_acc_vf_disable_fd(struct hisi_acc_vf_migration_file *migf) { mutex_lock(&migf->lock); @@ -618,12 +631,16 @@ 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_a= cc_vdev) { if (hisi_acc_vdev->resuming_migf) { + hisi_acc_vf_migf_save(hisi_acc_vdev->debug_migf, + 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 =3D NULL; } =20 if (hisi_acc_vdev->saving_migf) { + hisi_acc_vf_migf_save(hisi_acc_vdev->debug_migf, + 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 =3D NULL; @@ -1303,6 +1320,162 @@ static long hisi_acc_vfio_pci_ioctl(struct vfio_dev= ice *core_vdev, unsigned int return vfio_pci_core_ioctl(core_vdev, cmd, arg); } =20 +static int hisi_acc_vf_debug_check(struct seq_file *seq, struct vfio_devic= e *vdev) +{ + struct hisi_acc_vf_core_device *hisi_acc_vdev =3D hisi_acc_get_vf_dev(vde= v); + struct hisi_acc_vf_migration_file *migf =3D hisi_acc_vdev->debug_migf; + + if (!vdev->mig_ops || !migf) { + seq_printf(seq, "%s\n", "device does not support live migration!"); + return -EINVAL; + } + + /* If device not opened, the debugfs operation will trigger calltrace */ + if (!vdev->open_count) { + seq_printf(seq, "%s\n", "device not opened!"); + return -EINVAL; + } + + return 0; +} + +static int hisi_acc_vf_debug_io(struct seq_file *seq, void *data) +{ + struct device *vf_dev =3D seq->private; + struct vfio_pci_core_device *core_device =3D dev_get_drvdata(vf_dev); + struct vfio_device *vdev =3D &core_device->vdev; + struct hisi_acc_vf_core_device *hisi_acc_vdev =3D hisi_acc_get_vf_dev(vde= v); + struct hisi_qm *vf_qm =3D &hisi_acc_vdev->vf_qm; + u64 value; + int ret; + + ret =3D hisi_acc_vf_debug_check(seq, vdev); + if (ret) + return 0; + + ret =3D qm_wait_dev_not_ready(vf_qm); + if (ret) { + seq_printf(seq, "%s\n", "VF device not ready!"); + return 0; + } + + value =3D readl(vf_qm->io_base + QM_MB_CMD_SEND_BASE); + seq_printf(seq, "%s:0x%llx\n", "debug mailbox val", value); + + return 0; +} + +static int hisi_acc_vf_debug_save(struct seq_file *seq, void *data) +{ + struct device *vf_dev =3D seq->private; + struct vfio_pci_core_device *core_device =3D dev_get_drvdata(vf_dev); + struct vfio_device *vdev =3D &core_device->vdev; + struct hisi_acc_vf_core_device *hisi_acc_vdev =3D hisi_acc_get_vf_dev(vde= v); + struct hisi_acc_vf_migration_file *migf =3D hisi_acc_vdev->debug_migf; + int ret; + + ret =3D hisi_acc_vf_debug_check(seq, vdev); + if (ret) + return 0; + + ret =3D vf_qm_state_save(hisi_acc_vdev, migf); + if (ret) { + seq_printf(seq, "%s\n", "failed to save device data!"); + return 0; + } + 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 =3D seq->private; + struct vfio_pci_core_device *core_device =3D dev_get_drvdata(vf_dev); + struct vfio_device *vdev =3D &core_device->vdev; + struct hisi_acc_vf_core_device *hisi_acc_vdev =3D hisi_acc_get_vf_dev(vde= v); + struct hisi_acc_vf_migration_file *debug_migf =3D hisi_acc_vdev->debug_mi= gf; + size_t vf_data_sz =3D 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 =3D seq->private; + struct vfio_pci_core_device *core_device =3D dev_get_drvdata(vf_dev); + struct vfio_device *vdev =3D &core_device->vdev; + struct hisi_acc_vf_core_device *hisi_acc_vdev =3D hisi_acc_get_vf_dev(vde= v); + struct hisi_acc_vf_migration_file *debug_migf =3D hisi_acc_vdev->debug_mi= gf; + + 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_a= cc_vdev) +{ + struct vfio_device *vdev =3D &hisi_acc_vdev->core_device.vdev; + struct dentry *vfio_dev_migration =3D NULL; + struct dentry *vfio_hisi_acc =3D NULL; + struct device *dev =3D vdev->dev; + void *migf =3D NULL; + + if (!debugfs_initialized()) + return 0; + + migf =3D kzalloc(sizeof(struct hisi_acc_vf_migration_file), GFP_KERNEL); + if (!migf) + return -ENOMEM; + hisi_acc_vdev->debug_migf =3D migf; + + vfio_dev_migration =3D debugfs_lookup("migration", vdev->debug_root); + if (!vfio_dev_migration) { + dev_err(dev, "failed to lookup migration debugfs file!\n"); + return -ENODEV; + } + + vfio_hisi_acc =3D 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, "io_test", vfio_hisi_acc, + hisi_acc_vf_debug_io); + 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 =3D hisi_acc_get_vf_dev(cor= e_vdev); @@ -1323,6 +1496,7 @@ static int hisi_acc_vfio_pci_open_device(struct vfio_= device *core_vdev) } =20 vfio_pci_core_finish_enable(vdev); + return 0; } =20 @@ -1422,6 +1596,9 @@ static int hisi_acc_vfio_pci_probe(struct pci_dev *pd= ev, const struct pci_device ret =3D vfio_pci_core_register_device(&hisi_acc_vdev->core_device); if (ret) goto out_put_vdev; + + if (ops =3D=3D &hisi_acc_vfio_pci_migrn_ops) + hisi_acc_vfio_debug_init(hisi_acc_vdev); return 0; =20 out_put_vdev: @@ -1433,6 +1610,7 @@ static void hisi_acc_vfio_pci_remove(struct pci_dev *= pdev) { struct hisi_acc_vf_core_device *hisi_acc_vdev =3D hisi_acc_drvdata(pdev); =20 + hisi_acc_vf_debugfs_exit(hisi_acc_vdev); vfio_pci_core_unregister_device(&hisi_acc_vdev->core_device); 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 dcabfeec6ca1..93f44bcf53ee 100644 --- a/drivers/vfio/pci/hisilicon/hisi_acc_vfio_pci.h +++ b/drivers/vfio/pci/hisilicon/hisi_acc_vfio_pci.h @@ -113,5 +113,8 @@ struct hisi_acc_vf_core_device { spinlock_t reset_lock; struct hisi_acc_vf_migration_file *resuming_migf; struct hisi_acc_vf_migration_file *saving_migf; + + /* For debugfs */ + struct hisi_acc_vf_migration_file *debug_migf; }; #endif /* HISI_ACC_VFIO_PCI_H */ --=20 2.24.0 From nobody Sun Feb 8 13:53:04 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id A391AC0015E for ; Fri, 28 Jul 2023 07:25:39 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234274AbjG1HZi (ORCPT ); Fri, 28 Jul 2023 03:25:38 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:55038 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234234AbjG1HZ0 (ORCPT ); Fri, 28 Jul 2023 03:25:26 -0400 Received: from szxga03-in.huawei.com (szxga03-in.huawei.com [45.249.212.189]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 610BB3A9C for ; Fri, 28 Jul 2023 00:25:16 -0700 (PDT) Received: from kwepemm600005.china.huawei.com (unknown [172.30.72.53]) by szxga03-in.huawei.com (SkyGuard) with ESMTP id 4RBzcD4nkyzLnxW; Fri, 28 Jul 2023 15:22:36 +0800 (CST) Received: from huawei.com (10.50.163.32) by kwepemm600005.china.huawei.com (7.193.23.191) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.27; Fri, 28 Jul 2023 15:25:13 +0800 From: liulongfang To: , , , CC: , , , Subject: [PATCH v12 4/4] Documentation: add debugfs description for vfio Date: Fri, 28 Jul 2023 15:21:04 +0800 Message-ID: <20230728072104.64834-5-liulongfang@huawei.com> X-Mailer: git-send-email 2.24.0 In-Reply-To: <20230728072104.64834-1-liulongfang@huawei.com> References: <20230728072104.64834-1-liulongfang@huawei.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Originating-IP: [10.50.163.32] X-ClientProxiedBy: dggems704-chm.china.huawei.com (10.3.19.181) To kwepemm600005.china.huawei.com (7.193.23.191) X-CFilter-Loop: Reflected Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" From: Longfang Liu 1.Add two debugfs document description file to help users understand how to use the accelerator live migration driver's debugfs. 2.Update the file paths that need to be maintained in MAINTAINERS Signed-off-by: Longfang Liu --- .../ABI/testing/debugfs-hisi-migration | 36 +++++++++++++++++++ Documentation/ABI/testing/debugfs-vfio | 25 +++++++++++++ MAINTAINERS | 2 ++ 3 files changed, 63 insertions(+) create mode 100644 Documentation/ABI/testing/debugfs-hisi-migration create mode 100644 Documentation/ABI/testing/debugfs-vfio diff --git a/Documentation/ABI/testing/debugfs-hisi-migration b/Documentati= on/ABI/testing/debugfs-hisi-migration new file mode 100644 index 000000000000..791dd8a09575 --- /dev/null +++ b/Documentation/ABI/testing/debugfs-hisi-migration @@ -0,0 +1,36 @@ +What: /sys/kernel/debug/vfio//migration/hisi_acc/data +Date: Aug 2023 +KernelVersion: 6.6 +Contact: Longfang Liu +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//migration/hisi_acc/attr +Date: Aug 2023 +KernelVersion: 6.6 +Contact: Longfang Liu +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//migration/hisi_acc/io_test +Date: Aug 2023 +KernelVersion: 6.6 +Contact: Longfang Liu +Description: Trigger the HiSilicon accelerator device to perform + the io test through the read operation. If successful, + it returns the execution result of mailbox. If fails, + it returns error log result. + +What: /sys/kernel/debug/vfio//migration/hisi_acc/save +Date: Aug 2023 +KernelVersion: 6.6 +Contact: Longfang Liu +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/Documentation/ABI/testing/debugfs-vfio b/Documentation/ABI/tes= ting/debugfs-vfio new file mode 100644 index 000000000000..086a8c52df35 --- /dev/null +++ b/Documentation/ABI/testing/debugfs-vfio @@ -0,0 +1,25 @@ +What: /sys/kernel/debug/vfio +Date: Aug 2023 +KernelVersion: 6.6 +Contact: Longfang Liu +Description: This debugfs file directory is used for debugging + of vfio devices, it's a common directory for all vfio devices. + Each device should create a device subdirectory under this + directory by referencing the public registration interface. + +What: /sys/kernel/debug/vfio//migration +Date: Aug 2023 +KernelVersion: 6.6 +Contact: Longfang Liu +Description: This debugfs file directory is used for debugging + of vfio devices that support live migration. + The debugfs of each vfio device that supports live migration + could be created under this directory. + +What: /sys/kernel/debug/vfio//migration/state +Date: Aug 2023 +KernelVersion: 6.6 +Contact: Longfang Liu +Description: Read the live migration status of the vfio device. + The status of these live migrations includes: + ERROR, RUNNING, STOP, STOP_COPY, RESUMING. diff --git a/MAINTAINERS b/MAINTAINERS index d516295978a4..d4fb7547b687 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -22304,6 +22304,7 @@ L: kvm@vger.kernel.org S: Maintained T: git https://github.com/awilliam/linux-vfio.git F: Documentation/ABI/testing/sysfs-devices-vfio-dev +F: Documentation/ABI/testing/debugfs-vfio F: Documentation/driver-api/vfio.rst F: drivers/vfio/ F: include/linux/vfio.h @@ -22321,6 +22322,7 @@ M: Longfang Liu M: Shameer Kolothum L: kvm@vger.kernel.org S: Maintained +F: Documentation/ABI/testing/debugfs-hisi-migration F: drivers/vfio/pci/hisilicon/ =20 VFIO MEDIATED DEVICE DRIVERS --=20 2.24.0