[PATCH 2/2] drm/xe/kunit: Add tests for GuC KLV helpers

[John Harrison]

Seems like a lot of effort for a couple of debug print helpers. Are 
these helpers actually expected to be used in a shipping driver for more 
than just error messages?

John.


On 4/8/2024 11:14, Michal Wajdeczko wrote:
> We should make sure that recently added GuC KLV helpers are always
> working as expected.
>
> Signed-off-by: Michal Wajdeczko <michal.wajdeczko at intel.com>
> ---
>   .../drm/xe/tests/xe_guc_klv_helpers_test.c    | 200 ++++++++++++++++++
>   drivers/gpu/drm/xe/xe_guc_klv_helpers.c       |   4 +
>   2 files changed, 204 insertions(+)
>   create mode 100644 drivers/gpu/drm/xe/tests/xe_guc_klv_helpers_test.c
>
> diff --git a/drivers/gpu/drm/xe/tests/xe_guc_klv_helpers_test.c b/drivers/gpu/drm/xe/tests/xe_guc_klv_helpers_test.c
> new file mode 100644
> index 000000000000..094cd9922c73
> --- /dev/null
> +++ b/drivers/gpu/drm/xe/tests/xe_guc_klv_helpers_test.c
> @@ -0,0 +1,200 @@
> +// SPDX-License-Identifier: GPL-2.0 AND MIT
> +/*
> + * Copyright © 2024 Intel Corporation
> + */
> +
> +#include <kunit/test.h>
> +
> +static void bad_key_to_string(struct kunit *test)
> +{
> +	u16 key = 0xFFFF;
> +
> +	KUNIT_EXPECT_NOT_NULL(test, xe_guc_klv_key_to_string(key));
> +	KUNIT_EXPECT_STREQ(test, xe_guc_klv_key_to_string(key), "(unknown)");
> +}
> +
> +static void good_key_to_string(struct kunit *test)
> +{
> +	u16 key = 0x0001; /* GUC_KLV_VF_CFG_GGTT_START */
> +
> +	KUNIT_EXPECT_NOT_NULL(test, xe_guc_klv_key_to_string(key));
> +	KUNIT_EXPECT_STRNEQ(test, xe_guc_klv_key_to_string(key), "(unknown)");
> +}
> +
> +static void __to_buf_printfn(struct drm_printer *p, struct va_format *vaf)
> +{
> +	char *buf = p->arg;
> +
> +	 sprintf(buf, "%pV", vaf);
> +}
> +
> +static struct drm_printer buf_printer(char *buf)
> +{
> +	struct drm_printer p = {
> +		.printfn = __to_buf_printfn,
> +		.arg = buf,
> +	};
> +	return p;
> +}
> +
> +static void print_empty_klv(struct kunit *test)
> +{
> +	char buf[128] = {};
> +	struct drm_printer p = buf_printer(buf);
> +	u32 klv[] = {
> +		FIELD_PREP(GUC_KLV_0_KEY, 0) | FIELD_PREP(GUC_KLV_0_LEN, 0),
> +	};
> +
> +	KUNIT_EXPECT_STREQ(test, buf, "");
> +	xe_guc_klv_print(klv, ARRAY_SIZE(klv), &p);
> +	KUNIT_EXPECT_STRNEQ(test, buf, "");
> +	KUNIT_EXPECT_NOT_NULL(test, strstr(buf, "key"));
> +	KUNIT_EXPECT_NOT_NULL(test, strstr(buf, "no value"));
> +	kunit_info(test, "%s", buf);
> +}
> +
> +static void print_klv32(struct kunit *test)
> +{
> +	char buf[128] = {};
> +	struct drm_printer p = buf_printer(buf);
> +	u32 klv[] = {
> +		FIELD_PREP(GUC_KLV_0_KEY, 0) | FIELD_PREP(GUC_KLV_0_LEN, 1),
> +		12345678,
> +	};
> +
> +	KUNIT_EXPECT_STREQ(test, buf, "");
> +	xe_guc_klv_print(klv, ARRAY_SIZE(klv), &p);
> +	KUNIT_EXPECT_STRNEQ(test, buf, "");
> +	KUNIT_EXPECT_NOT_NULL(test, strstr(buf, "key"));
> +	KUNIT_EXPECT_NOT_NULL(test, strstr(buf, "32b value"));
> +	KUNIT_EXPECT_NOT_NULL(test, strstr(buf, "12345678"));
> +	kunit_info(test, "%s", buf);
> +}
> +
> +static void print_klv64(struct kunit *test)
> +{
> +	char buf[128] = {};
> +	struct drm_printer p = buf_printer(buf);
> +	u32 klv[] = {
> +		FIELD_PREP(GUC_KLV_0_KEY, 0) | FIELD_PREP(GUC_KLV_0_LEN, 2),
> +		0x87654321,
> +		0x12345678,
> +	};
> +
> +	KUNIT_EXPECT_STREQ(test, buf, "");
> +	xe_guc_klv_print(klv, ARRAY_SIZE(klv), &p);
> +	KUNIT_EXPECT_STRNEQ(test, buf, "");
> +	KUNIT_EXPECT_NOT_NULL(test, strstr(buf, "key"));
> +	KUNIT_EXPECT_NOT_NULL(test, strstr(buf, "64b value"));
> +	KUNIT_EXPECT_NOT_NULL(test, strstr(buf, "0x1234567887654321"));
> +	kunit_info(test, "%s", buf);
> +}
> +
> +static void print_big_klv(struct kunit *test)
> +{
> +	char buf[128] = {};
> +	struct drm_printer p = buf_printer(buf);
> +	u32 klv[] = {
> +		FIELD_PREP(GUC_KLV_0_KEY, 0) | FIELD_PREP(GUC_KLV_0_LEN, 3),
> +		0x11111111,
> +		0x22222222,
> +		0x33333333,
> +	};
> +
> +	KUNIT_EXPECT_STREQ(test, buf, "");
> +	xe_guc_klv_print(klv, ARRAY_SIZE(klv), &p);
> +	KUNIT_EXPECT_STRNEQ(test, buf, "");
> +	KUNIT_EXPECT_NOT_NULL(test, strstr(buf, "key"));
> +	KUNIT_EXPECT_NOT_NULL(test, strstr(buf, "bytes"));
> +	KUNIT_EXPECT_NULL(test, strstr(buf, "truncated"));
> +	kunit_info(test, "%s", buf);
> +}
> +
> +static void print_truncated_klv(struct kunit *test)
> +{
> +	char buf[128] = {};
> +	struct drm_printer p = buf_printer(buf);
> +	u32 klv[] = {
> +		FIELD_PREP(GUC_KLV_0_KEY, 0) | FIELD_PREP(GUC_KLV_0_LEN, 2),
> +		0x04030201,
> +	};
> +
> +	KUNIT_EXPECT_STREQ(test, buf, "");
> +	xe_guc_klv_print(klv, ARRAY_SIZE(klv), &p);
> +	KUNIT_EXPECT_STRNEQ(test, buf, "");
> +	KUNIT_EXPECT_NOT_NULL(test, strstr(buf, "key"));
> +	KUNIT_EXPECT_NOT_NULL(test, strstr(buf, "truncated"));
> +	KUNIT_EXPECT_NOT_NULL(test, strstr(buf, "bytes"));
> +	kunit_info(test, "%s", buf);
> +}
> +
> +static void count_no_klvs(struct kunit *test)
> +{
> +	u32 klvs[GUC_KLV_LEN_MIN];
> +
> +	KUNIT_EXPECT_EQ(test, 0, xe_guc_klv_count(NULL, 0));
> +	KUNIT_EXPECT_EQ(test, 0, xe_guc_klv_count(klvs, 0));
> +}
> +
> +static void count_empty_klvs(struct kunit *test)
> +{
> +	u32 klvs[] = {
> +		FIELD_PREP(GUC_KLV_0_KEY, 0) | FIELD_PREP(GUC_KLV_0_LEN, 0),
> +		FIELD_PREP(GUC_KLV_0_KEY, 0) | FIELD_PREP(GUC_KLV_0_LEN, 0),
> +		FIELD_PREP(GUC_KLV_0_KEY, 0) | FIELD_PREP(GUC_KLV_0_LEN, 0),
> +		FIELD_PREP(GUC_KLV_0_KEY, 0) | FIELD_PREP(GUC_KLV_0_LEN, 0),
> +	};
> +	size_t n;
> +
> +	for (n = 1; n <= ARRAY_SIZE(klvs); n++)
> +		KUNIT_EXPECT_EQ(test, n, xe_guc_klv_count(klvs, n));
> +}
> +
> +static void count_mixed_klvs(struct kunit *test)
> +{
> +	u32 klvs[] = {
> +		FIELD_PREP(GUC_KLV_0_KEY, 1) | FIELD_PREP(GUC_KLV_0_LEN, 0),
> +		FIELD_PREP(GUC_KLV_0_KEY, 2) | FIELD_PREP(GUC_KLV_0_LEN, 1),
> +		1,
> +		FIELD_PREP(GUC_KLV_0_KEY, 3) | FIELD_PREP(GUC_KLV_0_LEN, 2),
> +		1, 2,
> +		FIELD_PREP(GUC_KLV_0_KEY, 4) | FIELD_PREP(GUC_KLV_0_LEN, 3),
> +		1, 2, 3,
> +		FIELD_PREP(GUC_KLV_0_KEY, 5) | FIELD_PREP(GUC_KLV_0_LEN, 0),
> +	};
> +
> +	KUNIT_EXPECT_NE(test, 5, ARRAY_SIZE(klvs));
> +	KUNIT_EXPECT_EQ(test, 5, xe_guc_klv_count(klvs, ARRAY_SIZE(klvs)));
> +}
> +
> +static void count_truncated_klvs(struct kunit *test)
> +{
> +	u32 klvs[] = {
> +		FIELD_PREP(GUC_KLV_0_KEY, 0) | FIELD_PREP(GUC_KLV_0_LEN, 0),
> +		FIELD_PREP(GUC_KLV_0_KEY, 0) | FIELD_PREP(GUC_KLV_0_LEN, 2),
> +	};
> +
> +	KUNIT_EXPECT_GT(test, 0, xe_guc_klv_count(klvs, ARRAY_SIZE(klvs)));
> +}
> +
> +static struct kunit_case guc_klv_helpers_test_cases[] = {
> +	KUNIT_CASE(bad_key_to_string),
> +	KUNIT_CASE(good_key_to_string),
> +	KUNIT_CASE(print_empty_klv),
> +	KUNIT_CASE(print_klv32),
> +	KUNIT_CASE(print_klv64),
> +	KUNIT_CASE(print_big_klv),
> +	KUNIT_CASE(print_truncated_klv),
> +	KUNIT_CASE(count_no_klvs),
> +	KUNIT_CASE(count_empty_klvs),
> +	KUNIT_CASE(count_mixed_klvs),
> +	KUNIT_CASE(count_truncated_klvs),
> +	{}
> +};
> +
> +static struct kunit_suite guc_klv_helpers_suite = {
> +	.name = "guc_klv",
> +	.test_cases = guc_klv_helpers_test_cases,
> +};
> +
> +kunit_test_suites(&guc_klv_helpers_suite);
> diff --git a/drivers/gpu/drm/xe/xe_guc_klv_helpers.c b/drivers/gpu/drm/xe/xe_guc_klv_helpers.c
> index c39fda08afcb..bc98a80cc209 100644
> --- a/drivers/gpu/drm/xe/xe_guc_klv_helpers.c
> +++ b/drivers/gpu/drm/xe/xe_guc_klv_helpers.c
> @@ -131,3 +131,7 @@ int xe_guc_klv_count(const u32 *klvs, u32 num_dwords)
>   
>   	return num_dwords ? -ENODATA : num_klvs;
>   }
> +
> +#if IS_BUILTIN(CONFIG_DRM_XE_KUNIT_TEST)
> +#include "tests/xe_guc_klv_helpers_test.c"
> +#endif