Re: [LTP] [PATCH v4 1/2] syscalls/statfs02, fstatfs02: Convert to new API

[Cyril Hrubis <chrubis@suse.cz>]

Hi!
> Refactor statfs02 and fstatfs02 to the new LTP API.

Give that we are getting close to release I did fix the remaning
problems and pushed the patches, thanks. See below for details.

> Signed-off-by: Tudor Cretu <tudor.cretu@arm.com>
> ---
>  testcases/kernel/syscalls/fstatfs/fstatfs02.c | 102 +++++-------------
>  testcases/kernel/syscalls/statfs/statfs02.c   |  97 ++++-------------
>  2 files changed, 47 insertions(+), 152 deletions(-)
> 
> diff --git a/testcases/kernel/syscalls/fstatfs/fstatfs02.c b/testcases/kernel/syscalls/fstatfs/fstatfs02.c
> index db2230f82..4267bd02b 100644
> --- a/testcases/kernel/syscalls/fstatfs/fstatfs02.c
> +++ b/testcases/kernel/syscalls/fstatfs/fstatfs02.c
> @@ -1,37 +1,19 @@
> +// SPDX-License-Identifier: GPL-2.0-or-later
>  /*
>   * Copyright (c) International Business Machines  Corp., 2001
> - *
> - * This program is free software;  you can redistribute it and/or modify
> - * it under the terms of the GNU General Public License as published by
> - * the Free Software Foundation; either version 2 of the License, or
> - * (at your option) any later version.
> - *
> - * This program is distributed in the hope that it will be useful,
> - * but WITHOUT ANY WARRANTY;  without even the implied warranty of
> - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
> - * the GNU General Public License for more details.
> - *
> - * You should have received a copy of the GNU General Public License
> - * along with this program;  if not, write to the Free Software
> - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
>   */
>  
>  /*
> - * DESCRIPTION
> + * [Description]
>   *	Testcase to check fstatfs() sets errno correctly.
>   */

This is not proper documentation comment. Documentation comment has to
start with /*\ and the content is asciidoc formatted.

> -#include <sys/vfs.h>
> +#include <errno.h>
>  #include <sys/types.h>
>  #include <sys/statfs.h>
> -#include <errno.h>
> -#include "test.h"
> -#include "safe_macros.h"
> -
> -static void setup(void);
> -static void cleanup(void);
> -
> -char *TCID = "fstatfs02";
> +#include <sys/wait.h>
> +#include "tst_test.h"
> +#include "tst_safe_macros.h"
>  
>  static struct statfs buf;
>  
> @@ -39,76 +21,40 @@ static struct test_case_t {
>  	int fd;
>  	struct statfs *sbuf;
>  	int error;
> -} TC[] = {
> +} tests[] = {
>  	/* EBADF - fd is invalid */
> -	{
> -	-1, &buf, EBADF},
> +	{-1, &buf, EBADF},
>  #ifndef UCLINUX
> -	    /* Skip since uClinux does not implement memory protection */
> -	    /* EFAULT - address for buf is invalid */
> -	{
> -	-1, (void *)-1, EFAULT}
> +	/* Skip since uClinux does not implement memory protection */
> +	/* EFAULT - address for buf is invalid */
> +	{-1, (void *)-1, EFAULT},
>  #endif

UCLINUX does not exists anymore so we are removing all UCLINUX ifdefs
when cleaning up tests.

>  };
>  
> -int TST_TOTAL = ARRAY_SIZE(TC);
> -
> -int main(int ac, char **av)
> +static void fstatfs_verify(unsigned int n)
>  {
> -	int lc;
> -	int i;
> -
> -	tst_parse_opts(ac, av, NULL, NULL);
> -
> -	setup();
> -
> -	for (lc = 0; TEST_LOOPING(lc); lc++) {
> -
> -		tst_count = 0;
> -
> -		for (i = 0; i < TST_TOTAL; i++) {
> -
> -			TEST(fstatfs(TC[i].fd, TC[i].sbuf));
> -
> -			if (TEST_RETURN != -1) {
> -				tst_resm(TFAIL, "call succeeded unexpectedly");
> -				continue;
> -			}
> -
> -			if (TEST_ERRNO == TC[i].error) {
> -				tst_resm(TPASS, "expected failure - "
> -					 "errno = %d : %s", TEST_ERRNO,
> -					 strerror(TEST_ERRNO));
> -			} else {
> -				tst_resm(TFAIL, "unexpected error - %d : %s - "
> -					 "expected %d", TEST_ERRNO,
> -					 strerror(TEST_ERRNO), TC[i].error);
> -			}
> -		}
> -	}
> -	cleanup();
> -
> -	tst_exit();
> +	TST_EXP_FAIL(fstatfs(tests[n].fd, tests[n].sbuf), tests[n].error, "fstatfs()");
>  }
>  
>  static void setup(void)
>  {
> -	tst_sig(NOFORK, DEF_HANDLER, cleanup);
> -
> -	TEST_PAUSE;
> -
> -	tst_tmpdir();
>  #ifndef UCLINUX
> -	TC[1].fd = SAFE_OPEN(cleanup, "tempfile", O_RDWR | O_CREAT, 0700);
> +	tests[1].fd = SAFE_OPEN("tempfile", O_RDWR | O_CREAT, 0700);
>  #endif

Indexing the the tests array like this is frowned upon, we usually use
pointers in the test structure instead.

>  }
>  
>  static void cleanup(void)
>  {
>  #ifndef UCLINUX
> -	if (TC[1].fd > 0 && close(TC[1].fd))
> -		tst_resm(TWARN | TERRNO, "Failed to close fd");
> +	if (tests[1].fd > 0 && close(tests[1].fd))
> +		tst_res(TWARN | TERRNO, "Failed to close fd");

This should be just:

	if (fd > 0)
		SAFE_CLOSE();

>  #endif
> -
> -	tst_rmdir();
>  }
> +
> +static struct tst_test test = {
> +	.test = fstatfs_verify,
> +	.tcnt = ARRAY_SIZE(tests),
> +	.setup = setup,
> +	.cleanup = cleanup,
> +	.needs_tmpdir = 1,
> +};
> diff --git a/testcases/kernel/syscalls/statfs/statfs02.c b/testcases/kernel/syscalls/statfs/statfs02.c
> index 279665f86..f906c84ff 100644
> --- a/testcases/kernel/syscalls/statfs/statfs02.c
> +++ b/testcases/kernel/syscalls/statfs/statfs02.c
> @@ -1,24 +1,12 @@
> +// SPDX-License-Identifier: GPL-2.0-or-later
>  /*
>   * Copyright (c) International Business Machines  Corp., 2001
>   *	07/2001 Ported by Wayne Boyer
>   *
> - * This program is free software;  you can redistribute it and/or modify
> - * it under the terms of the GNU General Public License as published by
> - * the Free Software Foundation; either version 2 of the License, or
> - * (at your option) any later version.
> - *
> - * This program is distributed in the hope that it will be useful,
> - * but WITHOUT ANY WARRANTY;  without even the implied warranty of
> - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
> - * the GNU General Public License for more details.
> - *
> - * You should have received a copy of the GNU General Public License
> - * along with this program;  if not, write to the Free Software
> - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
>   */
>  
>  /*
> - * DESCRIPTION
> + * [Description]
>   *	1.	Use a component of the pathname, which is not a directory
>   *		in the "path" parameter to statfs(). Expect ENOTDIR
>   *	2.	Pass a filename which doesn't exist, and expect ENOENT.
> @@ -32,25 +20,19 @@
>   *		ELOOP.
>   */

Here as well, it has to start with /*\ and asciidoc formatted

> -#include <sys/types.h>
> -#include <sys/statfs.h>
> -#include <sys/stat.h>
> -#include <fcntl.h>
> -#include <sys/vfs.h>
> -#include <sys/mman.h>
>  #include <errno.h>
> -#include "test.h"
> -#include "safe_macros.h"
> -
> -char *TCID = "statfs02";
> -
> -static int fd;
> +#include <fcntl.h>
> +#include <sys/statfs.h>
> +#include <sys/wait.h>
> +#include "tst_test.h"
> +#include "tst_safe_macros.h"
>  
>  #define TEST_FILE		"statfs_file"
>  #define TEST_FILE1		TEST_FILE"/statfs_file1"
>  #define TEST_NOEXIST		"statfs_noexist"
>  #define TEST_SYMLINK		"statfs_symlink"
>  
> +static int fd;
>  static char test_toolong[PATH_MAX+2];
>  static struct statfs buf;
>  
> @@ -58,7 +40,7 @@ static struct test_case_t {
>  	char *path;
>  	struct statfs *buf;
>  	int exp_error;
> -} TC[] = {
> +} tests[] = {
>  	{TEST_FILE1, &buf, ENOTDIR},
>  	{TEST_NOEXIST, &buf, ENOENT},
>  	{test_toolong, &buf, ENAMETOOLONG},
> @@ -69,72 +51,39 @@ static struct test_case_t {
>  	{TEST_SYMLINK, &buf, ELOOP},
>  };
>  
> -int TST_TOTAL = ARRAY_SIZE(TC);
>  static void setup(void);
>  static void cleanup(void);

These two are useless now.

> -static void statfs_verify(const struct test_case_t *);
>
> -int main(int ac, char **av)
> +static void statfs_verify(unsigned int n)
>  {
> -	int lc;
> -	int i;
> -
> -	tst_parse_opts(ac, av, NULL, NULL);
> -
> -	setup();
> -
> -	for (lc = 0; TEST_LOOPING(lc); lc++) {
> -		tst_count = 0;
> -		for (i = 0; i < TST_TOTAL; i++)
> -			statfs_verify(&TC[i]);
> -	}
> -
> -	cleanup();
> -	tst_exit();
> +	TST_EXP_FAIL(statfs(tests[n].path, tests[n].buf), tests[n].exp_error, "statfs()");
>  }
>  
>  static void setup(void)
>  {
> -	tst_sig(NOFORK, DEF_HANDLER, cleanup);
> -
> -	TEST_PAUSE;
> -
> -	tst_tmpdir();
> -
> -	fd = SAFE_CREAT(cleanup, TEST_FILE, 0444);
> +	fd = SAFE_CREAT(TEST_FILE, 0444);
>  
>  	memset(test_toolong, 'a', PATH_MAX+1);
>  
>  #if !defined(UCLINUX)
> -	TC[3].path = SAFE_MMAP(cleanup, 0, 1, PROT_NONE,
> +	tests[3].path = SAFE_MMAP(0, 1, PROT_NONE,
>  			       MAP_PRIVATE | MAP_ANONYMOUS, 0, 0);
>  #endif

And here as well.

Full diff:

diff --git a/testcases/kernel/syscalls/fstatfs/fstatfs02.c b/testcases/kernel/syscalls/fstatfs/fstatfs02.c
index 4267bd02b..7f8fb760f 100644
--- a/testcases/kernel/syscalls/fstatfs/fstatfs02.c
+++ b/testcases/kernel/syscalls/fstatfs/fstatfs02.c
@@ -3,9 +3,10 @@
  * Copyright (c) International Business Machines  Corp., 2001
  */
 
-/*
+/*\
  * [Description]
- *	Testcase to check fstatfs() sets errno correctly.
+ *
+ * Testcase to check if fstatfs() sets errno correctly.
  */
 
 #include <errno.h>
@@ -17,38 +18,32 @@
 
 static struct statfs buf;
 
+static int fd;
+static int bad_fd = -1;
+
 static struct test_case_t {
-	int fd;
+	int *fd;
 	struct statfs *sbuf;
 	int error;
 } tests[] = {
-	/* EBADF - fd is invalid */
-	{-1, &buf, EBADF},
-#ifndef UCLINUX
-	/* Skip since uClinux does not implement memory protection */
-	/* EFAULT - address for buf is invalid */
-	{-1, (void *)-1, EFAULT},
-#endif
+	{&bad_fd, &buf, EBADF},
+	{&fd, (void *)-1, EFAULT},
 };
 
 static void fstatfs_verify(unsigned int n)
 {
-	TST_EXP_FAIL(fstatfs(tests[n].fd, tests[n].sbuf), tests[n].error, "fstatfs()");
+	TST_EXP_FAIL(fstatfs(*tests[n].fd, tests[n].sbuf), tests[n].error, "fstatfs()");
 }
 
 static void setup(void)
 {
-#ifndef UCLINUX
-	tests[1].fd = SAFE_OPEN("tempfile", O_RDWR | O_CREAT, 0700);
-#endif
+	fd = SAFE_OPEN("tempfile", O_RDWR | O_CREAT, 0700);
 }
 
 static void cleanup(void)
 {
-#ifndef UCLINUX
-	if (tests[1].fd > 0 && close(tests[1].fd))
-		tst_res(TWARN | TERRNO, "Failed to close fd");
-#endif
+	if (fd > 0)
+		SAFE_CLOSE(fd);
 }
 
 static struct tst_test test = {
diff --git a/testcases/kernel/syscalls/statfs/statfs02.c b/testcases/kernel/syscalls/statfs/statfs02.c
index f906c84ff..143063f19 100644
--- a/testcases/kernel/syscalls/statfs/statfs02.c
+++ b/testcases/kernel/syscalls/statfs/statfs02.c
@@ -5,19 +5,15 @@
  *
  */
 
-/*
+/*\
  * [Description]
- *	1.	Use a component of the pathname, which is not a directory
- *		in the "path" parameter to statfs(). Expect ENOTDIR
- *	2.	Pass a filename which doesn't exist, and expect ENOENT.
- *	3.	Pass a pathname which is more than MAXNAMLEN, and expect
- *		ENAMETOOLONG.
- *	4.	Pass a pointer to the pathname outside the address space of
- *		the process, and expect EFAULT.
- *	5.	Pass a pointer to the buf paramter outside the address space
- *		of the process, and expect EFAULT.
- *	6.	Pass a filename which has too many symbolic links, and expect
- *		ELOOP.
+ *
+ * - ENOTDIR A component of the pathname, which is not a directory.
+ * - ENOENT A filename which doesn't exist.
+ * - ENAMETOOLONG A pathname which is longer than MAXNAMLEN.
+ * - EFAULT A pathname pointer outside the address space of the process.
+ * - EFAULT A buf pointer outside the address space of the process.
+ * - ELOOP A filename which has too many symbolic links.
  */
 
 #include <errno.h>
@@ -44,16 +40,11 @@ static struct test_case_t {
 	{TEST_FILE1, &buf, ENOTDIR},
 	{TEST_NOEXIST, &buf, ENOENT},
 	{test_toolong, &buf, ENAMETOOLONG},
-#ifndef UCLINUX
 	{(char *)-1, &buf, EFAULT},
 	{TEST_FILE, (struct statfs *)-1, EFAULT},
-#endif
 	{TEST_SYMLINK, &buf, ELOOP},
 };
 
-static void setup(void);
-static void cleanup(void);
-
 static void statfs_verify(unsigned int n)
 {
 	TST_EXP_FAIL(statfs(tests[n].path, tests[n].buf), tests[n].exp_error, "statfs()");
@@ -61,14 +52,16 @@ static void statfs_verify(unsigned int n)
 
 static void setup(void)
 {
+	unsigned int i;
+
 	fd = SAFE_CREAT(TEST_FILE, 0444);
 
 	memset(test_toolong, 'a', PATH_MAX+1);
 
-#if !defined(UCLINUX)
-	tests[3].path = SAFE_MMAP(0, 1, PROT_NONE,
-			       MAP_PRIVATE | MAP_ANONYMOUS, 0, 0);
-#endif
+	for (i = 0; i < ARRAY_SIZE(tests); i++) {
+		if (tests[i].path == (char *)-1)
+			tests[i].path = tst_get_bad_addr(NULL);
+	}
 
 	SAFE_SYMLINK(TEST_SYMLINK, "statfs_symlink_2");
 	SAFE_SYMLINK("statfs_symlink_2", TEST_SYMLINK);


-- 
Cyril Hrubis
chrubis@suse.cz

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp