diff mbox series

[v2,2/2] syscalls/fstat{03,05}: rewrote testcases

Message ID 20190606090009.31124-2-camann@suse.com
State Changes Requested
Headers show
Series [v2,1/2] syscalls/fstat{01,02}: rewrote testcases | expand

Commit Message

Christian Amann June 6, 2019, 9 a.m. UTC
Merged fstat03 and fstat05:
	Both testcases had lots of duplicated code which
	could be removed by creating a single testcase
	for both scenarios.
Rewrote testcase:
	Cleaned up and ported to new library.

Signed-off-by: Christian Amann <camann@suse.com>
---
 runtest/syscalls                           |   2 -
 testcases/kernel/syscalls/fstat/.gitignore |   2 -
 testcases/kernel/syscalls/fstat/fstat03.c  | 207 +++++++++---------------
 testcases/kernel/syscalls/fstat/fstat05.c  | 244 -----------------------------
 4 files changed, 75 insertions(+), 380 deletions(-)
 delete mode 100644 testcases/kernel/syscalls/fstat/fstat05.c

Comments

Cyril Hrubis June 6, 2019, 11:49 a.m. UTC | #1
Hi!
> +static void sighandler(int sig LTP_ATTRIBUTE_UNUSED)
>  {
> -	struct stat stat_buf;	/* stat structure buffer */
> -	int lc;
> -
> -	tst_parse_opts(ac, av, NULL, NULL);
> -
> -	/*
> -	 * Invoke setup function to create a testfile under temporary
> -	 * directory.
> -	 */
> -	setup();
> +	tst_res(TPASS, "fstat() failed as expected with SIGSEGV");
> +	exit(0);
> +}

Technically you should not use anything but signal-async-safe functions
in signal handlers and while this would work fine most of the time it
may deadlock the process under certain circumstatnces.

So the best way how to handle this is to let the child segfault then do
SAFE_WAITPID() and examine the status value.

> -	for (lc = 0; TEST_LOOPING(lc); lc++) {
> +static void check_fstat(unsigned int tc_num)
> +{
> +	struct tcase *tc = &tcases[tc_num];
>  
> -		tst_count = 0;
> -		/*
> -		 * Call fstat(2) to get the status information
> -		 * of a closed testfile pointed to by 'fd'.
> -		 * verify that fstat fails with -1 return value and
> -		 * sets appropriate errno.
> -		 */
> -		TEST(fstat(fildes, &stat_buf));
> +	if (tc_num == 1)
> +		signal(SIGSEGV, &sighandler);
>  
> -		/* Check return code from fstat(2) */
> -		if (TEST_RETURN == -1) {
> -			if (TEST_ERRNO == EBADF) {
> -				tst_resm(TPASS,
> -					 "fstat() fails with expected error EBADF");
> -			} else {
> -				tst_resm(TFAIL | TTERRNO,
> -					 "fstat() did not fail with EBADF");
> -			}
> +	TEST(fstat(*tc->fd, tc->stat_buf));
> +	if (TST_RET == -1) {
> +		if (tc->exp_err == TST_ERR) {
> +			tst_res(TPASS,
> +				 "fstat() fails with expected error %s",
> +				 tst_strerrno(tc->exp_err));
>  		} else {
> -			tst_resm(TFAIL, "fstat() returned %ld, expected -1",
> -				 TEST_RETURN);
> +			tst_res(TFAIL | TTERRNO,
> +				 "fstat() did not fail with %s, but with",
> +				 tst_strerrno(tc->exp_err));
>  		}
> +	} else {
> +		tst_res(TFAIL, "fstat() returned %ld, expected -1",
> +			 TST_RET);
>  	}
> -
> -	/*
> -	 * Invoke cleanup() to delete the test directory/file(s) created
> -	 * in the setup().
> -	 */
> -	cleanup();
> -
> -	tst_exit();
>  }
>  
> -/*
> - * void
> - * setup(void) - performs all ONE TIME setup for this test.
> - *	Exit the test program on receipt of unexpected signals.
> - *	Create a temporary directory and change directory to it.
> - *      Create a testfile under temporary directory.
> - *      Close the testfile.
> - */
> -void setup(void)
> +static void run(unsigned int tc_num)
>  {
> -	/* Capture unexpected signals */
> -	tst_sig(NOFORK, DEF_HANDLER, cleanup);
> -
> -	TEST_PAUSE;
> -
> -	/* Make a temp dir and cd to it */
> -	tst_tmpdir();
> +	pid_t pid;
>  
> -	/* Create a testfile under temporary directory */
> -	fildes = SAFE_OPEN(cleanup, TEST_FILE, O_RDWR | O_CREAT, 0666);
> -
> -	SAFE_CLOSE(cleanup, fildes);
> +	pid = SAFE_FORK();
> +	if (pid == 0) {
> +		check_fstat(tc_num);
> +		return;
> +	}
> +	tst_reap_children();
>  }
>  
> -/*
> - * void
> - * cleanup() - Performs all ONE TIME cleanup for this test at
> - *             completion or premature exit.
> - *	Print test timing stats and errno log if test executed with options.
> - *	Close the testfile if still opened.
> - *	Remove temporary directory and sub-directories/files under it
> - *	created during setup().
> - *	Exit the test program with normal exit code.
> - */
> -void cleanup(void)
> +static void setup(void)
>  {
> +	fd_ebadf = SAFE_OPEN(TESTFILE, O_RDWR | O_CREAT, 0644);
> +	SAFE_CLOSE(fd_ebadf);

Actually this is kind of useless since the SAFE_CLOSE() sets the
fd_ebadfd to -1.

And we even have tst_get_unused_pid() function exactly for this.

> +	fd_ok = SAFE_OPEN(TESTFILE, O_RDWR | O_CREAT, 0644);
> +}
>  
> -	tst_rmdir();
> -
diff mbox series

Patch

diff --git a/runtest/syscalls b/runtest/syscalls
index 6d85f9bb7..05600f9dc 100644
--- a/runtest/syscalls
+++ b/runtest/syscalls
@@ -336,8 +336,6 @@  fstat02 fstat02
 fstat02_64 fstat02_64
 fstat03 fstat03
 fstat03_64 fstat03_64
-fstat05 fstat05
-fstat05_64 fstat05_64
 
 #fstatat64/newfstatat test cases
 fstatat01 fstatat01
diff --git a/testcases/kernel/syscalls/fstat/.gitignore b/testcases/kernel/syscalls/fstat/.gitignore
index 1c66bdf10..9b1089438 100644
--- a/testcases/kernel/syscalls/fstat/.gitignore
+++ b/testcases/kernel/syscalls/fstat/.gitignore
@@ -2,5 +2,3 @@ 
 /fstat02_64
 /fstat03
 /fstat03_64
-/fstat05
-/fstat05_64
diff --git a/testcases/kernel/syscalls/fstat/fstat03.c b/testcases/kernel/syscalls/fstat/fstat03.c
index 0fa62b847..5676632ab 100644
--- a/testcases/kernel/syscalls/fstat/fstat03.c
+++ b/testcases/kernel/syscalls/fstat/fstat03.c
@@ -1,160 +1,103 @@ 
+// SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * Test Name: fstat03
- *
- * Test Description:
- *   Verify that, fstat(2) returns -1 and sets errno to EBADF if the file
- *   pointed to by file descriptor is not valid.
- *
- * Expected Result:
- *  fstat() should fail with return value -1 and set expected errno.
- *
- * Algorithm:
- *  Setup:
- *   Setup signal handling.
- *   Create temporary directory.
- *   Pause for SIGUSR1 if option specified.
- *
- *  Test:
- *   Loop if the proper options are given.
- *   Execute system call
- *   Check return code, if system call failed (return=-1)
- *	if errno set == expected errno
- *		Issue sys call fails with expected return value and errno.
- *	Otherwise,
- *		Issue sys call fails with unexpected errno.
- *   Otherwise,
- *	Issue sys call returns unexpected value.
- *
- *  Cleanup:
- *   Print errno log and/or timing stats if options given
- *   Delete the temporary directory(s)/file(s) created.
- *
- * Usage:  <for command-line>
- *  fstat03 [-c n] [-e] [-i n] [-I x] [-P x] [-t]
- *     where,  -c n : Run n copies concurrently.
- *             -e   : Turn on errno logging.
- *	       -i n : Execute test n times.
- *	       -I x : Execute test for x seconds.
- *	       -P x : Pause for x seconds between iterations.
- *	       -t   : Turn on syscall timing.
- *
- * HISTORY
- *	07/2001 Ported by Wayne Boyer
- *
- * RESTRICTIONS:
- *  This test should be executed by 'non-super-user' only.
+ * Copyright (c) International Business Machines  Corp., 2001
+ *  07/2001 Ported by Wayne Boyer
+ *  05/2019 Ported to new library: Christian Amann <camann@suse.com>
+ */
+/*
+ * Tests different error scenarios:
  *
+ * 1) Calls fstat() with closed file descriptor
+ *    -> EBADF
+ * 2) Calls fstat() with an invalid address for stat structure
+ *    -> EFAULT (or receive signal SIGSEGV)
  */
 
-#include <stdio.h>
+#include <errno.h>
 #include <stdlib.h>
 #include <unistd.h>
-#include <fcntl.h>
-#include <errno.h>
-#include <string.h>
-#include <signal.h>
 #include <sys/types.h>
 #include <sys/stat.h>
+#include "tst_test.h"
+#include "tst_safe_macros.h"
 
-#include "test.h"
-#include "safe_macros.h"
+#define TESTFILE	"test_file"
 
-#define FILE_MODE	S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH
-#define TEST_FILE	"testfile"
+static int fd_ok;
+static int fd_ebadf;
+static struct stat stat_buf;
 
-char *TCID = "fstat03";
-int TST_TOTAL = 1;
+static struct tcase{
+	int *fd;
+	struct stat *stat_buf;
+	int exp_err;
+} tcases[] = {
+	{&fd_ebadf, &stat_buf, EBADF},
+	{&fd_ok, NULL, EFAULT},
+};
 
-int fildes;			/* testfile descriptor */
-
-void setup();			/* Main setup function for the tests */
-void cleanup();			/* cleanup function for the test */
-
-int main(int ac, char **av)
+static void sighandler(int sig LTP_ATTRIBUTE_UNUSED)
 {
-	struct stat stat_buf;	/* stat structure buffer */
-	int lc;
-
-	tst_parse_opts(ac, av, NULL, NULL);
-
-	/*
-	 * Invoke setup function to create a testfile under temporary
-	 * directory.
-	 */
-	setup();
+	tst_res(TPASS, "fstat() failed as expected with SIGSEGV");
+	exit(0);
+}
 
-	for (lc = 0; TEST_LOOPING(lc); lc++) {
+static void check_fstat(unsigned int tc_num)
+{
+	struct tcase *tc = &tcases[tc_num];
 
-		tst_count = 0;
-		/*
-		 * Call fstat(2) to get the status information
-		 * of a closed testfile pointed to by 'fd'.
-		 * verify that fstat fails with -1 return value and
-		 * sets appropriate errno.
-		 */
-		TEST(fstat(fildes, &stat_buf));
+	if (tc_num == 1)
+		signal(SIGSEGV, &sighandler);
 
-		/* Check return code from fstat(2) */
-		if (TEST_RETURN == -1) {
-			if (TEST_ERRNO == EBADF) {
-				tst_resm(TPASS,
-					 "fstat() fails with expected error EBADF");
-			} else {
-				tst_resm(TFAIL | TTERRNO,
-					 "fstat() did not fail with EBADF");
-			}
+	TEST(fstat(*tc->fd, tc->stat_buf));
+	if (TST_RET == -1) {
+		if (tc->exp_err == TST_ERR) {
+			tst_res(TPASS,
+				 "fstat() fails with expected error %s",
+				 tst_strerrno(tc->exp_err));
 		} else {
-			tst_resm(TFAIL, "fstat() returned %ld, expected -1",
-				 TEST_RETURN);
+			tst_res(TFAIL | TTERRNO,
+				 "fstat() did not fail with %s, but with",
+				 tst_strerrno(tc->exp_err));
 		}
+	} else {
+		tst_res(TFAIL, "fstat() returned %ld, expected -1",
+			 TST_RET);
 	}
-
-	/*
-	 * Invoke cleanup() to delete the test directory/file(s) created
-	 * in the setup().
-	 */
-	cleanup();
-
-	tst_exit();
 }
 
-/*
- * void
- * setup(void) - performs all ONE TIME setup for this test.
- *	Exit the test program on receipt of unexpected signals.
- *	Create a temporary directory and change directory to it.
- *      Create a testfile under temporary directory.
- *      Close the testfile.
- */
-void setup(void)
+static void run(unsigned int tc_num)
 {
-	/* Capture unexpected signals */
-	tst_sig(NOFORK, DEF_HANDLER, cleanup);
-
-	TEST_PAUSE;
-
-	/* Make a temp dir and cd to it */
-	tst_tmpdir();
+	pid_t pid;
 
-	/* Create a testfile under temporary directory */
-	fildes = SAFE_OPEN(cleanup, TEST_FILE, O_RDWR | O_CREAT, 0666);
-
-	SAFE_CLOSE(cleanup, fildes);
+	pid = SAFE_FORK();
+	if (pid == 0) {
+		check_fstat(tc_num);
+		return;
+	}
+	tst_reap_children();
 }
 
-/*
- * void
- * cleanup() - Performs all ONE TIME cleanup for this test at
- *             completion or premature exit.
- *	Print test timing stats and errno log if test executed with options.
- *	Close the testfile if still opened.
- *	Remove temporary directory and sub-directories/files under it
- *	created during setup().
- *	Exit the test program with normal exit code.
- */
-void cleanup(void)
+static void setup(void)
 {
+	fd_ebadf = SAFE_OPEN(TESTFILE, O_RDWR | O_CREAT, 0644);
+	SAFE_CLOSE(fd_ebadf);
+	fd_ok = SAFE_OPEN(TESTFILE, O_RDWR | O_CREAT, 0644);
+}
 
-	tst_rmdir();
-
+static void cleanup(void)
+{
+	if (fd_ok > 0)
+		SAFE_CLOSE(fd_ok);
+	if (fd_ebadf > 0)
+		SAFE_CLOSE(fd_ebadf);
 }
+
+static struct tst_test test = {
+	.test = run,
+	.tcnt = ARRAY_SIZE(tcases),
+	.setup = setup,
+	.cleanup = cleanup,
+	.needs_tmpdir = 1,
+	.forks_child = 1,
+};
diff --git a/testcases/kernel/syscalls/fstat/fstat05.c b/testcases/kernel/syscalls/fstat/fstat05.c
deleted file mode 100644
index 200de4130..000000000
--- a/testcases/kernel/syscalls/fstat/fstat05.c
+++ /dev/null
@@ -1,244 +0,0 @@ 
-/*
- *
- *   Copyright (C) Bull S.A. 2001
- *   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
- */
-
-/*
- * Test Name: fstat05
- *
- * Test Description:
- *   Verify that,
- *   if buffer points outside user's accessible address space fstat(2)
- *	either returns -1 and sets errno to EFAULT
- *	or SIGSEGV is returned instead of EFAULT
- *
- * Expected Result:
- *   fstat() should fail with return value -1 and set expected errno.
- *    or
- *   fstat() should fail with SIGSEGV returned.
- *   Both results are considered as acceptable.
- *
- * Algorithm:
- *  Setup:
- *   Setup signal handling SIGSEGV included.
- *   Switch to nobody user.
- *   Pause for SIGUSR1 if option specified.
- *   Create temporary directory.
- *   Create a testfile under temporary directory.
- *
- *  Test:
- *   Buffer points outside user's accessible address space.
- *   Loop if the proper options are given.
- *   Execute system call
- *   Check return code, if system call failed (return=-1)
- *	if errno set == expected errno
- *		Issue sys call fails with expected return value and errno.
- *	Otherwise,
- *		Issue sys call fails with unexpected errno.
- *   Otherwise,
- *	Issue sys call returns unexpected value.
- *
- *  Sighandler:
- *	if signal == SIGSEGV
- *		Issue sys call fails with expected signal
- *      Otherwise,
- *              Issue sys call fails with unexpected signal.
- *
- *  Cleanup:
- *   Print errno log and/or timing stats if options given
- *   Close the test file
- *   Delete the temporary directory(s)/file(s) created.
- *
- * Usage:  <for command-line>
- *  fstat05 [-c n] [-e] [-i n] [-I x] [-p x] [-t]
- *	where,  -c n : Run n copies concurrently.
- *		-e   : Turn on errno logging.
- *		-i n : Execute test n times.
- *		-I x : Execute test for x seconds.
- *		-P x : Pause for x seconds between iterations.
- *		-t   : Turn on syscall timing.
- *
- * History
- *	05/2002 Jacky Malcles
- *		-Ported
- *
- * Restrictions:
- *      This test must be run as root.
- */
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <unistd.h>
-#include <fcntl.h>
-#include <errno.h>
-#include <string.h>
-#include <signal.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <pwd.h>
-
-#include "test.h"
-#include "safe_macros.h"
-
-#define TEST_FILE       "testfile"
-
-char nobody_uid[] = "nobody";
-struct passwd *ltpuser;
-
-char *TCID = "fstat05";
-int TST_TOTAL = 1;
-
-int fildes;			/* testfile descriptor */
-
-void setup();			/* Main setup function for the tests */
-void cleanup();			/* cleanup function for the test */
-void sighandler(int sig);	/* signals handler function for the test */
-
-int siglist[] = { SIGHUP, SIGINT, SIGQUIT, SIGILL, SIGTRAP, SIGABRT, SIGIOT,
-	SIGBUS, SIGFPE, SIGUSR1, SIGSEGV, SIGUSR2, SIGPIPE, SIGALRM,
-	SIGTERM,
-#ifdef SIGSTKFLT
-	SIGSTKFLT,
-#endif
-	SIGCHLD, SIGCONT, SIGTSTP, SIGTTIN,
-	SIGTTOU, SIGURG, SIGXCPU, SIGXFSZ, SIGVTALRM, SIGPROF,
-	SIGWINCH, SIGIO, SIGPWR, SIGSYS,
-#ifdef SIGUNUSED
-	SIGUNUSED
-#endif
-};
-
-int SIG_SEEN = sizeof(siglist) / sizeof(int);
-
-#if !defined(UCLINUX)
-
-int main(int ac, char **av)
-{
-	struct stat *ptr_str = tst_get_bad_addr(NULL);
-	int lc;
-
-	tst_parse_opts(ac, av, NULL, NULL);
-
-	/*
-	 * Invoke setup function
-	 */
-	setup();
-
-	for (lc = 0; TEST_LOOPING(lc); lc++) {
-
-		tst_count = 0;
-
-		/*
-		 * Call fstat(2).
-		 * verify that it fails with -1 return value and
-		 * sets appropriate errno.
-		 */
-		TEST(fstat(fildes, ptr_str));
-
-		/* Check return code from fstat(2) */
-		if (TEST_RETURN == -1) {
-			if (TEST_ERRNO == EFAULT)
-				tst_resm(TPASS,
-					 "fstat failed with EFAULT as expected");
-			else
-				tst_resm(TFAIL | TTERRNO,
-					 "fstat failed unexpectedly");
-		} else
-			tst_resm(TFAIL, "fstat() returned %ld but we wanted -1",
-				 TEST_RETURN);
-
-	}
-
-	/*
-	 * Invoke cleanup() to delete the test directory/file(s) created
-	 * in the setup().
-	 */
-	cleanup();
-	tst_exit();
-}
-
-#else
-
-int main(void)
-{
-	tst_brkm(TCONF, NULL, "test is not available on uClinux");
-}
-
-#endif /* if !defined(UCLINUX) */
-
-/*
- * void
- * setup(void) - performs all ONE TIME setup for this test.
- *	Exit the test program on receipt of unexpected signals.
- *	Create a temporary directory and change directory to it.
- */
-void setup(void)
-{
-	int i;
-
-	tst_require_root();
-
-	/*
-	 * Capture unexpected signals SIGSEGV included
-	 * SIGSEGV being considered as acceptable as returned value
-	 */
-	for (i = 0; i < SIG_SEEN; i++)
-		signal(siglist[i], &sighandler);
-
-	ltpuser = getpwnam(nobody_uid);
-	SAFE_SETUID(NULL, ltpuser->pw_uid);
-
-	tst_tmpdir();
-
-	/* Create a testfile under temporary directory */
-	fildes = SAFE_OPEN(cleanup, TEST_FILE, O_RDWR | O_CREAT, 0666);
-
-	TEST_PAUSE;
-}
-
-/*
- * void
- * cleanup() - Performs all ONE TIME cleanup for this test at
- *             completion or premature exit.
- *	Print test timing stats and errno log if test executed with options.
- *	Remove temporary directory and sub-directories/files under it
- *	created during setup().
- *	Exit the test program with normal exit code.
- */
-void cleanup(void)
-{
-
-	SAFE_CLOSE(cleanup, fildes);
-
-	tst_rmdir();
-
-}
-
-/*
- * sighandler() - handle the signals
- */
-
-void sighandler(int sig)
-{
-	if (sig == SIGSEGV)
-		tst_resm(TPASS, "fstat failed as expected with SIGSEGV");
-	else
-		tst_brkm(TBROK, NULL, "Unexpected signal %d received.", sig);
-	cleanup();
-	tst_exit();
-}