[igt-dev] [Intel-gfx] [PATCH i-g-t v3 05/17] lib/kunit: Fix illegal igt_fail() calls inside subtest body

[Mauro Carvalho Chehab]

On Mon, 18 Sep 2023 15:42:55 +0200
Janusz Krzysztofik <janusz.krzysztofik at linux.intel.com> wrote:

> In a body of a subtest with dynamic sub-subtests, it is illegal to call
> igt_fail() and its variants from outside of a dynamic sub-subtest body.
> On the other hand, it is perfectly legal to call either igt_skip() and
> friends or __igt_abort() or its variant from there.
> 
> In the current implementation of igt_kunit(), there are several places
> where igt_fail() is called despite being illegal.  Moreover, it is called
> with IGT_EXIT_ABORT as an argument with no good reason for using such
> aggressive method that forces CI to trigger system reboot (in most cases
> igt_runner can decide if abort is required).
> 
> Follow igt_kselftests() pattern more closely, where similar setup and
> cleanup operations are performed but their potential errors are processed
> in a more friendly way.  Move common cleanup and their corresponding setup
> steps out of the subtest body.  Place the latter as requirements in a
> preceding igt_fixture section.  Replace remaining illegal igt_fail() calls
> with more friendly skips.  Let igt_runner decide if abort is needed.
> 
> v2: Also call igt_skip() on igt_ktest_init() failure (Mauro), but then,
>     initialize local tst structure when declaring it to avoid freeing a
>     random pointer from igt_ktest_fini() when only listing subtests,
>   - call igt_ktest_end() from igt_fixture so it is not unnecessarily
>     called when only listing subtests.
> 
> Signed-off-by: Janusz Krzysztofik <janusz.krzysztofik at linux.intel.com>
> Cc: Mauro Carvalho Chehab <mauro.chehab at linux.intel.com>

LGTM.

Acked-by: Mauro Carvalho Chehab <mauro.chehab at linux.intel.com>

> ---
>  lib/igt_kmod.c | 76 +++++++++++++++-----------------------------------
>  1 file changed, 23 insertions(+), 53 deletions(-)
> 
> diff --git a/lib/igt_kmod.c b/lib/igt_kmod.c
> index 1d1cd51170..063e4c12db 100644
> --- a/lib/igt_kmod.c
> +++ b/lib/igt_kmod.c
> @@ -754,59 +754,27 @@ void igt_kselftest_get_tests(struct kmod_module *kmod,
>   *
>   * Returns: IGT default codes
>   */
> -static void __igt_kunit(const char *module_name, const char *opts)
> +static void __igt_kunit(struct igt_ktest *tst, const char *opts)
>  {
> -	struct igt_ktest tst;
>  	struct kmod_module *kunit_kmod;
>  	bool is_builtin;
>  	int ret;
>  	struct ktap_test_results *results;
>  	struct ktap_test_results_element *temp;
> -	int skip = 0;
> -	bool fail = false;
> -
> -	/* get normalized module name */
> -	if (igt_ktest_init(&tst, module_name) != 0) {
> -		igt_warn("Unable to initialize ktest for %s\n", module_name);
> -		igt_fail(IGT_EXIT_ABORT);
> -	}
>  
> -	if (igt_ktest_begin(&tst) != 0) {
> -		igt_warn("Unable to begin ktest for %s\n", module_name);
> -		igt_ktest_fini(&tst);
> -		igt_fail(IGT_EXIT_ABORT);
> -	}
> +	igt_skip_on_f(tst->kmsg < 0, "Could not open /dev/kmsg\n");
>  
> -	if (tst.kmsg < 0) {
> -		igt_warn("Could not open /dev/kmsg\n");
> -		fail = true;
> -		goto unload;
> -	}
> -
> -	if (lseek(tst.kmsg, 0, SEEK_END)) {
> -		igt_warn("Could not seek the end of /dev/kmsg\n");
> -		fail = true;
> -		goto unload;
> -	}
> -
> -	ret = kmod_module_new_from_name(kmod_ctx(), "kunit", &kunit_kmod);
> -	if (ret) {
> -		igt_warn("Unable to load KUnit\n");
> -		skip = ret;
> -		goto unload;
> -	}
> +	igt_skip_on(lseek(tst->kmsg, 0, SEEK_END) < 0);
>  
> +	igt_skip_on(kmod_module_new_from_name(kmod_ctx(), "kunit", &kunit_kmod));
>  	is_builtin = kmod_module_get_initstate(kunit_kmod) == KMOD_MODULE_BUILTIN;
>  	kmod_module_unref(kunit_kmod);
>  
> -	results = ktap_parser_start(tst.kmsg, is_builtin);
> +	results = ktap_parser_start(tst->kmsg, is_builtin);
>  
> -	ret = igt_kmod_load(module_name, opts);
> -	if (ret) {
> -		skip = ret;
> -		igt_warn("Unable to load %s module\n", module_name);
> -		ret = ktap_parser_stop();
> -		goto unload;
> +	if (igt_debug_on(igt_kmod_load(tst->module_name, opts) < 0)) {
> +		igt_ignore_warn(ktap_parser_stop());
> +		igt_skip("Unable to load %s module\n", tst->module_name);
>  	}
>  
>  	while (READ_ONCE(results->still_running) || READ_ONCE(results->head) != NULL)
> @@ -825,24 +793,21 @@ static void __igt_kunit(const char *module_name, const char *opts)
>  		}
>  	}
>  
> -unload:
> -	igt_ktest_end(&tst);
> -
> -	igt_ktest_fini(&tst);
> -
> -	igt_skip_on_f(skip, "Skipping test, as probing KUnit module failed\n");
> -
> -	if (fail)
> -		igt_fail(IGT_EXIT_ABORT);
> -
>  	ret = ktap_parser_stop();
>  
> -	if (ret != 0)
> -		igt_fail(IGT_EXIT_ABORT);
> +	igt_skip_on_f(ret, "KTAP parser failed\n");
>  }
>  
>  void igt_kunit(const char *module_name, const char *name, const char *opts)
>  {
> +	struct igt_ktest tst = { .kmsg = -1, };
> +
> +
> +	igt_fixture {
> +		igt_skip_on(igt_ktest_init(&tst, module_name));
> +		igt_skip_on(igt_ktest_begin(&tst));
> +	}
> +
>  	/*
>  	 * We need to use igt_subtest here, as otherwise it may crash with:
>  	 *  skipping is allowed only in fixtures, subtests or igt_simple_main
> @@ -854,7 +819,12 @@ void igt_kunit(const char *module_name, const char *name, const char *opts)
>  		name = module_name;
>  
>  	igt_subtest_with_dynamic(name)
> -		__igt_kunit(module_name, opts);
> +		__igt_kunit(&tst, opts);
> +
> +	igt_fixture
> +		igt_ktest_end(&tst);
> +
> +	igt_ktest_fini(&tst);
>  }
>  
>  static int open_parameters(const char *module_name)