[v4,4/4] iommufd/selftest: Add coverage for IOMMU_GET_HW_INFO ioctl

Message ID 20230724105936.107042-5-yi.l.liu@intel.com
State New
Headers
Series iommufd: Add iommu hardware info reporting |

Commit Message

Yi Liu July 24, 2023, 10:59 a.m. UTC
  From: Nicolin Chen <nicolinc@nvidia.com>

Add a mock_domain_hw_info function and an iommu_test_hw_info data
structure. This allows to test the IOMMU_GET_HW_INFO ioctl passing
the test_reg value for the mock_dev.

Signed-off-by: Nicolin Chen <nicolinc@nvidia.com>
Signed-off-by: Yi Liu <yi.l.liu@intel.com>
---
 drivers/iommu/iommufd/device.c                |  1 +
 drivers/iommu/iommufd/iommufd_test.h          |  9 +++++++
 drivers/iommu/iommufd/selftest.c              | 16 ++++++++++++
 tools/testing/selftests/iommu/iommufd.c       | 17 +++++++++++-
 tools/testing/selftests/iommu/iommufd_utils.h | 26 +++++++++++++++++++
 5 files changed, 68 insertions(+), 1 deletion(-)
  

Comments

Jason Gunthorpe July 24, 2023, 5:52 p.m. UTC | #1
On Mon, Jul 24, 2023 at 03:59:36AM -0700, Yi Liu wrote:
> diff --git a/tools/testing/selftests/iommu/iommufd_utils.h b/tools/testing/selftests/iommu/iommufd_utils.h
> index 70353e68e599..f13df84f6b42 100644
> --- a/tools/testing/selftests/iommu/iommufd_utils.h
> +++ b/tools/testing/selftests/iommu/iommufd_utils.h
> @@ -348,3 +348,29 @@ static void teardown_iommufd(int fd, struct __test_metadata *_metadata)
>  	})
>  
>  #endif
> +
> +static int _test_cmd_get_hw_info(int fd, __u32 device_id,
> +				 __u32 data_len, void *data)

void * data,size_t data_len

Jason
  
Tian, Kevin July 27, 2023, 8:14 a.m. UTC | #2
> From: Liu, Yi L <yi.l.liu@intel.com>
> Sent: Monday, July 24, 2023 7:00 PM
> 
> --- a/drivers/iommu/iommufd/device.c
> +++ b/drivers/iommu/iommufd/device.c
> @@ -8,6 +8,7 @@
> 
>  #include "io_pagetable.h"
>  #include "iommufd_private.h"
> +#include "iommufd_test.h"

Is it stale?

> @@ -211,7 +213,7 @@ FIXTURE_SETUP(iommufd_ioas)
> 
>  	for (i = 0; i != variant->mock_domains; i++) {
>  		test_cmd_mock_domain(self->ioas_id, &self->stdev_id,
> -				     &self->hwpt_id, NULL);
> +				     &self->hwpt_id, &self->device_id);
>  		self->base_iova = MOCK_APERTURE_START;
>  	}
>  }
> @@ -290,6 +292,19 @@ TEST_F(iommufd_ioas, ioas_area_auto_destroy)
>  	}
>  }
> 
> +TEST_F(iommufd_ioas, get_hw_info)
> +{
> +	struct iommu_test_hw_info info;
> +
> +	if (self->device_id) {
> +		test_cmd_get_hw_info(self->device_id, sizeof(info), &info);
> +		assert(info.test_reg ==
> IOMMU_HW_INFO_SELFTEST_REGVAL);
> +	} else {
> +		test_err_get_hw_info(ENOENT, self->device_id,
> +				     sizeof(info), &info);
> +	}

If self->device_id is invalid it should be reported right after
test_cmd_mock_domain()?
  
Nicolin Chen July 27, 2023, 8:35 a.m. UTC | #3
On Mon, Jul 24, 2023 at 02:52:14PM -0300, Jason Gunthorpe wrote:
> On Mon, Jul 24, 2023 at 03:59:36AM -0700, Yi Liu wrote:
> > diff --git a/tools/testing/selftests/iommu/iommufd_utils.h b/tools/testing/selftests/iommu/iommufd_utils.h
> > index 70353e68e599..f13df84f6b42 100644
> > --- a/tools/testing/selftests/iommu/iommufd_utils.h
> > +++ b/tools/testing/selftests/iommu/iommufd_utils.h
> > @@ -348,3 +348,29 @@ static void teardown_iommufd(int fd, struct __test_metadata *_metadata)
> >  	})
> >  
> >  #endif
> > +
> > +static int _test_cmd_get_hw_info(int fd, __u32 device_id,
> > +				 __u32 data_len, void *data)
> 
> void * data,size_t data_len

OK!
  
Nicolin Chen July 27, 2023, 8:38 a.m. UTC | #4
Hi Kevin,

On Thu, Jul 27, 2023 at 08:14:45AM +0000, Tian, Kevin wrote:
 
> > From: Liu, Yi L <yi.l.liu@intel.com>
> > Sent: Monday, July 24, 2023 7:00 PM
> >
> > --- a/drivers/iommu/iommufd/device.c
> > +++ b/drivers/iommu/iommufd/device.c
> > @@ -8,6 +8,7 @@
> >
> >  #include "io_pagetable.h"
> >  #include "iommufd_private.h"
> > +#include "iommufd_test.h"
> 
> Is it stale?

Ah, should've dropped it.

> > @@ -211,7 +213,7 @@ FIXTURE_SETUP(iommufd_ioas)
> >
> >       for (i = 0; i != variant->mock_domains; i++) {
> >               test_cmd_mock_domain(self->ioas_id, &self->stdev_id,
> > -                                  &self->hwpt_id, NULL);
> > +                                  &self->hwpt_id, &self->device_id);
> >               self->base_iova = MOCK_APERTURE_START;
> >       }
> >  }
> > @@ -290,6 +292,19 @@ TEST_F(iommufd_ioas, ioas_area_auto_destroy)
> >       }
> >  }
> >
> > +TEST_F(iommufd_ioas, get_hw_info)
> > +{
> > +     struct iommu_test_hw_info info;
> > +
> > +     if (self->device_id) {
> > +             test_cmd_get_hw_info(self->device_id, sizeof(info), &info);
> > +             assert(info.test_reg ==
> > IOMMU_HW_INFO_SELFTEST_REGVAL);
> > +     } else {
> > +             test_err_get_hw_info(ENOENT, self->device_id,
> > +                                  sizeof(info), &info);
> > +     }
> 
> If self->device_id is invalid it should be reported right after
> test_cmd_mock_domain()?

A device_id is created per mock_domain. And mock_domain is a
variant that could be 0, so a device_id being 0 could be a
normal case. Here the invalid test is for negative coverage.

Thanks!
Nic
  
Tian, Kevin July 27, 2023, 9:14 a.m. UTC | #5
> From: Nicolin Chen <nicolinc@nvidia.com>
> Sent: Thursday, July 27, 2023 4:38 PM
> > >
> > > +TEST_F(iommufd_ioas, get_hw_info)
> > > +{
> > > +     struct iommu_test_hw_info info;
> > > +
> > > +     if (self->device_id) {
> > > +             test_cmd_get_hw_info(self->device_id, sizeof(info), &info);
> > > +             assert(info.test_reg ==
> > > IOMMU_HW_INFO_SELFTEST_REGVAL);
> > > +     } else {
> > > +             test_err_get_hw_info(ENOENT, self->device_id,
> > > +                                  sizeof(info), &info);
> > > +     }
> >
> > If self->device_id is invalid it should be reported right after
> > test_cmd_mock_domain()?
> 
> A device_id is created per mock_domain. And mock_domain is a
> variant that could be 0, so a device_id being 0 could be a
> normal case. Here the invalid test is for negative coverage.
> 

I see. thanks
  

Patch

diff --git a/drivers/iommu/iommufd/device.c b/drivers/iommu/iommufd/device.c
index 1015d6c42e2b..0deb2a2ec01a 100644
--- a/drivers/iommu/iommufd/device.c
+++ b/drivers/iommu/iommufd/device.c
@@ -8,6 +8,7 @@ 
 
 #include "io_pagetable.h"
 #include "iommufd_private.h"
+#include "iommufd_test.h"
 
 static bool allow_unsafe_interrupts;
 module_param(allow_unsafe_interrupts, bool, S_IRUGO | S_IWUSR);
diff --git a/drivers/iommu/iommufd/iommufd_test.h b/drivers/iommu/iommufd/iommufd_test.h
index 258de2253b61..3f3644375bf1 100644
--- a/drivers/iommu/iommufd/iommufd_test.h
+++ b/drivers/iommu/iommufd/iommufd_test.h
@@ -100,4 +100,13 @@  struct iommu_test_cmd {
 };
 #define IOMMU_TEST_CMD _IO(IOMMUFD_TYPE, IOMMUFD_CMD_BASE + 32)
 
+/* Mock structs for IOMMU_DEVICE_GET_HW_INFO ioctl */
+#define IOMMU_HW_INFO_TYPE_SELFTEST	0xfeedbeef
+#define IOMMU_HW_INFO_SELFTEST_REGVAL	0xdeadbeef
+
+struct iommu_test_hw_info {
+	__u32 flags;
+	__u32 test_reg;
+};
+
 #endif
diff --git a/drivers/iommu/iommufd/selftest.c b/drivers/iommu/iommufd/selftest.c
index bb2cd54ca7b6..af7459e211ad 100644
--- a/drivers/iommu/iommufd/selftest.c
+++ b/drivers/iommu/iommufd/selftest.c
@@ -128,6 +128,20 @@  static struct iommu_domain mock_blocking_domain = {
 	.ops = &mock_blocking_ops,
 };
 
+static void *mock_domain_hw_info(struct device *dev, u32 *length)
+{
+	struct iommu_test_hw_info *info;
+
+	info = kzalloc(sizeof(*info), GFP_KERNEL);
+	if (!info)
+		return ERR_PTR(-ENOMEM);
+
+	info->test_reg = IOMMU_HW_INFO_SELFTEST_REGVAL;
+	*length = sizeof(*info);
+
+	return info;
+}
+
 static struct iommu_domain *mock_domain_alloc(unsigned int iommu_domain_type)
 {
 	struct mock_iommu_domain *mock;
@@ -279,6 +293,8 @@  static void mock_domain_set_plaform_dma_ops(struct device *dev)
 static const struct iommu_ops mock_ops = {
 	.owner = THIS_MODULE,
 	.pgsize_bitmap = MOCK_IO_PAGE_SIZE,
+	.hw_info_type = IOMMU_HW_INFO_TYPE_SELFTEST,
+	.hw_info = mock_domain_hw_info,
 	.domain_alloc = mock_domain_alloc,
 	.capable = mock_domain_capable,
 	.set_platform_dma_ops = mock_domain_set_plaform_dma_ops,
diff --git a/tools/testing/selftests/iommu/iommufd.c b/tools/testing/selftests/iommu/iommufd.c
index 8acd0af37aa5..6b075a68b928 100644
--- a/tools/testing/selftests/iommu/iommufd.c
+++ b/tools/testing/selftests/iommu/iommufd.c
@@ -113,6 +113,7 @@  TEST_F(iommufd, cmd_length)
 	}
 
 	TEST_LENGTH(iommu_destroy, IOMMU_DESTROY);
+	TEST_LENGTH(iommu_hw_info, IOMMU_GET_HW_INFO);
 	TEST_LENGTH(iommu_ioas_alloc, IOMMU_IOAS_ALLOC);
 	TEST_LENGTH(iommu_ioas_iova_ranges, IOMMU_IOAS_IOVA_RANGES);
 	TEST_LENGTH(iommu_ioas_allow_iovas, IOMMU_IOAS_ALLOW_IOVAS);
@@ -185,6 +186,7 @@  FIXTURE(iommufd_ioas)
 	uint32_t ioas_id;
 	uint32_t stdev_id;
 	uint32_t hwpt_id;
+	uint32_t device_id;
 	uint64_t base_iova;
 };
 
@@ -211,7 +213,7 @@  FIXTURE_SETUP(iommufd_ioas)
 
 	for (i = 0; i != variant->mock_domains; i++) {
 		test_cmd_mock_domain(self->ioas_id, &self->stdev_id,
-				     &self->hwpt_id, NULL);
+				     &self->hwpt_id, &self->device_id);
 		self->base_iova = MOCK_APERTURE_START;
 	}
 }
@@ -290,6 +292,19 @@  TEST_F(iommufd_ioas, ioas_area_auto_destroy)
 	}
 }
 
+TEST_F(iommufd_ioas, get_hw_info)
+{
+	struct iommu_test_hw_info info;
+
+	if (self->device_id) {
+		test_cmd_get_hw_info(self->device_id, sizeof(info), &info);
+		assert(info.test_reg == IOMMU_HW_INFO_SELFTEST_REGVAL);
+	} else {
+		test_err_get_hw_info(ENOENT, self->device_id,
+				     sizeof(info), &info);
+	}
+}
+
 TEST_F(iommufd_ioas, area)
 {
 	int i;
diff --git a/tools/testing/selftests/iommu/iommufd_utils.h b/tools/testing/selftests/iommu/iommufd_utils.h
index 70353e68e599..f13df84f6b42 100644
--- a/tools/testing/selftests/iommu/iommufd_utils.h
+++ b/tools/testing/selftests/iommu/iommufd_utils.h
@@ -348,3 +348,29 @@  static void teardown_iommufd(int fd, struct __test_metadata *_metadata)
 	})
 
 #endif
+
+static int _test_cmd_get_hw_info(int fd, __u32 device_id,
+				 __u32 data_len, void *data)
+{
+	struct iommu_hw_info cmd = {
+		.size = sizeof(cmd),
+		.dev_id = device_id,
+		.data_len = data_len,
+		.data_ptr = (uint64_t)data,
+	};
+	int ret;
+
+	ret = ioctl(fd, IOMMU_GET_HW_INFO, &cmd);
+	if (ret)
+		return ret;
+	return 0;
+}
+
+#define test_cmd_get_hw_info(device_id, data_len, data)         \
+	ASSERT_EQ(0, _test_cmd_get_hw_info(self->fd, device_id, \
+						  data_len, data))
+
+#define test_err_get_hw_info(_errno, device_id, data_len, data) \
+	EXPECT_ERRNO(_errno,                                    \
+		     _test_cmd_get_hw_info(self->fd, device_id, \
+						  data_len, data))