Re: [PATCH v2] kselftest: Fix vdso_test_abi return status

[Cristian Marussi]

On Fri, Jan 28, 2022 at 12:27:44PM +0000, Vincenzo Frascino wrote:
> vdso_test_abi contains a batch of tests that verify the validity of the
> vDSO ABI.
> 
> When a vDSO symbol is not found the relevant test is skipped reporting
> KSFT_SKIP. All the tests return values are then added in a single
> variable which is checked to verify failures. This approach can have
> side effects which result in reporting the wrong kselftest exit status.
> 
> Fix vdso_test_abi verifying the return code of each test separately.
> 
> Cc: Shuah Khan <shuah@xxxxxxxxxx>
> Cc: Andy Lutomirski <luto@xxxxxxxxxx>
> Cc: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
> Reported-by: Cristian Marussi <cristian.marussi@xxxxxxx>
> Signed-off-by: Vincenzo Frascino <vincenzo.frascino@xxxxxxx>
> ---

Hi Vincenzo,

>  tools/testing/selftests/vDSO/vdso_test_abi.c | 143 ++++++++-----------
>  1 file changed, 62 insertions(+), 81 deletions(-)
> 
> diff --git a/tools/testing/selftests/vDSO/vdso_test_abi.c b/tools/testing/selftests/vDSO/vdso_test_abi.c
> index 3d603f1394af..3e4dd47e404e 100644
> --- a/tools/testing/selftests/vDSO/vdso_test_abi.c
> +++ b/tools/testing/selftests/vDSO/vdso_test_abi.c
> @@ -33,110 +33,106 @@ typedef long (*vdso_clock_gettime_t)(clockid_t clk_id, struct timespec *ts);
>  typedef long (*vdso_clock_getres_t)(clockid_t clk_id, struct timespec *ts);
>  typedef time_t (*vdso_time_t)(time_t *t);
>  
> -static int vdso_test_gettimeofday(void)
> +#define VDSO_TEST_PASS_MSG()	"\n%s(): PASS\n", __func__
> +#define VDSO_TEST_FAIL_MSG(x)	"\n%s(): %s FAIL\n", __func__, x
> +#define VDSO_TEST_SKIP_MSG(x)	"\n%s(): SKIP: Could not find %s\n", __func__, x
> +
> +static void vdso_test_gettimeofday(void)
>  {
>  	/* Find gettimeofday. */
>  	vdso_gettimeofday_t vdso_gettimeofday =
>  		(vdso_gettimeofday_t)vdso_sym(version, name[0]);
>  
> -	if (!vdso_gettimeofday) {
> -		printf("Could not find %s\n", name[0]);
> -		return KSFT_SKIP;
> -	}
> +	if (!vdso_gettimeofday)
> +		ksft_test_result_skip(VDSO_TEST_SKIP_MSG(name[0]));
>  
>  	struct timeval tv;
>  	long ret = vdso_gettimeofday(&tv, 0);
>  
>  	if (ret == 0) {
> -		printf("The time is %lld.%06lld\n",
> -		       (long long)tv.tv_sec, (long long)tv.tv_usec);
> +		ksft_print_msg("The time is %lld.%06lld\n",
> +			       (long long)tv.tv_sec, (long long)tv.tv_usec);
> +		ksft_test_result_pass(VDSO_TEST_PASS_MSG());
>  	} else {
> -		printf("%s failed\n", name[0]);
> -		return KSFT_FAIL;
> +		ksft_test_result_fail(VDSO_TEST_FAIL_MSG(name[0]));
>  	}
> -
> -	return KSFT_PASS;
>  }
>  
> -static int vdso_test_clock_gettime(clockid_t clk_id)
> +static void vdso_test_clock_gettime(clockid_t clk_id)
>  {
>  	/* Find clock_gettime. */
>  	vdso_clock_gettime_t vdso_clock_gettime =
>  		(vdso_clock_gettime_t)vdso_sym(version, name[1]);
>  
> -	if (!vdso_clock_gettime) {
> -		printf("Could not find %s\n", name[1]);
> -		return KSFT_SKIP;
> -	}
> +	if (!vdso_clock_gettime)
> +		ksft_test_result_skip(VDSO_TEST_SKIP_MSG(name[1]));
>  
>  	struct timespec ts;
>  	long ret = vdso_clock_gettime(clk_id, &ts);
>  
>  	if (ret == 0) {
> -		printf("The time is %lld.%06lld\n",
> -		       (long long)ts.tv_sec, (long long)ts.tv_nsec);
> +		ksft_print_msg("The time is %lld.%06lld\n",
> +			       (long long)ts.tv_sec, (long long)ts.tv_nsec);
> +		ksft_test_result_pass(VDSO_TEST_PASS_MSG());;
>  	} else {
> -		printf("%s failed\n", name[1]);
> -		return KSFT_FAIL;
> +		ksft_test_result_fail(VDSO_TEST_FAIL_MSG(name[1]));
>  	}
> -
> -	return KSFT_PASS;
>  }
>  
> -static int vdso_test_time(void)
> +static void vdso_test_time(void)
>  {
>  	/* Find time. */
>  	vdso_time_t vdso_time =
>  		(vdso_time_t)vdso_sym(version, name[2]);
>  
> -	if (!vdso_time) {
> -		printf("Could not find %s\n", name[2]);
> -		return KSFT_SKIP;
> -	}
> +	if (!vdso_time)
> +		ksft_test_result_skip(VDSO_TEST_SKIP_MSG(name[2]));
>  
>  	long ret = vdso_time(NULL);
>  
>  	if (ret > 0) {
> -		printf("The time in hours since January 1, 1970 is %lld\n",
> +		ksft_print_msg("The time in hours since January 1, 1970 is %lld\n",
>  				(long long)(ret / 3600));
> +		ksft_test_result_pass(VDSO_TEST_PASS_MSG());
>  	} else {
> -		printf("%s failed\n", name[2]);
> -		return KSFT_FAIL;
> +		ksft_test_result_fail(VDSO_TEST_FAIL_MSG(name[2]));
>  	}
> -
> -	return KSFT_PASS;
>  }
>  
> -static int vdso_test_clock_getres(clockid_t clk_id)
> +static void vdso_test_clock_getres(clockid_t clk_id)
>  {
> +	int clock_getres_fail = 0;
> +
>  	/* Find clock_getres. */
>  	vdso_clock_getres_t vdso_clock_getres =
>  		(vdso_clock_getres_t)vdso_sym(version, name[3]);
>  
> -	if (!vdso_clock_getres) {
> -		printf("Could not find %s\n", name[3]);
> -		return KSFT_SKIP;
> -	}
> +	if (!vdso_clock_getres)
> +		ksft_test_result_skip(VDSO_TEST_SKIP_MSG(name[3]));
>  
>  	struct timespec ts, sys_ts;
>  	long ret = vdso_clock_getres(clk_id, &ts);
>  
>  	if (ret == 0) {
> -		printf("The resolution is %lld %lld\n",
> -		       (long long)ts.tv_sec, (long long)ts.tv_nsec);
> +		ksft_print_msg("The vdso resolution is %lld %lld\n",
> +			       (long long)ts.tv_sec, (long long)ts.tv_nsec);
>  	} else {
> -		printf("%s failed\n", name[3]);
> -		return KSFT_FAIL;
> +		clock_getres_fail++;
>  	}
>  
>  	ret = syscall(SYS_clock_getres, clk_id, &sys_ts);
>  
> -	if ((sys_ts.tv_sec != ts.tv_sec) || (sys_ts.tv_nsec != ts.tv_nsec)) {
> -		printf("%s failed\n", name[3]);
> -		return KSFT_FAIL;
> -	}
> +	ksft_print_msg("The syscall resolution is %lld %lld\n",
> +			(long long)sys_ts.tv_sec, (long long)sys_ts.tv_nsec);
> +
> +	if ((sys_ts.tv_sec != ts.tv_sec) || (sys_ts.tv_nsec != ts.tv_nsec))
> +		clock_getres_fail++;
>  
> -	return KSFT_PASS;
> +	if (clock_getres_fail > 0) {
> +		ksft_test_result_fail(VDSO_TEST_FAIL_MSG(name[3]));
> +	} else {
> +		ksft_test_result_pass(VDSO_TEST_PASS_MSG());
> +	}
>  }
>  
>  const char *vdso_clock_name[12] = {
> @@ -158,36 +154,23 @@ const char *vdso_clock_name[12] = {
>   * This function calls vdso_test_clock_gettime and vdso_test_clock_getres
>   * with different values for clock_id.
>   */
> -static inline int vdso_test_clock(clockid_t clock_id)
> +static inline void vdso_test_clock(clockid_t clock_id)
>  {
> -	int ret0, ret1;
> -
> -	ret0 = vdso_test_clock_gettime(clock_id);
> -	/* A skipped test is considered passed */
> -	if (ret0 == KSFT_SKIP)
> -		ret0 = KSFT_PASS;
> +	ksft_print_msg("\nclock_id: %s\n", vdso_clock_name[clock_id]);
>  
> -	ret1 = vdso_test_clock_getres(clock_id);
> -	/* A skipped test is considered passed */
> -	if (ret1 == KSFT_SKIP)
> -		ret1 = KSFT_PASS;
> +	vdso_test_clock_gettime(clock_id);
>  
> -	ret0 += ret1;
> -
> -	printf("clock_id: %s", vdso_clock_name[clock_id]);
> -
> -	if (ret0 > 0)
> -		printf(" [FAIL]\n");
> -	else
> -		printf(" [PASS]\n");
> -
> -	return ret0;
> +	vdso_test_clock_getres(clock_id);
>  }
>  
> +#define VDSO_TEST_PLAN	16
> +
>  int main(int argc, char **argv)
>  {
>  	unsigned long sysinfo_ehdr = getauxval(AT_SYSINFO_EHDR);
> -	int ret;
> +
> +	ksft_print_header();
> +	ksft_set_plan(VDSO_TEST_PLAN);
>  
>  	if (!sysinfo_ehdr) {
>  		printf("AT_SYSINFO_EHDR is not present!\n");
> @@ -201,44 +184,42 @@ int main(int argc, char **argv)
>  
>  	vdso_init_from_sysinfo_ehdr(getauxval(AT_SYSINFO_EHDR));
>  
> -	ret = vdso_test_gettimeofday();
> +	vdso_test_gettimeofday();
>  
>  #if _POSIX_TIMERS > 0
>  
>  #ifdef CLOCK_REALTIME
> -	ret += vdso_test_clock(CLOCK_REALTIME);
> +	vdso_test_clock(CLOCK_REALTIME);
>  #endif
>  
>  #ifdef CLOCK_BOOTTIME
> -	ret += vdso_test_clock(CLOCK_BOOTTIME);
> +	vdso_test_clock(CLOCK_BOOTTIME);
>  #endif
>  
>  #ifdef CLOCK_TAI
> -	ret += vdso_test_clock(CLOCK_TAI);
> +	vdso_test_clock(CLOCK_TAI);
>  #endif
>  
>  #ifdef CLOCK_REALTIME_COARSE
> -	ret += vdso_test_clock(CLOCK_REALTIME_COARSE);
> +	vdso_test_clock(CLOCK_REALTIME_COARSE);
>  #endif
>  
>  #ifdef CLOCK_MONOTONIC
> -	ret += vdso_test_clock(CLOCK_MONOTONIC);
> +	vdso_test_clock(CLOCK_MONOTONIC);
>  #endif
>  
>  #ifdef CLOCK_MONOTONIC_RAW
> -	ret += vdso_test_clock(CLOCK_MONOTONIC_RAW);
> +	vdso_test_clock(CLOCK_MONOTONIC_RAW);
>  #endif
>  
>  #ifdef CLOCK_MONOTONIC_COARSE
> -	ret += vdso_test_clock(CLOCK_MONOTONIC_COARSE);
> +	vdso_test_clock(CLOCK_MONOTONIC_COARSE);
>  #endif
>  
>  #endif
>  
> -	ret += vdso_test_time();
> -
> -	if (ret > 0)
> -		return KSFT_FAIL;
> +	vdso_test_time();
>  
> -	return KSFT_PASS;
> +	ksft_print_cnts();
> +	return ksft_get_fail_cnt() == 0 ? KSFT_PASS : KSFT_FAIL;

I gave it a go on JUNO, got a segfault as you can see below.

I think it is simply that now you are accounting properly for the
FAIL/SKIP/PASS like in:

> -	if (!vdso_time) {
> -		printf("Could not find %s\n", name[2]);
> -		return KSFT_SKIP;
> -	}
> +	if (!vdso_time)
> +		ksft_test_result_skip(VDSO_TEST_SKIP_MSG(name[2]));
>  
>

BUT you never bail out after the ksft_test_result_skip() so the
test is run anyway.

Thanks,
Cristian

-----

TAP version 13
1..16
[vDSO kselftest] VDSO_VERSION: LINUX_2.6.39
# The time is 1643374139.646062
ok 1 
vdso_test_gettimeofday(): PASS
# 
clock_id: CLOCK_REALTIME
# The time is 1643374139.646288567
ok 2 
vdso_test_clock_gettime(): PASS
# The vdso resolution is 0 1
# The syscall resolution is 0 1
ok 3 
vdso_test_clock_getres(): PASS
# 
clock_id: CLOCK_BOOTTIME
# The time is 5602.390284127
ok 4 
vdso_test_clock_gettime(): PASS
# The vdso resolution is 0 1
# The syscall resolution is 0 1
ok 5 
vdso_test_clock_getres(): PASS
# 
clock_id: CLOCK_TAI
# The time is 1643374139.647078775
ok 6 
vdso_test_clock_gettime(): PASS
# The vdso resolution is 0 1
# The syscall resolution is 0 1
ok 7 
vdso_test_clock_getres(): PASS
# 
clock_id: CLOCK_REALTIME_COARSE
# The time is 1643374139.641467075
ok 8 
vdso_test_clock_gettime(): PASS
# The vdso resolution is 0 4000000
# The syscall resolution is 0 4000000
ok 9 
vdso_test_clock_getres(): PASS
# 
clock_id: CLOCK_MONOTONIC
# The time is 5602.391454688
ok 10 
vdso_test_clock_gettime(): PASS
# The vdso resolution is 0 1
# The syscall resolution is 0 1
ok 11 
vdso_test_clock_getres(): PASS
# 
clock_id: CLOCK_MONOTONIC_RAW
# The time is 5602.278421300
ok 12 
vdso_test_clock_gettime(): PASS
# The vdso resolution is 0 1
# The syscall resolution is 0 1
ok 13 
vdso_test_clock_getres(): PASS
# 
clock_id: CLOCK_MONOTONIC_COARSE
# The time is 5602.389063303
ok 14 
vdso_test_clock_gettime(): PASS
# The vdso resolution is 0 4000000
# The syscall resolution is 0 4000000
ok 15 
vdso_test_clock_getres(): PASS
ok 16 # SKIP 
vdso_test_time(): SKIP: Could not find __kernel_time
Segmentation fault


>