KUnit tests for drm_format_helper
Subsystems (2)
cover KUnit tests for drm_format_helper
Hello everyone,
Recently Javier added a new task in the ToDo list [1] to create KUnit tests for the functions present in "drm_format_helper".
This patch, marked as RFC to start the conversation, includes tests for "drm_fb_xrgb8888_to_rgb332".
Since the conversion functions present in "drm_format_helper" convert from XRGB8888 to another format, my plan is to create a set of XRGB8888 data to test all the available conversions.
To illustrate it with an example, the code present in this patch:
{
.name = "Single pixel source",
.pitch = 1 * 4,
.dst_pitch = 0,
.clip = CLIP(0, 0, 1, 1),
.xrgb8888 = { 0x01FF0000 },
.expected = { 0xE0 },
}In a follow up patch, should look like:
{
.name = "Single pixel source",
.pitch = 1 * 4,
.clip = CLIP(0, 0, 1, 1),
.xrgb8888 = { 0x01FF0000 },
.expected = {
{
.dst_format = DRM_FORMAT_RGB332,
.dst_pitch = 0,
.conv_func = drm_fb_xrgb8888_to_rgb332,
.result = { 0xE0 },
},
{ ... },
},
}What is tested?
- Different values for the X in XRGB8888 to make sure it is ignored
- Different clip values: Single pixel and full and partial buffer
- Well know colors: White, black, red, green, blue, magenta, yellow and cyan
- Other colors: Randomly picked
- Destination pitch
What is NOT tested?
- NULL destination buffer: Because there is not validation in place
- Out of bounds destination buffer: The size of the buffer is not checked. The conversion function could cause out of bound errors
- Out of bounds source buffer: Similary to the destination buffer, the source buffer is read without checking its size
- Invalid clip values: Because there is no clip validation.
Example: clip out of or bigger than the source buffer
- Invalid destination pitch: A dst_pitch < (clip->width * dst_pixsize) could cause issues.
- "Big" source buffers. I don't know if this kind of tests could be of interest
How to run the tests?
My .kunitconfig:
CONFIG_KUNIT=y
CONFIG_DRM=y
CONFIG_DRM_FORMAR_HELPER_TEST=y
$ ./tools/testing/kunit/kunit.py run --arch=x86_64
Feedback?
It'd be great to know your ideas about what else we could test, if you think that we should make the functions safer by checking the buffers and clip sizes or anything else.
Thanks a lot,
José Expósito
[1] https://cgit.freedesktop.org/drm/drm-misc/commit/?id=596c35b1440e
José Expósito (1):
drm/format-helper: Add KUnit tests for drm_fb_xrgb8888_to_rgb332()
drivers/gpu/drm/Kconfig | 12 ++ drivers/gpu/drm/Makefile | 3 + drivers/gpu/drm/drm_format_helper_test.c | 166 +++++++++++++++++++++++ 3 files changed, 181 insertions(+) create mode 100644 drivers/gpu/drm/drm_format_helper_test.c
Signature · 1 line
2.25.1
RFC PATCH 1/1 drm/format-helper: Add KUnit tests for drm_fb_xrgb8888_to_rgb332()
Test the conversion from XRGB8888 to RGB332.
What is tested?
- Different values for the X in XRGB8888 to make sure it is ignored
- Different clip values: Single pixel and full and partial buffer
- Well know colors: White, black, red, green, blue, magenta, yellow and cyan
- Other colors: Randomly picked
- Destination pitch
--- drivers/gpu/drm/Kconfig | 12 ++ drivers/gpu/drm/Makefile | 3 + drivers/gpu/drm/drm_format_helper_test.c | 166 +++++++++++++++++++++++ 3 files changed, 181 insertions(+) create mode 100644 drivers/gpu/drm/drm_format_helper_test.c
drivers/gpu/drm/Kconfig +12 -0
@@ -76,6 +76,18 @@ config DRM_KMS_HELPER help CRTC helpers for KMS drivers. +config DRM_FORMAR_HELPER_TEST + bool "drm_format_helper tests" if !KUNIT_ALL_TESTS + depends on DRM && KUNIT=y + select DRM_KMS_HELPER + default KUNIT_ALL_TESTS + help + KUnit tests for the drm_format_helper APIs. This option is not + useful for distributions or general kernels, but only for kernel + developers working on DRM and associated drivers. + + If in doubt, say "N". + config DRM_DEBUG_DP_MST_TOPOLOGY_REFS bool "Enable refcount backtrace history in the DP MST helpers" depends on STACKTRACE_SUPPORT
drivers/gpu/drm/Makefile +3 -0
@@ -76,6 +76,9 @@ obj-$(CONFIG_DRM_KMS_HELPER) += drm_kms_helper.o # obj-$(CONFIG_DRM_DEBUG_SELFTEST) += selftests/ +obj-$(CONFIG_DRM_FORMAR_HELPER_TEST) += drm_kms_helper.o \ + drm_format_helper_test.o +CFLAGS_drm_format_helper_test.o += $(DISABLE_STRUCTLEAK_PLUGIN) obj-$(CONFIG_DRM_MIPI_DBI) += drm_mipi_dbi.o obj-$(CONFIG_DRM_MIPI_DSI) += drm_mipi_dsi.o
drivers/gpu/drm/drm_format_helper_test.c new file +166 -0
166 lines not on this page · raw message
Signature · 1 line
2.25.1
Re: [RFC PATCH 1/1] drm/format-helper: Add KUnit tests for drm_fb_xrgb8888_to_rgb332()
Hi,
Quoted 11 lines · José Expósito
Test the conversion from XRGB8888 to RGB332.
What is tested?
- Different values for the X in XRGB8888 to make sure it is ignored
- Different clip values: Single pixel and full and partial buffer
- Well know colors: White, black, red, green, blue, magenta, yellow and cyan
- Other colors: Randomly picked
- Destination pitch
Quoted 2 lines
Suggested-by Javier Martinez Canillas <[email protected]>Signed-off-by José Expósito <[email protected]>
It looks mostly good to me, but I think we should Cc [email protected] to have their feedback.
Quoted 17 lines
--- drivers/gpu/drm/Kconfig | 12 ++ drivers/gpu/drm/Makefile | 3 + drivers/gpu/drm/drm_format_helper_test.c | 166 +++++++++++++++++++++++ 3 files changed, 181 insertions(+) create mode 100644 drivers/gpu/drm/drm_format_helper_test.cdrivers/gpu/drm/Kconfig +2
-0@@ -76,6 +76,18 @@ config DRM_KMS_HELPER help CRTC helpers for KMS drivers. +config DRM_FORMAR_HELPER_TEST + bool "drm_format_helper tests" if !KUNIT_ALL_TESTS
drivers/gpu/drm/Kconfig config DRM_KMS_HELPER · line 90
Quoted 10 lines
drivers/gpu/drm/Kconfig +10
-0+ depends on DRM && KUNIT=y + select DRM_KMS_HELPER + default KUNIT_ALL_TESTS + help + KUnit tests for the drm_format_helper APIs. This option is not + useful for distributions or general kernels, but only for kernel + developers working on DRM and associated drivers. + + If in doubt, say "N". +
AFAIK, kunit test cases are supposed to have a .kunitconfig too to enable the kunit tests easily.
Maxime
Re: [RFC PATCH 1/1] drm/format-helper: Add KUnit tests for drm_fb_xrgb8888_to_rgb332()
Hi Maxime,
Quoted 15 lines · Maxime Ripard
Hi,
Quoted 11 lines · José Expósito
Test the conversion from XRGB8888 to RGB332.
What is tested?
- Different values for the X in XRGB8888 to make sure it is ignored
- Different clip values: Single pixel and full and partial buffer
- Well know colors: White, black, red, green, blue, magenta, yellow and cyan
- Other colors: Randomly picked
- Destination pitch
Quoted 5 lines
Quoted 2 lines
Suggested-by Javier Martinez Canillas <[email protected]>Signed-off-by José Expósito <[email protected]>It looks mostly good to me, but I think we should Cc [email protected] to have their feedback.
Thanks a lot for the quick feedback.
I just cc'ed [email protected]. For anyone joining the conversation, here is the link to the patch and the cover letter with some questions:
https://lore.kernel.org/dri-devel/[email protected]/T/
Quoted 32 lines
Quoted 18 lines
--- drivers/gpu/drm/Kconfig | 12 ++ drivers/gpu/drm/Makefile | 3 + drivers/gpu/drm/drm_format_helper_test.c | 166 +++++++++++++++++++++++ 3 files changed, 181 insertions(+) create mode 100644 drivers/gpu/drm/drm_format_helper_test.cdrivers/gpu/drm/Kconfig +2
-0@@ -76,6 +76,18 @@ config DRM_KMS_HELPER help CRTC helpers for KMS drivers. +config DRM_FORMAR_HELPER_TEST + bool "drm_format_helper tests" if !KUNIT_ALL_TESTSdrivers/gpu/drm/Kconfig config DRM_KMS_HELPER · line 90
Quoted 10 lines
drivers/gpu/drm/Kconfig +10
-0+ depends on DRM && KUNIT=y + select DRM_KMS_HELPER + default KUNIT_ALL_TESTS + help + KUnit tests for the drm_format_helper APIs. This option is not + useful for distributions or general kernels, but only for kernel + developers working on DRM and associated drivers. + + If in doubt, say "N". +AFAIK, kunit test cases are supposed to have a .kunitconfig too to enable the kunit tests easily.
Quoted 1 line
Maxime
A .kuniconfig example is present in the cover letter. My understanding from the docs:
https://docs.kernel.org/dev-tools/kunit/run_wrapper.html#create-a-kunitconfig-file
Is that, like the .config file, the .kunitconfig file is not meant to be included in git, but I'm sure someone else will clarify this point.
Thanks again,
José Expósito
Re: [RFC PATCH 1/1] drm/format-helper: Add KUnit tests for drm_fb_xrgb8888_to_rgb332()
Quoted 5 lines · José Expósito
I just cc'ed [email protected]. For anyone joining the conversation, here is the link to the patch and the cover letter with some questions:
Thanks for the link.
A few initial notes:
a) normally, selecting other kconfigs is discouraged. It's not explicitly called out in
https://www.kernel.org/doc/html/latest/dev-tools/kunit/style.html#test-kconfig-entries
but this was the conclusion after some debate on the mailing lists earlier.
b) I see dst is allocated with kzalloc but not freed. Should we use kunit_kzalloc() instead so it does get automatically freed?
Quoted 17 lines
Quoted 17 lines
Quoted 17 lines
--- drivers/gpu/drm/Kconfig | 12 ++ drivers/gpu/drm/Makefile | 3 + drivers/gpu/drm/drm_format_helper_test.c | 166 +++++++++++++++++++++++ 3 files changed, 181 insertions(+) create mode 100644 drivers/gpu/drm/drm_format_helper_test.cdrivers/gpu/drm/Kconfig +0
-0@@ -76,6 +76,18 @@ config DRM_KMS_HELPER help CRTC helpers for KMS drivers.
Quoted 4 lines
Quoted 4 lines
drivers/gpu/drm/Kconfig config DRM_KMS_HELPER · line 82
Quoted 4 lines
drivers/gpu/drm/Kconfig +4
-0+config DRM_FORMAR_HELPER_TEST + bool "drm_format_helper tests" if !KUNIT_ALL_TESTS + depends on DRM && KUNIT=y + select DRM_KMS_HELPER
From above, a)
Specifically here, it'd be encouraged to instead do
depends on DRM && KUNIT=y && DRM_KMS_HELPER
Ideally, using a .kunitconfig file would make it so having to select DRM_KMS_HELPER manually isn't that annoying.
Quoted 9 lines
Quoted 4 lines
AFAIK, kunit test cases are supposed to have a .kunitconfig too to enable the kunit tests easily.
Maxime
A .kuniconfig example is present in the cover letter. My understanding from the docs:
https://docs.kernel.org/dev-tools/kunit/run_wrapper.html#create-a-kunitconfig-file
The bit of the documentation you're looking for is
https://www.kernel.org/doc/html/latest/dev-tools/kunit/running_tips.html#defining-a-set-of-tests
You can create a drivers/gpu/drm/.kunitconfig file and run with
$ ./tools/testing/kunit/kunit.py run --kunitconfig=drivers/gpu/drm --arch=x86_86
The contents of that file would be just like
CONFIG_KUNIT=y
CONFIG_DRM=y
CONFIG_DRM_KMS_HELPER=y # if no select
CONFIG_DRM_FORMAR_HELPER_TEST=y
Re "kunit test cases are supposed to have a .kunitconfig too" As I noted in the docs:
This is a relatively new feature (5.12+) so we don’t have any
conventions yet about on what files should be checked in versus just kept around locally. It’s up to you and your maintainer to decide if a config is useful enough to submit (and therefore have to maintain).
So it's up to whatever people think works best/is worth it. I think in this case, it makes sense to add the file.
Quoted 2 lines
Is that, like the .config file, the .kunitconfig file is not meant to be included in git, but I'm sure someone else will clarify this point.
That bit of the docs needs to be rewritten.
You're recommended to check in a drivers/gpu/drm/.kunitconfig file into git.
Context: kunit.py used to use the "<root>/.kunitconfig" file. Anytime you wanted to run more tests, you'd append to that file. So we agreed that no one should check in that file specifically.
Now kunit.py
* uses "<build-dir>/.kunitconfig", by default: ".kunit/.kunitconfig"
* has the --kunitconfig flag so you can use different files so it's no longer as relevant.
Hope that helps,
Daniel
Re: [RFC PATCH 1/1] drm/format-helper: Add KUnit tests for drm_fb_xrgb8888_to_rgb332()
Hi Daniel,
Thanks for looking into the patch and for your comments.
Quoted 9 lines · Daniel Latypov
A few initial notes:
a) normally,selecting other kconfigs is discouraged. It's not explicitly called out in
https://www.kernel.org/doc/html/latest/dev-tools/kunit/style.html#test-kconfig-entries
but this was the conclusion after some debate on the mailing lists earlier.b) I see
dstis allocated with kzalloc but not freed. Should we usekunit_kzalloc()instead so it does get automatically freed?
Ooops yes, it was in my "I'll handle that once it works" list, but I forgot to fix it, thanks for pointing it out
Quoted 15 lines
Quoted 15 lines
Quoted 15 lines
Quoted 15 lines
--- drivers/gpu/drm/Kconfig | 12 ++ drivers/gpu/drm/Makefile | 3 + drivers/gpu/drm/drm_format_helper_test.c | 166 +++++++++++++++++++++++ 3 files changed, 181 insertions(+) create mode 100644 drivers/gpu/drm/drm_format_helper_test.cdrivers/gpu/drm/Kconfig +0
-0@@ -76,6 +76,18 @@ config DRM_KMS_HELPER help CRTC helpers for KMS drivers.
Quoted 8 lines
Quoted 4 lines
Quoted 4 lines
drivers/gpu/drm/Kconfig config DRM_KMS_HELPER · line 82
Quoted 4 lines
drivers/gpu/drm/Kconfig +4
-0+config DRM_FORMAR_HELPER_TEST + bool "drm_format_helper tests" if !KUNIT_ALL_TESTS + depends on DRM && KUNIT=y + select DRM_KMS_HELPERFrom above, a)
Specifically here, it'd be encouraged to instead do
depends on DRM && KUNIT=y &&DRM_KMS_HELPER
My first attempt was to go with:
depends on KUNIT=y && DRM && DRM_KMS_HELPER
However, when I try to run the tests I get this error:
$ ./tools/testing/kunit/kunit.py run --kunitconfig=drivers/gpu/drm --arch=x86_64 Regenerating .config ... Populating config with: $ make ARCH=x86_64 olddefconfig O=.kunit ERROR:root:Not all Kconfig options selected in kunitconfig were in the generated .config. This is probably due to unsatisfied dependencies. Missing: CONFIG_DRM_KMS_HELPER=y, CONFIG_DRM_FORMAR_HELPER_TEST=y
I wasn't able to figure out why that was happening, so I decided to use "select", which seems to solve the problem.
Do you know why this could be happening?
Quoted 16 lines
Ideally, using a .kunitconfig file would make it so having to select
DRM_KMS_HELPERmanually isn't that annoying.Quoted 9 lines
Quoted 4 lines
AFAIK, kunit test cases are supposed to have a .kunitconfig too to enable the kunit tests easily.
Maxime
A .kuniconfig example is present in the cover letter. My understanding from the docs:
https://docs.kernel.org/dev-tools/kunit/run_wrapper.html#create-a-kunitconfig-file
The bit of the documentation you're looking for is
https://www.kernel.org/doc/html/latest/dev-tools/kunit/running_tips.html#defining-a-set-of-tests
You can create adrivers/gpu/drm/.kunitconfigfile and run with
Quoted 7 lines
$ ./tools/testing/kunit/kunit.py run --kunitconfig=drivers/gpu/drm --arch=x86_86The contents of that file would be just like
CONFIG_KUNIT=y
CONFIG_DRM=y
CONFIG_DRM_KMS_HELPER=y# if noselect
CONFIG_DRM_FORMAR_HELPER_TEST=y
Noted, thanks a lot, I'll include it in the final version of the patch.
By the way, I also included it in an unrelated patch, just in case you are wondering why I emailed you a random patch:
https://lore.kernel.org/linux-input/[email protected]/T/
Thanks a lot for your help,
José Expósito
Quoted 27 lines
Re "kunit test cases are supposed to have a .kunitconfig too" As I noted in the docs:
This is a relatively new feature (5.12+) so we don’t have any
conventions yet about on what files should be checked in versus just kept around locally. It’s up to you and your maintainer to decide if a config is useful enough to submit (and therefore have to maintain).So it's up to whatever people think works best/is worth it. I think in this case, it makes sense to add the file.
Quoted 2 lines
Is that, like the .config file, the .kunitconfig file is not meant to be included in git, but I'm sure someone else will clarify this point.
That bit of the docs needs to be rewritten.
You're recommended to check in adrivers/gpu/drm/.kunitconfigfile into git.Context:
kunit.pyused to use the "<root>/.kunitconfig" file. Anytime you wanted to run more tests, you'd append to that file. So we agreed that no one should check in that file specifically.Now
kunit.py
* uses "<build-dir>/.kunitconfig", by default: ".kunit/.kunitconfig"
* has the --kunitconfig flag so you can use different files so it's no longer as relevant.Hope that helps,
Daniel
Re: [RFC PATCH 1/1] drm/format-helper: Add KUnit tests for drm_fb_xrgb8888_to_rgb332()
Quoted 19 lines · José Expósito
Quoted 4 lines
From above, a)
Specifically here, it'd be encouraged to instead do
depends on DRM && KUNIT=y &&DRM_KMS_HELPERMy first attempt was to go with:
depends on KUNIT=y && DRM && DRM_KMS_HELPERHowever, when I try to run the tests I get this error:
$ ./tools/testing/kunit/kunit.py run --kunitconfig=drivers/gpu/drm --arch=x86_64 Regenerating .config ... Populating config with: $ make ARCH=x86_64 olddefconfig O=.kunit ERROR:root:Not all Kconfig options selected in kunitconfig were in the generated .config. This is probably due to unsatisfied dependencies. Missing: CONFIG_DRM_KMS_HELPER=y, CONFIG_DRM_FORMAR_HELPER_TEST=y
Quoted 4 lines
I wasn't able to figure out why that was happening, so I decided to use "select", which seems to solve the problem.
Do you know why this could be happening?
Ah, you should probably ignore my suggestion then.
Looking at the Kconfig file, it's defined as
config DRM_KMS_HELPER
tristate
depends on DRM
help
CRTC helpers for KMS drivers.
Notably, the config lacks a description string.
IIUC, this makes it a "hidden" kconfig option, i.e. you can't directly select it yourself in a .config, it must be selected by another kconfig option.
E.g. you can try selecting it manually and see it fail via:
$ ./tools/testing/kunit/kunit.py config --arch=x86_64 --kconfig_add=CONFIG_DRM=y --kconfig_add=CONFIG_DRM_KMS_HELPER=y ... Missing: CONFIG_DRM_KMS_HELPER=y
So having the test select it makes the most sense, unless there's a better kconfig option to automatically select it (I have no idea, someone with knowledge of the DRM code might though).
Daniel
Re: [RFC PATCH 1/1] drm/format-helper: Add KUnit tests for drm_fb_xrgb8888_to_rgb332()
In reply to José ExpósitoQuoted 65 lines · José Expósito
Hi Maxime,
Quoted 15 lines · Maxime Ripard
Hi,
Quoted 11 lines · José Expósito
Test the conversion from XRGB8888 to RGB332.
What is tested?
- Different values for the X in XRGB8888 to make sure it is ignored
- Different clip values: Single pixel and full and partial buffer
- Well know colors: White, black, red, green, blue, magenta, yellow and cyan
- Other colors: Randomly picked
- Destination pitchQuoted 5 lines
Quoted 2 lines
Suggested-by Javier Martinez Canillas <[email protected]>Signed-off-by José Expósito <[email protected]>It looks mostly good to me, but I think we should Cc [email protected] to have their feedback.
Thanks a lot for the quick feedback.
I just cc'ed [email protected]. For anyone joining the conversation, here is the link to the patch and the cover letter with some questions:
https://lore.kernel.org/dri-devel/[email protected]/T/
Quoted 32 lines
Quoted 18 lines
--- drivers/gpu/drm/Kconfig | 12 ++ drivers/gpu/drm/Makefile | 3 + drivers/gpu/drm/drm_format_helper_test.c | 166 +++++++++++++++++++++++ 3 files changed, 181 insertions(+) create mode 100644 drivers/gpu/drm/drm_format_helper_test.cdrivers/gpu/drm/Kconfig +2
-0@@ -76,6 +76,18 @@ config DRM_KMS_HELPER help CRTC helpers for KMS drivers. +config DRM_FORMAR_HELPER_TEST + bool "drm_format_helper tests" if !KUNIT_ALL_TESTSdrivers/gpu/drm/Kconfig config DRM_KMS_HELPER · line 90
Quoted 10 lines
drivers/gpu/drm/Kconfig +10
-0+ depends on DRM && KUNIT=y + select DRM_KMS_HELPER + default KUNIT_ALL_TESTS + help + KUnit tests for the drm_format_helper APIs. This option is not + useful for distributions or general kernels, but only for kernel + developers working on DRM and associated drivers. + + If in doubt, say "N". +AFAIK, kunit test cases are supposed to have a .kunitconfig too to enable the kunit tests easily.
Quoted 3 lines
Quoted 1 line
Maxime
A .kuniconfig example is present in the cover letter. (...)
FYI: it's also possible to run these tests under UML with the extra options:CONFIG_VIRTIO_UML=yCONFIG_UML_PCI_OVER_VIRTIO=y
I suspect it's probably better not to add those to your .kunitconfig, as they're UML-specific and will therefore break other architectures, but it does mean the tests can be run with, for example:
./tools/testing/kunit/kunit.py run --kunitconfig drivers/gpu/drm/.kunitconfig --kconfig_add CONFIG_VIRTIO_UML=y --kconfig_add CONFIG_UML_PCI_OVER_VIRTIO=y
Or, without the .kunitconfig:./tools/testing/kunit/kunit.py run --kconfig_add CONFIG_DRM=y --kconfig_add CONFIG_DRM_FORMAR_HELPER_TEST=y --kconfig_add CONFIG_VIRTIO_UML=y --kconfig_add CONFIG_UML_PCI_OVER_VIRTIO=y 'drm-*'
Cheers,
-- David
Re: [RFC PATCH 1/1] drm/format-helper: Add KUnit tests for drm_fb_xrgb8888_to_rgb332()
Quoted 1 line · David Gow
On Mon, May 30, 2022 at 9:29 AM José Expósito <[email protected]> wrote:
[snip]
Quoted 7 lines
Quoted 2 lines
A .kuniconfig example is present in the cover letter. (...)
FYI: it's also possible to run these tests under UML with the extra options:
CONFIG_VIRTIO_UML=yCONFIG_UML_PCI_OVER_VIRTIO=y
Oh, very interesting. I didn't notice before that his example had --arch=x86_64
Quoted 8 lines
I suspect it's probably better not to add those to your .kunitconfig, as they're UML-specific and will therefore break other architectures, but it does mean the tests can be run with, for example:
./tools/testing/kunit/kunit.pyrun --kunitconfigdrivers/gpu/drm/.kunitconfig--kconfig_addCONFIG_VIRTIO_UML=y--kconfig_addCONFIG_UML_PCI_OVER_VIRTIO=y
Quoted 6 lines
Or, without the .kunitconfig:
./tools/testing/kunit/kunit.pyrun --kconfig_addCONFIG_DRM=y--kconfig_addCONFIG_DRM_FORMAR_HELPER_TEST=y--kconfig_addCONFIG_VIRTIO_UML=y--kconfig_addCONFIG_UML_PCI_OVER_VIRTIO=y'drm-*'
I wonder if would make sense to have for example an arch/um/.kunitconfig with those symbols and maybe others and then the tests could also be run with something like:
./tools/testing/kunit/kunit.py run --kunitconfig=drivers/gpu/drm/.kunitconfig \
--kunitconfig=arch/um/.kunitconfig
Signature · 5 lines
Best regards, Javier Martinez Canillas Linux Engineering Red Hat
Re: [RFC PATCH 1/1] drm/format-helper: Add KUnit tests for drm_fb_xrgb8888_to_rgb332()
Quoted 7 lines · Javier Martinez Canillas
Quoted 6 lines
Or, without the .kunitconfig:
./tools/testing/kunit/kunit.pyrun --kconfig_addCONFIG_DRM=y--kconfig_addCONFIG_DRM_FORMAR_HELPER_TEST=y--kconfig_addCONFIG_VIRTIO_UML=y--kconfig_addCONFIG_UML_PCI_OVER_VIRTIO=y'drm-*'
Quoted 6 lines
I wonder if would make sense to have for example an
arch/um/.kunitconfigwith those symbols and maybe others and then the tests could also be run with something like:
./tools/testing/kunit/kunit.pyrun --kunitconfig=drivers/gpu/drm/.kunitconfig \
--kunitconfig=arch/um/.kunitconfig
Yeah, this came up before.
It'd be nice to have
* --kunitconfig be repeatable (it isn't right now)
* a "uml_pci.config" with the magic needed to set CONFIG_PCI=y on UML
Another example where this would be useful, coverage on UML CONFIG_DEBUG_KERNEL=yCONFIG_DEBUG_INFO=y CONFIG_DEBUG_INFO_DWARF_TOOLCHAIN_DEFAULT=y CONFIG_GCOV=y
I did prototype the changes to support this but never sent anything
out since I had some concerns, namely:
1. we'd be blindly appending them, but that won't always work. Would
users be ok with that?
2. people are already confused about .kunitconfig. It seems like the
most confusing part to new people, especially those new to kernel
development. Would adding this make them even more lost? Perhaps
making the docs clearer on this would a good pre-req.
3. What conventions should there be around these partial configs? I
think the idea should be more generic than just kunit.
4. --kconfig_add now makes this possible, even if in a noisier way
than another --kunitconfig
5. we didn't have a good way of reporting options set to different
values. https://lore.kernel.org/linux-kselftest/[email protected]/
would help by giving us an easier way to give clearer error messages.
That said, I'm willing to whip up another version based on the patch in #5. I think we need a docs rewrite for #2, which I can take a stab at. But I think we'll need some bikeshedding about naming (#3).
Daniel
kernel test robot
build botRe: [RFC PATCH 1/1] drm/format-helper: Add KUnit tests for drm_fb_xrgb8888_to_rgb332()
In reply to José Expósito[If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in https://git-scm.com/docs/git-format-patch]
Hi "José,
[FYI, it's a private test report for your RFC patch.]
[auto build test ERROR on drm/drm-next]
[also build test ERROR on v5.18 next-20220527]
[If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]
url: https://github.com/intel-lab-lkp/linux/commits/Jos-Exp-sito/KUnit-tests-for-drm_format_helper/20220530-182201 base: git://anongit.freedesktop.org/drm/drm drm-next config: hexagon-randconfig-r045-20220531 (https://download.01.org/0day-ci/archive/20220531/[email protected]/config) compiler: clang version 15.0.0 (https://github.com/llvm/llvm-project c825abd6b0198fb088d9752f556a70705bc99dfd)
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# https://github.com/intel-lab-lkp/linux/commit/ed116da35ca09da26713d2192e8493c5d9c500f3
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Jos-Exp-sito/KUnit-tests-for-drm_format_helper/20220530-182201 git checkout ed116da35ca09da26713d2192e8493c5d9c500f3
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross W=1 O=build_dir ARCH=hexagon SHELL=/bin/bash
If you fix the issue, kindly add following tag where applicable
All errors (new ones prefixed by >>):
>> ld.lld: error: undefined symbol: drm_bridge_hpd_enable >>> referenced by drm_bridge_connector.c >>> gpu/drm/drm_bridge_connector.o:(drm_bridge_connector_enable_hpd) in archive drivers/built-in.a >>> referenced by drm_bridge_connector.c >>> gpu/drm/drm_bridge_connector.o:(drm_bridge_connector_enable_hpd) in archive drivers/built-in.a >>> referenced by drm_bridge_connector.c >>> gpu/drm/drm_bridge_connector.o:(drm_bridge_connector_init) in archive drivers/built-in.a >>> referenced 1 more times -- >> ld.lld: error: undefined symbol: drm_bridge_hpd_disable >>> referenced by drm_bridge_connector.c >>> gpu/drm/drm_bridge_connector.o:(drm_bridge_connector_disable_hpd) in archive drivers/built-in.a >>> referenced by drm_bridge_connector.c >>> gpu/drm/drm_bridge_connector.o:(drm_bridge_connector_disable_hpd) in archive drivers/built-in.a >>> referenced by drm_bridge_connector.c >>> gpu/drm/drm_bridge_connector.o:(drm_bridge_connector_destroy) in archive drivers/built-in.a >>> referenced 1 more times -- >> ld.lld: error: undefined symbol: drm_connector_list_iter_end >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_helper_encoder_in_use) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_helper_encoder_in_use) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_crtc_helper_set_config) in archive drivers/built-in.a >>> referenced 35 more times -- >> ld.lld: error: undefined symbol: drm_modeset_lock_all >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_helper_disable_unused_functions) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_helper_disable_unused_functions) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_helper_resume_force_mode) in archive drivers/built-in.a >>> referenced 7 more times -- >> ld.lld: error: undefined symbol: drm_modeset_unlock_all >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_helper_disable_unused_functions) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_helper_disable_unused_functions) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_helper_resume_force_mode) in archive drivers/built-in.a >>> referenced 7 more times -- >> ld.lld: error: undefined symbol: drm_warn_on_modeset_not_all_locked >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(__drm_helper_disable_unused_functions) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(__drm_helper_disable_unused_functions) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_crtc_helper_set_mode) in archive drivers/built-in.a >>> referenced 3 more times -- >> ld.lld: error: undefined symbol: drm_mode_duplicate >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_crtc_helper_set_mode) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_crtc_helper_set_mode) in archive drivers/built-in.a -- >> ld.lld: error: undefined symbol: drm_mode_init >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_crtc_helper_set_mode) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_crtc_helper_set_mode) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_crtc_helper_set_mode) in archive drivers/built-in.a >>> referenced 1 more times -- >> ld.lld: error: undefined symbol: drm_mode_copy >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_crtc_helper_set_mode) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_crtc_helper_set_mode) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_crtc_helper_set_mode) in archive drivers/built-in.a >>> referenced 7 more times -- >> ld.lld: error: undefined symbol: __drm_dbg >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_crtc_helper_set_mode) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_crtc_helper_set_mode) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_crtc_helper_set_mode) in archive drivers/built-in.a >>> referenced 45 more times -- >> ld.lld: error: undefined symbol: drm_mode_destroy >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_crtc_helper_set_mode) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_crtc_helper_set_mode) in archive drivers/built-in.a >>> referenced by drm_crtc_helper.c >>> gpu/drm/drm_crtc_helper.o:(drm_crtc_helper_set_mode) in archive drivers/built-in.a >>> referenced 1 more times
..
Signature · 2 lines
0-DAY CI Kernel Test Service https://01.org/lkp
Re: [RFC PATCH 1/1] drm/format-helper: Add KUnit tests for drm_fb_xrgb8888_to_rgb332()
In reply to José ExpósitoHello José,
Quoted 11 lines · José Expósito
Test the conversion from XRGB8888 to RGB332.
What is tested?
- Different values for the X in XRGB8888 to make sure it is ignored
- Different clip values: Single pixel and full and partial buffer
- Well know colors: White, black, red, green, blue, magenta, yellow and cyan
- Other colors: Randomly picked
- Destination pitch
Quoted 3 lines
Suggested-by Javier Martinez Canillas <[email protected]>Signed-off-by José Expósito <[email protected]>---
Thanks a lot for working on this! It's very cool to see the first KUnit tests added to DRM :)
Quoted 11 lines
drivers/gpu/drm/Kconfig | 12 ++ drivers/gpu/drm/Makefile | 3 + drivers/gpu/drm/drm_format_helper_test.c | 166 +++++++++++++++++++++++ 3 files changed, 181 insertions(+) create mode 100644 drivers/gpu/drm/drm_format_helper_test.cdrivers/gpu/drm/Kconfig +0
-0
drivers/gpu/drm/Kconfig config DRM_KMS_HELPER · line 79
Quoted 4 lines
drivers/gpu/drm/Kconfig +1
-0@@ -76,6 +76,18 @@ config DRM_KMS_HELPER help CRTC helpers for KMS drivers. +config DRM_FORMAR_HELPER_TEST
I wonder if we want this level of detail for the test Kconfig symbols. Maybe we could just have a DRM_KUNIT_TEST symbol that will enable all the KUnit test suites for DRM ?
drivers/gpu/drm/Kconfig config DRM_KMS_HELPER · line 82
Quoted 3 lines
drivers/gpu/drm/Kconfig +3
-0+ bool "drm_format_helper tests" if !KUNIT_ALL_TESTS + depends on DRM && KUNIT=y + select DRM_KMS_HELPER
Daniel didn't like this select DRM_KMS_HELPER and I think that we can avoid it if instead drm_format_helper_test.c is included in drm_format_helper.c, i.e:
drivers/gpu/drm/drm_format_helper.c +4 -0
@@ -692,3 +692,7 @@ void drm_fb_xrgb8888_to_mono(void *dst, unsigned int dst_pitch, const void *vaddkfree (src32); }EXPORT_SYMBOL (drm_fb_xrgb8888_to_mono); + +#ifdef DRM_KUNIT_TEST +#include "drm_format_helper_test.c" +#endif
This also has the advantage that will allow to have KUnit tests for the static functions that are only available in the drm_format_helper.c compilation unit.
drivers/gpu/drm/Kconfig config DRM_KMS_HELPER · line 85
Quoted 3 lines
drivers/gpu/drm/Kconfig +2
-0obj-$(CONFIG_DRM_DEBUG_SELFTEST) += selftests/ +obj-$(CONFIG_DRM_FORMAR_HELPER_TEST) += drm_kms_helper.o \ + drm_format_helper_test.o
And doing that will also allow you to get rid of this, since just selecting CONFIG_DRM_KUNIT_TEST=y would be enough for the tests built and run by KUnit.
drivers/gpu/drm/Kconfig config DRM_KMS_HELPER · line 87
Quoted 2 lines
drivers/gpu/drm/Kconfig +1
-0+CFLAGS_drm_format_helper_test.o += $(DISABLE_STRUCTLEAK_PLUGIN)
A comment on why this is needed would useful.
Signature · 5 lines
Best regards, Javier Martinez Canillas Linux Engineering Red Hat
Re: [RFC PATCH 1/1] drm/format-helper: Add KUnit tests for drm_fb_xrgb8888_to_rgb332()
Quoted 4 lines · Javier Martinez Canillas
Quoted 2 lines
+CFLAGS_drm_format_helper_test.o += $(DISABLE_STRUCTLEAK_PLUGIN)
A comment on why this is needed would useful.
Ah, I think that should not be necessary anymore.
We added this to some tests to mitigate against compilers that didn't optimize away stack-local structs used internally in KUNIT_EXPECT*. Functions with ~30 or so EXPECTs could get flagged for excessively large stack frames.
But in 5.18, I had some patches to reduce the naive stack usage from [48..88] => [8..32] bytes per EXPECT.
I also have some RFC patches out to get it down to [0, 24] bytes.
So going forward, this should only be necessary if you have something like 100s of EXPECTs in a single function (in which case you should also consider splitting that function up).
Daniel
Re: [RFC PATCH 1/1] drm/format-helper: Add KUnit tests for drm_fb_xrgb8888_to_rgb332()
In reply to Javier Martinez CanillasQuoted 65 lines · Javier Martinez Canillas
Hello José,
Quoted 11 lines · José Expósito
Test the conversion from XRGB8888 to RGB332.
What is tested?
- Different values for the X in XRGB8888 to make sure it is ignored
- Different clip values: Single pixel and full and partial buffer
- Well know colors: White, black, red, green, blue, magenta, yellow and cyan
- Other colors: Randomly picked
- Destination pitchQuoted 3 lines
Suggested-by Javier Martinez Canillas <[email protected]>Signed-off-by José Expósito <[email protected]>---
Thanks a lot for working on this! It's very cool to see the first KUnit tests added to DRM :)
Quoted 11 lines
drivers/gpu/drm/Kconfig | 12 ++ drivers/gpu/drm/Makefile | 3 + drivers/gpu/drm/drm_format_helper_test.c | 166 +++++++++++++++++++++++ 3 files changed, 181 insertions(+) create mode 100644 drivers/gpu/drm/drm_format_helper_test.cdrivers/gpu/drm/Kconfig +0
-0drivers/gpu/drm/Kconfig config DRM_KMS_HELPER · line 79
Quoted 4 lines
drivers/gpu/drm/Kconfig +1
-0@@ -76,6 +76,18 @@ config DRM_KMS_HELPER help CRTC helpers for KMS drivers. +config DRM_FORMAR_HELPER_TESTI wonder if we want this level of detail for the test
Kconfigsymbols. Maybe we could just have aDRM_KUNIT_TESTsymbol that will enable all the KUnit test suites for DRM ?drivers/gpu/drm/Kconfig config DRM_KMS_HELPER · line 82
Quoted 3 lines
drivers/gpu/drm/Kconfig +3
-0+ bool "drm_format_helper tests" if !KUNIT_ALL_TESTS + depends on DRM && KUNIT=y + select DRM_KMS_HELPERDaniel didn't like this
select DRM_KMS_HELPERand I think that we can avoid it if insteaddrm_format_helper_test.cis included indrm_format_helper.c, i.e:drivers/gpu/drm/drm_format_helper.c +4
-0@@ -692,3 +692,7 @@ void drm_fb_xrgb8888_to_mono(void *dst, unsigned int dst_pitch, const void *vaddkfree (src32); }EXPORT_SYMBOL (drm_fb_xrgb8888_to_mono); + +#ifdef DRM_KUNIT_TEST +#include "drm_format_helper_test.c" +#endif This also has the advantage that will allow to have KUnit tests for the static functions that are only available in the
drm_format_helper.ccompilation unit.
Quoted 7 lines
drivers/gpu/drm/Kconfig config DRM_KMS_HELPER · line 85
Quoted 3 lines
drivers/gpu/drm/Kconfig +2
-0obj-$(CONFIG_DRM_DEBUG_SELFTEST) += selftests/ +obj-$(CONFIG_DRM_FORMAR_HELPER_TEST) += drm_kms_helper.o \ + drm_format_helper_test.oAnd doing that will also allow you to get rid of this, since just selecting
CONFIG_DRM_KUNIT_TEST=ywould be enough for the tests built and run by KUnit.
This is definitely something other KUnit tests (apparmor, elf, etc) are doing, and it's generally fine. You do lose the ability to build the tests as a separate module, though. (This is not usually a big problem, but there are some cases where it's useful.)
That being said, I don't think 'select' is enough of a problem that you should feel the need to refactor in this way just to avoid it. Given most of the other DRM drivers (as well as DRM_DEBUG_SELFTEST) are select-ing DRM_KMS_HELPER, it seems like a sensible enough thing to continue doing for the KUnit test. As Daniel pointed out, as a hidden option it was clearly always meant to be select-ed anyway.
Cheers,
-- David
Re: [RFC PATCH 1/1] drm/format-helper: Add KUnit tests for drm_fb_xrgb8888_to_rgb332()
Hello David,
Quoted 1 line · David Gow
On Thu, Jun 2, 2022 at 9:27 AM Javier Martinez Canillas
[snip]
Quoted 5 lines
Quoted 4 lines
And doing that will also allow you to get rid of this, since just selecting
CONFIG_DRM_KUNIT_TEST=ywould be enough for the tests built and run by KUnit.
Quoted 7 lines
This is definitely something other KUnit tests (apparmor, elf, etc) are doing, and it's generally fine. You do lose the ability to build the tests as a separate module, though. (This is not usually a big problem, but there are some cases where it's useful.)
That being said, I don't think 'select' is enough of a problem that you should feel the need to refactor in this way just to avoid it.
Oh, yes I didn't want to imply that this was the main reason but just pointed out that wouldn't even be needed if done that way. And it is something that we want to do anyway IMO, since as mentioned it would allow to test the static functions, which are the majority the format helpers in that file.
Quoted 5 lines
Given most of the other DRM drivers (as well as
DRM_DEBUG_SELFTEST) are select-ingDRM_KMS_HELPER, it seems like a sensible enough thing to continue doing for the KUnit test. As Daniel pointed out, as a hidden option it was clearly always meant to be select-ed anyway.
Yes, it can be done from the DRM_KUNIT_TEST symbol or just have it set (and any other needed DRM helper libraries tested by other suites) in the .kunitconfig file.
I don't think is that important, since at the end that dependency will have to be maintained in some place.
Quoted 3 lines
Cheers,
-- David
Signature · 5 lines
Best regards, Javier Martinez Canillas Linux Engineering Red Hat
Re: [RFC PATCH 1/1] drm/format-helper: Add KUnit tests for drm_fb_xrgb8888_to_rgb332()
Hello everyone,
Quoted 17 lines · Javier Martinez Canillas
Hello David,
Quoted 1 line · David Gow
On Thu, Jun 2, 2022 at 9:27 AM Javier Martinez Canillas
[snip]
Quoted 10 lines
Quoted 4 lines
And doing that will also allow you to get rid of this, since just selecting
CONFIG_DRM_KUNIT_TEST=ywould be enough for the tests built and run by KUnit.This is definitely something other KUnit tests (apparmor, elf, etc) are doing, and it's generally fine. You do lose the ability to build the tests as a separate module, though. (This is not usually a big problem, but there are some cases where it's useful.)
Quoted 8 lines
Quoted 2 lines
That being said, I don't think 'select' is enough of a problem that you should feel the need to refactor in this way just to avoid it.
Oh, yes I didn't want to imply that this was the main reason but just pointed out that wouldn't even be needed if done that way. And it is something that we want to do anyway IMO, since as mentioned it would allow to test the static functions, which are the majority the format helpers in that file.
Conversion functions alway call drm_fb_xfrm()/drm_fb_xfrm_toio() and their *_line function. For example, drm_fb_xrgb8888_to_rgb332() calls drm_fb_xfrm() and drm_fb_xrgb8888_to_rgb332_line().
The current tests already check that the *_line() function works as expected. I'd like to test the high-level functions first and, if required, go into more detail in the future. The refactor is pretty easy, so I'd prefer to keep it as it is for the moment.
About the other changes suggested, I applied all of them over the weekend. I'll send v1 of the patch to the mailing list including them so we have an up to date code to comment on.
Thanks a lot for all of your comments and help,
José Expósito