[LTP] [PATCH 1/2] syscalls/munmap01: Refactor the test using new LTP API

[LTP] [PATCH 1/2] syscalls/munmap01: Refactor the test using new LTP API

[Avinesh Kumar]

Signed-off-by: Avinesh Kumar <akumar@suse.de>
---
 testcases/kernel/syscalls/munmap/munmap01.c | 272 ++++----------------
 1 file changed, 49 insertions(+), 223 deletions(-)

diff --git a/testcases/kernel/syscalls/munmap/munmap01.c b/testcases/kernel/syscalls/munmap/munmap01.c
index 2a5cfc90d..e8e510d77 100644
--- a/testcases/kernel/syscalls/munmap/munmap01.c
+++ b/testcases/kernel/syscalls/munmap/munmap01.c
@@ -1,249 +1,75 @@
+// 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
+ * Copyright (c) International Business Machines  Corp., 2001
+ *  07/2001 Ported by Wayne Boyer
+ * Copyright (c) 2023 SUSE LLC Avinesh Kumar <avinesh.kumar@suse.com>
  */
 
-/*
- * Test Name: munmap01
- *
- * Test Description:
- *  Verify that, munmap call will succeed to unmap a mapped file or
- *  anonymous shared memory region from the calling process's address space
- *  and after successful completion of munmap, the unmapped region is no
- *  longer accessible.
- *
- * Expected Result:
- *  munmap call should succeed to unmap a mapped file or anonymous shared
- *  memory region from the process's address space and it returns with a
- *  value 0, further reference to the unmapped region should result in a
- *  segmentation fault (SIGSEGV).
+/*\
+ * [Description]
  *
- * 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)
- *   	Log the errno and Issue a FAIL message.
- *   Otherwise,
- *   	Verify the Functionality of system call
- *      if successful,
- *      	Issue Functionality-Pass message.
- *      Otherwise,
- *		Issue Functionality-Fail message.
- *  Cleanup:
- *   Print errno log and/or timing stats if options given
- *   Delete the temporary directory created.
- *
- * Usage:  <for command-line>
- *  munmap01 [-c n] [-f] [-i n] [-I x] [-P x] [-t]
- *     where,  -c n : Run n copies concurrently.
- *             -f   : Turn off functionality Testing.
- *	       -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:
- *  None.$
+ * Verify that, munmap() call successfully unmaps a mapped region from a
+ * file mapping, and any attempt to access the unmapped region generates
+ * SIGSEGV signal.
  */
-#include <errno.h>
-#include <unistd.h>
-#include <fcntl.h>
-#include <sys/stat.h>
-#include <sys/mman.h>
-
-#include "test.h"
-#include "safe_macros.h"
-
-#define TEMPFILE	"mmapfile"
 
-char *TCID = "munmap01";
-int TST_TOTAL = 1;
+#include "tst_test.h"
+#include <setjmp.h>
 
-char *addr;			/* addr of memory mapped region */
-int fildes;			/* file descriptor for tempfile */
-unsigned int map_len;		/* length of the region to be mapped */
+#define TEMPFILE "mmapfile"
+static char *addr;
+static int fd;
+static volatile int sig_flag;
+static sigjmp_buf env;
+static size_t page_sz;
 
-void setup();			/* Main setup function of test */
-void cleanup();			/* cleanup function for the test */
-void sig_handler();		/* signal catching function */
-
-int main(int ac, char **av)
+static void sig_handler(int sig)
 {
-	int lc;
-
-	tst_parse_opts(ac, av, NULL, NULL);
-
-	for (lc = 0; TEST_LOOPING(lc); lc++) {
-
-		tst_count = 0;
-
-		setup();
-
-		/*
-		 * Call munmap to unmap the mapped region of the
-		 * temporary file from the calling process's address space.
-		 */
-		TEST(munmap(addr, map_len));
-
-		/* Check for the return value of munmap() */
-		if (TEST_RETURN == -1) {
-			tst_resm(TFAIL, "munmap() fails, errno=%d : %s",
-				 TEST_ERRNO, strerror(TEST_ERRNO));
-			continue;
-		}
-#ifdef UCLINUX
-		/*
-		 * No SIGSEGV on uClinux since
-		 * MMU not implemented on uClinux
-		 */
-		tst_resm(TPASS, "call succedded");
-#else
-		/*
-		 * Check whether further reference is possible
-		 * to the unmapped memory region by writing
-		 * to the first byte of region with
-		 * some arbitrary number.
-		 */
-		*addr = 50;
-
-		/* This message is printed if no SIGSEGV */
-		tst_resm(TFAIL, "process succeeds to refer unmapped "
-			 "memory region");
-#endif
-
-		cleanup();
-
+	if (sig == SIGSEGV) {
+		sig_flag = 1;
+		siglongjmp(env, 1);
 	}
-	tst_exit();
 }
 
-/*
- * setup() - performs all ONE TIME setup for this test.
- *
- * Set up signal handler to catch SIGSEGV.
- * Get system page size, create a temporary file for reading/writing,
- * write one byte data into it, map the open file for the specified
- * map length.
- */
-void setup(void)
+static void setup(void)
 {
-	size_t page_sz;
+	SAFE_SIGNAL(SIGSEGV, sig_handler);
 
-	tst_sig(NOFORK, DEF_HANDLER, cleanup);
-
-	/* call signal function to trap the signal generated */
-	if (signal(SIGSEGV, sig_handler) == SIG_ERR) {
-		tst_brkm(TBROK, cleanup, "signal fails to catch signal");
-	}
-
-	TEST_PAUSE;
-
-	/* Get the system page size */
 	page_sz = getpagesize();
+	fd = SAFE_OPEN(TEMPFILE, O_RDWR | O_CREAT, 0666);
 
-	/*
-	 * Get the length of the open file to be mapped into process
-	 * address space.
-	 */
-	map_len = 3 * page_sz;
-
-	tst_tmpdir();
+	SAFE_LSEEK(fd, page_sz * 2, SEEK_SET);
+	SAFE_WRITE(SAFE_WRITE_ALL, fd, "a", 1);
+}
 
-	/* Creat a temporary file used for mapping */
-	if ((fildes = open(TEMPFILE, O_RDWR | O_CREAT, 0666)) < 0) {
-		tst_brkm(TBROK, cleanup, "open() on %s Failed, errno=%d : %s",
-			 TEMPFILE, errno, strerror(errno));
-	}
+static void run(void)
+{
+	addr = SAFE_MMAP(NULL, page_sz, PROT_READ | PROT_WRITE, MAP_FILE | MAP_SHARED, fd, 0);
 
-	/*
-	 * move the file pointer to maplength position from the beginning
-	 * of the file.
-	 */
-	SAFE_LSEEK(cleanup, fildes, map_len, SEEK_SET);
+	TST_EXP_PASS(munmap(addr, page_sz));
+	if (TST_RET == -1)
+		return;
 
-	/* Write one byte into temporary file */
-	if (write(fildes, "a", 1) != 1) {
-		tst_brkm(TBROK, cleanup, "write() on %s Failed, errno=%d : %s",
-			 TEMPFILE, errno, strerror(errno));
-	}
+	if (sigsetjmp(env, 1) == 0)
+		*addr = 50;
 
-	/*
-	 * map the open file 'TEMPFILE' from its beginning up to the maplength
-	 * into the calling process's address space at the system choosen
-	 * with read/write permissions to the the mapped region.
-	 */
-#ifdef UCLINUX
-	/* MAP_SHARED is not implemented on uClinux */
-	addr = mmap(0, map_len, PROT_READ | PROT_WRITE,
-		    MAP_FILE | MAP_PRIVATE, fildes, 0);
-#else
-	addr = mmap(0, map_len, PROT_READ | PROT_WRITE,
-		    MAP_FILE | MAP_SHARED, fildes, 0);
-#endif
-
-	/* check for the return value of mmap system call */
-	if (addr == (char *)MAP_FAILED) {
-		tst_brkm(TBROK, cleanup, "mmap() Failed on %s, errno=%d : %s",
-			 TEMPFILE, errno, strerror(errno));
-	}
+	if (sig_flag == 1)
+		tst_res(TPASS, "Received SIGSEGV signal");
+	else
+		tst_res(TFAIL, "SIGSEGV signal not received");
 
+	sig_flag = 0;
 }
 
-/*
- * sig_handler() - signal catching function.
- *   This function is used to trap the signal generated when tried to read or
- *   write to the memory mapped region which is already detached from the
- *   calling process address space.
- *   this function is invoked when SIGSEGV generated and it calls test
- *   cleanup function and exit the program.
- */
-void sig_handler(void)
+static void cleanup(void)
 {
-	tst_resm(TPASS, "Functionality of munmap() successful");
-
-	/* Invoke test cleanup function and exit */
-	cleanup();
-
-	tst_exit();
+	if (fd > 0)
+		SAFE_CLOSE(fd);
 }
 
-/*
- * cleanup() - performs all ONE TIME cleanup for this test at
- *             completion or premature exit.
- *  	       Close the temporary file.
- *  	       Remove the temporary directory.
- */
-void cleanup(void)
-{
-
-	/* Close the temporary file */
-	if (close(fildes) < 0) {
-		tst_brkm(TFAIL, NULL, "close() on %s Failed, errno=%d : %s",
-			 TEMPFILE, errno, strerror(errno));
-	}
-
-	tst_rmdir();
-}
+static struct tst_test test = {
+	.setup = setup,
+	.cleanup = cleanup,
+	.test_all = run,
+	.needs_tmpdir = 1
+};
-- 
2.42.0


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

[LTP] [PATCH 2/2] syscalls/munmap02: Refactor the test using new LTP API

[Avinesh Kumar]

Signed-off-by: Avinesh Kumar <akumar@suse.de>
---
 testcases/kernel/syscalls/munmap/munmap02.c | 297 ++++----------------
 1 file changed, 55 insertions(+), 242 deletions(-)

diff --git a/testcases/kernel/syscalls/munmap/munmap02.c b/testcases/kernel/syscalls/munmap/munmap02.c
index b43250512..7c7fb5b2c 100644
--- a/testcases/kernel/syscalls/munmap/munmap02.c
+++ b/testcases/kernel/syscalls/munmap/munmap02.c
@@ -1,270 +1,83 @@
+// 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
+ * Copyright (c) International Business Machines  Corp., 2001
+ *  07/2001 Ported by Wayne Boyer
+ * Copyright (c) 2023 SUSE LLC Avinesh Kumar <avinesh.kumar@suse.com>
  */
 
-/*
- * Test Name: munmap02
- *
- * Test Description:
- *  Verify that, munmap call will succeed to unmap a mapped file or
- *  anonymous shared memory region from the calling process's address space
- *  if the region specified by the address and the length is part or all of
- *  the mapped region.
- *
- * Expected Result:
- *  munmap call should succeed to unmap a part or all of mapped region of a
- *  file or anonymous shared memory from the process's address space and it
- *  returns with a value 0,
- *  further reference to the unmapped region should result in a segmentation
- *  fault (SIGSEGV).
+/*\
+ * [Description]
  *
- * 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)
- *   	Log the errno and Issue a FAIL message.
- *   Otherwise,
- *   	Verify the Functionality of system call
- *      if successful,
- *      	Issue Functionality-Pass message.
- *      Otherwise,
- *		Issue Functionality-Fail message.
- *  Cleanup:
- *   Print errno log and/or timing stats if options given
- *   Delete the temporary directory created.
- *
- * Usage:  <for command-line>
- *  munmap01 [-c n] [-f] [-i n] [-I x] [-P x] [-t]
- *     where,  -c n : Run n copies concurrently.
- *             -f   : Turn off functionality Testing.
- *	       -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:
- *  None.
+ * Verify that, munmap() call succeeds to unmap a mapped file region from
+ * the calling process's address space when the region being unmapped is
+ * only part of the total mapped region, and any attempt to access the
+ * unmapped memory region generates SIGSEGV signal.
  */
-#include <errno.h>
-#include <unistd.h>
-#include <fcntl.h>
-#include <sys/stat.h>
-#include <sys/mman.h>
-
-#include "test.h"
-#include "safe_macros.h"
-
-#define TEMPFILE	"mmapfile"
 
-char *TCID = "munmap02";
-int TST_TOTAL = 1;
+#include "tst_test.h"
+#include <setjmp.h>
 
+#define TEMPFILE "mmapfile"
+static char *addr1, *addr2;
+static int fd;
+static volatile int sig_flag;
+static sigjmp_buf env;
 static size_t page_sz;
-char *addr;			/* addr of memory mapped region */
-int fildes;			/* file descriptor for tempfile */
-unsigned int map_len;		/* length of the region to be mapped */
+static unsigned int map_len;
 
-void setup();			/* Main setup function of test */
-void cleanup();			/* cleanup function for the test */
-void sig_handler();		/* signal catching function */
-
-#ifndef UCLINUX
-
-int main(int ac, char **av)
+static void sig_handler(int sig)
 {
-	int lc;
-
-	tst_parse_opts(ac, av, NULL, NULL);
-
-	for (lc = 0; TEST_LOOPING(lc); lc++) {
-
-		tst_count = 0;
-
-		setup();
-
-		/*
-		 * Call munmap to unmap the part of the mapped region of the
-		 * temporary file from the address and length that is part of
-		 * the mapped region.
-		 */
-		TEST(munmap(addr, map_len));
-
-		/* Check for the return value of munmap() */
-		if (TEST_RETURN == -1) {
-			tst_resm(TFAIL, "munmap() fails, errno=%d : %s",
-				 TEST_ERRNO, strerror(TEST_ERRNO));
-			continue;
-		}
-		/*
-		 * Check whether further reference is possible
-		 * to the unmapped memory region by writing
-		 * to the first byte of region with
-		 * some arbitrary number.
-		 */
-		*addr = 50;
-
-		/* This message is printed if no SIGSEGV */
-		tst_resm(TFAIL, "process succeeds to refer unmapped "
-			 "memory region");
-		cleanup();
-
+	if (sig == SIGSEGV) {
+		sig_flag = 1;
+		siglongjmp(env, 1);
 	}
-	tst_exit();
-}
-
-#else
-
-int main(void)
-{
-	tst_resm(TINFO, "munmap02 test is not available on uClinux");
-	tst_exit();
 }
 
-#endif /* ifndef UCLINUX */
-
-/*
- * setup() - performs all ONE TIME setup for this test.
- * Setup signal handler to catch SIGSEGV.
- * Get system page size, create a temporary file for reading/writing,
- * write one byte data into it, map the open file for the specified
- * map length.
- */
-void setup(void)
+static void setup(void)
 {
+	SAFE_SIGNAL(SIGSEGV, sig_handler);
 
-	tst_sig(NOFORK, DEF_HANDLER, cleanup);
-
-	/* call signal function to trap the signal generated */
-	if (signal(SIGSEGV, sig_handler) == SIG_ERR) {
-		tst_brkm(TBROK, cleanup, "signal fails to catch signal");
-	}
-
-	TEST_PAUSE;
-
-	/* Get the system page size */
 	page_sz = getpagesize();
+	map_len = page_sz * 3;
 
-	/*
-	 * Get the length of the open file to be mapped into process
-	 * address space.
-	 */
-	map_len = 3 * page_sz;
-
-	tst_tmpdir();
+	fd = SAFE_OPEN(TEMPFILE, O_RDWR | O_CREAT, 0666);
+	SAFE_LSEEK(fd, map_len, SEEK_SET);
+	SAFE_WRITE(SAFE_WRITE_ALL, fd, "a", 1);
+}
 
-	/* Creat a temporary file used for mapping */
-	if ((fildes = open(TEMPFILE, O_RDWR | O_CREAT, 0666)) < 0) {
-		tst_brkm(TBROK, cleanup, "open() on %s Failed, errno=%d : %s",
-			 TEMPFILE, errno, strerror(errno));
-	}
+static void run(void)
+{
+	addr1 = SAFE_MMAP(NULL, map_len, PROT_READ | PROT_WRITE, MAP_FILE | MAP_SHARED, fd, 0);
 
-	/*
-	 * move the file pointer to maplength position from the beginning
-	 * of the file.
-	 */
-	SAFE_LSEEK(cleanup, fildes, map_len, SEEK_SET);
+	addr2 = (char *)((long)addr1 + page_sz);
+	map_len = page_sz * 2;
 
-	/* Write one byte into temporary file */
-	if (write(fildes, "a", 1) != 1) {
-		tst_brkm(TBROK, cleanup, "write() on %s Failed, errno=%d : %s",
-			 TEMPFILE, errno, strerror(errno));
-	}
+	TST_EXP_PASS(munmap(addr2, map_len));
+	if (TST_RET == -1)
+		return;
 
-	/*
-	 * map the open file 'TEMPFILE' from its beginning up to the maplength
-	 * into the calling process's address space at the system choosen
-	 * with read/write permissions to the the mapped region.
-	 */
-#ifdef UCLINUX
-	/* mmap() doesn't support MAP_SHARED on uClinux */
-	addr = mmap(0, map_len, PROT_READ | PROT_WRITE,
-		    MAP_FILE | MAP_PRIVATE, fildes, 0);
-#else
-	addr = mmap(0, map_len, PROT_READ | PROT_WRITE,
-		    MAP_FILE | MAP_SHARED, fildes, 0);
-#endif
+	if (sigsetjmp(env, 1) == 0)
+		*addr2 = 50;
 
-	/* check for the return value of mmap system call */
-	if (addr == (char *)MAP_FAILED) {
-		tst_brkm(TBROK, cleanup, "mmap() Failed on %s, errno=%d : %s",
-			 TEMPFILE, errno, strerror(errno));
-	}
+	if (sig_flag == 1)
+		tst_res(TPASS, "Received SIGSEGV signal");
+	else
+		tst_res(TFAIL, "SIGSEGV signal not received");
 
-	/*
-	 * increment the start address of the region at which the file is
-	 * mapped to a maplength of 3 times the system page size by the value
-	 * of system  page size and decrement the maplength value by the value
-	 * of system page size.
-	 */
-	addr = (char *)((long)addr + page_sz);
-	map_len = map_len - page_sz;
+	SAFE_MUNMAP(addr1, page_sz);
+	map_len = page_sz * 3;
+	sig_flag = 0;
 }
 
-/*
- * void
- * sig_handler() - signal catching function.
- *   This function is used to trap the signal generated when tried to read or
- *   write to the memory mapped region which is already detached from the
- *   calling process address space.
- *   this function is invoked when SIGSEGV generated and it calls test
- *   cleanup function and exit the program.
- */
-void sig_handler(void)
+static void cleanup(void)
 {
-	tst_resm(TPASS, "Functionality of munmap() successful");
-
-	/* Invoke test cleanup function and exit */
-	cleanup();
-
-	tst_exit();
+	if (fd > 0)
+		SAFE_CLOSE(fd);
 }
 
-/*
- * cleanup() - performs all ONE TIME cleanup for this test at
- *             completion or premature exit.
- *  Unmap the portion of the region of the file left unmapped.
- *  Close the temporary file.
- *  Remove the temporary directory.
- */
-void cleanup(void)
-{
-
-	/*
-	 * get the start address and length of the portion of
-	 * the mapped region of the file.
-	 */
-	addr = (char *)((long)addr - page_sz);
-	map_len = map_len - page_sz;
-
-	/* unmap the portion of the region of the file left unmapped */
-	SAFE_MUNMAP(NULL, addr, map_len);
-
-	/* Close the temporary file */
-	SAFE_CLOSE(NULL, fildes);
-
-	tst_rmdir();
-}
+static struct tst_test test = {
+	.setup = setup,
+	.cleanup = cleanup,
+	.test_all = run,
+	.needs_tmpdir = 1
+};
-- 
2.42.0


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

Re: [LTP] [PATCH 2/2] syscalls/munmap02: Refactor the test using new LTP API

[Andrea Cervesato via ltp]

Hi!

munmap01 and munmap02 looks quite similar. The refactoring is good to 
me, but maybe we can merge them into a single test using 2 different 
test cases, where the first is mapping a certain portion of the file and 
the second an another.

Regards,
Andrea

On 9/13/23 12:08, Avinesh Kumar wrote:
> Signed-off-by: Avinesh Kumar <akumar@suse.de>
> ---
>   testcases/kernel/syscalls/munmap/munmap02.c | 297 ++++----------------
>   1 file changed, 55 insertions(+), 242 deletions(-)
>
> diff --git a/testcases/kernel/syscalls/munmap/munmap02.c b/testcases/kernel/syscalls/munmap/munmap02.c
> index b43250512..7c7fb5b2c 100644
> --- a/testcases/kernel/syscalls/munmap/munmap02.c
> +++ b/testcases/kernel/syscalls/munmap/munmap02.c
> @@ -1,270 +1,83 @@
> +// 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
> + * Copyright (c) International Business Machines  Corp., 2001
> + *  07/2001 Ported by Wayne Boyer
> + * Copyright (c) 2023 SUSE LLC Avinesh Kumar <avinesh.kumar@suse.com>
>    */
>   
> -/*
> - * Test Name: munmap02
> - *
> - * Test Description:
> - *  Verify that, munmap call will succeed to unmap a mapped file or
> - *  anonymous shared memory region from the calling process's address space
> - *  if the region specified by the address and the length is part or all of
> - *  the mapped region.
> - *
> - * Expected Result:
> - *  munmap call should succeed to unmap a part or all of mapped region of a
> - *  file or anonymous shared memory from the process's address space and it
> - *  returns with a value 0,
> - *  further reference to the unmapped region should result in a segmentation
> - *  fault (SIGSEGV).
> +/*\
> + * [Description]
>    *
> - * 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)
> - *   	Log the errno and Issue a FAIL message.
> - *   Otherwise,
> - *   	Verify the Functionality of system call
> - *      if successful,
> - *      	Issue Functionality-Pass message.
> - *      Otherwise,
> - *		Issue Functionality-Fail message.
> - *  Cleanup:
> - *   Print errno log and/or timing stats if options given
> - *   Delete the temporary directory created.
> - *
> - * Usage:  <for command-line>
> - *  munmap01 [-c n] [-f] [-i n] [-I x] [-P x] [-t]
> - *     where,  -c n : Run n copies concurrently.
> - *             -f   : Turn off functionality Testing.
> - *	       -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:
> - *  None.
> + * Verify that, munmap() call succeeds to unmap a mapped file region from
> + * the calling process's address space when the region being unmapped is
> + * only part of the total mapped region, and any attempt to access the
> + * unmapped memory region generates SIGSEGV signal.
>    */
> -#include <errno.h>
> -#include <unistd.h>
> -#include <fcntl.h>
> -#include <sys/stat.h>
> -#include <sys/mman.h>
> -
> -#include "test.h"
> -#include "safe_macros.h"
> -
> -#define TEMPFILE	"mmapfile"
>   
> -char *TCID = "munmap02";
> -int TST_TOTAL = 1;
> +#include "tst_test.h"
> +#include <setjmp.h>
>   
> +#define TEMPFILE "mmapfile"
> +static char *addr1, *addr2;
> +static int fd;
> +static volatile int sig_flag;
> +static sigjmp_buf env;
>   static size_t page_sz;
> -char *addr;			/* addr of memory mapped region */
> -int fildes;			/* file descriptor for tempfile */
> -unsigned int map_len;		/* length of the region to be mapped */
> +static unsigned int map_len;
>   
> -void setup();			/* Main setup function of test */
> -void cleanup();			/* cleanup function for the test */
> -void sig_handler();		/* signal catching function */
> -
> -#ifndef UCLINUX
> -
> -int main(int ac, char **av)
> +static void sig_handler(int sig)
>   {
> -	int lc;
> -
> -	tst_parse_opts(ac, av, NULL, NULL);
> -
> -	for (lc = 0; TEST_LOOPING(lc); lc++) {
> -
> -		tst_count = 0;
> -
> -		setup();
> -
> -		/*
> -		 * Call munmap to unmap the part of the mapped region of the
> -		 * temporary file from the address and length that is part of
> -		 * the mapped region.
> -		 */
> -		TEST(munmap(addr, map_len));
> -
> -		/* Check for the return value of munmap() */
> -		if (TEST_RETURN == -1) {
> -			tst_resm(TFAIL, "munmap() fails, errno=%d : %s",
> -				 TEST_ERRNO, strerror(TEST_ERRNO));
> -			continue;
> -		}
> -		/*
> -		 * Check whether further reference is possible
> -		 * to the unmapped memory region by writing
> -		 * to the first byte of region with
> -		 * some arbitrary number.
> -		 */
> -		*addr = 50;
> -
> -		/* This message is printed if no SIGSEGV */
> -		tst_resm(TFAIL, "process succeeds to refer unmapped "
> -			 "memory region");
> -		cleanup();
> -
> +	if (sig == SIGSEGV) {
> +		sig_flag = 1;
> +		siglongjmp(env, 1);
>   	}
> -	tst_exit();
> -}
> -
> -#else
> -
> -int main(void)
> -{
> -	tst_resm(TINFO, "munmap02 test is not available on uClinux");
> -	tst_exit();
>   }
>   
> -#endif /* ifndef UCLINUX */
> -
> -/*
> - * setup() - performs all ONE TIME setup for this test.
> - * Setup signal handler to catch SIGSEGV.
> - * Get system page size, create a temporary file for reading/writing,
> - * write one byte data into it, map the open file for the specified
> - * map length.
> - */
> -void setup(void)
> +static void setup(void)
>   {
> +	SAFE_SIGNAL(SIGSEGV, sig_handler);
>   
> -	tst_sig(NOFORK, DEF_HANDLER, cleanup);
> -
> -	/* call signal function to trap the signal generated */
> -	if (signal(SIGSEGV, sig_handler) == SIG_ERR) {
> -		tst_brkm(TBROK, cleanup, "signal fails to catch signal");
> -	}
> -
> -	TEST_PAUSE;
> -
> -	/* Get the system page size */
>   	page_sz = getpagesize();
> +	map_len = page_sz * 3;
>   
> -	/*
> -	 * Get the length of the open file to be mapped into process
> -	 * address space.
> -	 */
> -	map_len = 3 * page_sz;
> -
> -	tst_tmpdir();
> +	fd = SAFE_OPEN(TEMPFILE, O_RDWR | O_CREAT, 0666);
> +	SAFE_LSEEK(fd, map_len, SEEK_SET);
> +	SAFE_WRITE(SAFE_WRITE_ALL, fd, "a", 1);
> +}
>   
> -	/* Creat a temporary file used for mapping */
> -	if ((fildes = open(TEMPFILE, O_RDWR | O_CREAT, 0666)) < 0) {
> -		tst_brkm(TBROK, cleanup, "open() on %s Failed, errno=%d : %s",
> -			 TEMPFILE, errno, strerror(errno));
> -	}
> +static void run(void)
> +{
> +	addr1 = SAFE_MMAP(NULL, map_len, PROT_READ | PROT_WRITE, MAP_FILE | MAP_SHARED, fd, 0);
>   
> -	/*
> -	 * move the file pointer to maplength position from the beginning
> -	 * of the file.
> -	 */
> -	SAFE_LSEEK(cleanup, fildes, map_len, SEEK_SET);
> +	addr2 = (char *)((long)addr1 + page_sz);
> +	map_len = page_sz * 2;
>   
> -	/* Write one byte into temporary file */
> -	if (write(fildes, "a", 1) != 1) {
> -		tst_brkm(TBROK, cleanup, "write() on %s Failed, errno=%d : %s",
> -			 TEMPFILE, errno, strerror(errno));
> -	}
> +	TST_EXP_PASS(munmap(addr2, map_len));
> +	if (TST_RET == -1)
> +		return;
>   
> -	/*
> -	 * map the open file 'TEMPFILE' from its beginning up to the maplength
> -	 * into the calling process's address space at the system choosen
> -	 * with read/write permissions to the the mapped region.
> -	 */
> -#ifdef UCLINUX
> -	/* mmap() doesn't support MAP_SHARED on uClinux */
> -	addr = mmap(0, map_len, PROT_READ | PROT_WRITE,
> -		    MAP_FILE | MAP_PRIVATE, fildes, 0);
> -#else
> -	addr = mmap(0, map_len, PROT_READ | PROT_WRITE,
> -		    MAP_FILE | MAP_SHARED, fildes, 0);
> -#endif
> +	if (sigsetjmp(env, 1) == 0)
> +		*addr2 = 50;
>   
> -	/* check for the return value of mmap system call */
> -	if (addr == (char *)MAP_FAILED) {
> -		tst_brkm(TBROK, cleanup, "mmap() Failed on %s, errno=%d : %s",
> -			 TEMPFILE, errno, strerror(errno));
> -	}
> +	if (sig_flag == 1)
> +		tst_res(TPASS, "Received SIGSEGV signal");
> +	else
> +		tst_res(TFAIL, "SIGSEGV signal not received");
>   
> -	/*
> -	 * increment the start address of the region at which the file is
> -	 * mapped to a maplength of 3 times the system page size by the value
> -	 * of system  page size and decrement the maplength value by the value
> -	 * of system page size.
> -	 */
> -	addr = (char *)((long)addr + page_sz);
> -	map_len = map_len - page_sz;
> +	SAFE_MUNMAP(addr1, page_sz);
> +	map_len = page_sz * 3;
> +	sig_flag = 0;
>   }
>   
> -/*
> - * void
> - * sig_handler() - signal catching function.
> - *   This function is used to trap the signal generated when tried to read or
> - *   write to the memory mapped region which is already detached from the
> - *   calling process address space.
> - *   this function is invoked when SIGSEGV generated and it calls test
> - *   cleanup function and exit the program.
> - */
> -void sig_handler(void)
> +static void cleanup(void)
>   {
> -	tst_resm(TPASS, "Functionality of munmap() successful");
> -
> -	/* Invoke test cleanup function and exit */
> -	cleanup();
> -
> -	tst_exit();
> +	if (fd > 0)
> +		SAFE_CLOSE(fd);
>   }
>   
> -/*
> - * cleanup() - performs all ONE TIME cleanup for this test at
> - *             completion or premature exit.
> - *  Unmap the portion of the region of the file left unmapped.
> - *  Close the temporary file.
> - *  Remove the temporary directory.
> - */
> -void cleanup(void)
> -{
> -
> -	/*
> -	 * get the start address and length of the portion of
> -	 * the mapped region of the file.
> -	 */
> -	addr = (char *)((long)addr - page_sz);
> -	map_len = map_len - page_sz;
> -
> -	/* unmap the portion of the region of the file left unmapped */
> -	SAFE_MUNMAP(NULL, addr, map_len);
> -
> -	/* Close the temporary file */
> -	SAFE_CLOSE(NULL, fildes);
> -
> -	tst_rmdir();
> -}
> +static struct tst_test test = {
> +	.setup = setup,
> +	.cleanup = cleanup,
> +	.test_all = run,
> +	.needs_tmpdir = 1
> +};



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

Re: [LTP] [PATCH 2/2] syscalls/munmap02: Refactor the test using new LTP API

[Richard Palethorpe]

Hello,

Andrea Cervesato via ltp <ltp@lists.linux.it> writes:

> Hi!
>
> munmap01 and munmap02 looks quite similar. The refactoring is good to
> me, but maybe we can merge them into a single test using 2 different
> test cases, where the first is mapping a certain portion of the file
> and the second an another.

Yes, these should be merged. Otherwise the rewrite looks good.

>
> Regards,
> Andrea
>
> On 9/13/23 12:08, Avinesh Kumar wrote:
>> Signed-off-by: Avinesh Kumar <akumar@suse.de>
>> ---
>>   testcases/kernel/syscalls/munmap/munmap02.c | 297 ++++----------------
>>   1 file changed, 55 insertions(+), 242 deletions(-)
>>
>> diff --git a/testcases/kernel/syscalls/munmap/munmap02.c b/testcases/kernel/syscalls/munmap/munmap02.c
>> index b43250512..7c7fb5b2c 100644
>> --- a/testcases/kernel/syscalls/munmap/munmap02.c
>> +++ b/testcases/kernel/syscalls/munmap/munmap02.c
>> @@ -1,270 +1,83 @@
>> +// 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
>> + * Copyright (c) International Business Machines  Corp., 2001
>> + *  07/2001 Ported by Wayne Boyer
>> + * Copyright (c) 2023 SUSE LLC Avinesh Kumar <avinesh.kumar@suse.com>
>>    */
>>   -/*
>> - * Test Name: munmap02
>> - *
>> - * Test Description:
>> - *  Verify that, munmap call will succeed to unmap a mapped file or
>> - *  anonymous shared memory region from the calling process's address space
>> - *  if the region specified by the address and the length is part or all of
>> - *  the mapped region.
>> - *
>> - * Expected Result:
>> - *  munmap call should succeed to unmap a part or all of mapped region of a
>> - *  file or anonymous shared memory from the process's address space and it
>> - *  returns with a value 0,
>> - *  further reference to the unmapped region should result in a segmentation
>> - *  fault (SIGSEGV).
>> +/*\
>> + * [Description]
>>    *
>> - * 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)
>> - *   	Log the errno and Issue a FAIL message.
>> - *   Otherwise,
>> - *   	Verify the Functionality of system call
>> - *      if successful,
>> - *      	Issue Functionality-Pass message.
>> - *      Otherwise,
>> - *		Issue Functionality-Fail message.
>> - *  Cleanup:
>> - *   Print errno log and/or timing stats if options given
>> - *   Delete the temporary directory created.
>> - *
>> - * Usage:  <for command-line>
>> - *  munmap01 [-c n] [-f] [-i n] [-I x] [-P x] [-t]
>> - *     where,  -c n : Run n copies concurrently.
>> - *             -f   : Turn off functionality Testing.
>> - *	       -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:
>> - *  None.
>> + * Verify that, munmap() call succeeds to unmap a mapped file region from
>> + * the calling process's address space when the region being unmapped is
>> + * only part of the total mapped region, and any attempt to access the
>> + * unmapped memory region generates SIGSEGV signal.
>>    */
>> -#include <errno.h>
>> -#include <unistd.h>
>> -#include <fcntl.h>
>> -#include <sys/stat.h>
>> -#include <sys/mman.h>
>> -
>> -#include "test.h"
>> -#include "safe_macros.h"
>> -
>> -#define TEMPFILE	"mmapfile"
>>   -char *TCID = "munmap02";
>> -int TST_TOTAL = 1;
>> +#include "tst_test.h"
>> +#include <setjmp.h>
>>   +#define TEMPFILE "mmapfile"
>> +static char *addr1, *addr2;
>> +static int fd;
>> +static volatile int sig_flag;
>> +static sigjmp_buf env;
>>   static size_t page_sz;
>> -char *addr;			/* addr of memory mapped region */
>> -int fildes;			/* file descriptor for tempfile */
>> -unsigned int map_len;		/* length of the region to be mapped */
>> +static unsigned int map_len;
>>   -void setup();			/* Main setup function of test
>> */
>> -void cleanup();			/* cleanup function for the test */
>> -void sig_handler();		/* signal catching function */
>> -
>> -#ifndef UCLINUX
>> -
>> -int main(int ac, char **av)
>> +static void sig_handler(int sig)
>>   {
>> -	int lc;
>> -
>> -	tst_parse_opts(ac, av, NULL, NULL);
>> -
>> -	for (lc = 0; TEST_LOOPING(lc); lc++) {
>> -
>> -		tst_count = 0;
>> -
>> -		setup();
>> -
>> -		/*
>> -		 * Call munmap to unmap the part of the mapped region of the
>> -		 * temporary file from the address and length that is part of
>> -		 * the mapped region.
>> -		 */
>> -		TEST(munmap(addr, map_len));
>> -
>> -		/* Check for the return value of munmap() */
>> -		if (TEST_RETURN == -1) {
>> -			tst_resm(TFAIL, "munmap() fails, errno=%d : %s",
>> -				 TEST_ERRNO, strerror(TEST_ERRNO));
>> -			continue;
>> -		}
>> -		/*
>> -		 * Check whether further reference is possible
>> -		 * to the unmapped memory region by writing
>> -		 * to the first byte of region with
>> -		 * some arbitrary number.
>> -		 */
>> -		*addr = 50;
>> -
>> -		/* This message is printed if no SIGSEGV */
>> -		tst_resm(TFAIL, "process succeeds to refer unmapped "
>> -			 "memory region");
>> -		cleanup();
>> -
>> +	if (sig == SIGSEGV) {
>> +		sig_flag = 1;
>> +		siglongjmp(env, 1);
>>   	}
>> -	tst_exit();
>> -}
>> -
>> -#else
>> -
>> -int main(void)
>> -{
>> -	tst_resm(TINFO, "munmap02 test is not available on uClinux");
>> -	tst_exit();
>>   }
>>   -#endif /* ifndef UCLINUX */
>> -
>> -/*
>> - * setup() - performs all ONE TIME setup for this test.
>> - * Setup signal handler to catch SIGSEGV.
>> - * Get system page size, create a temporary file for reading/writing,
>> - * write one byte data into it, map the open file for the specified
>> - * map length.
>> - */
>> -void setup(void)
>> +static void setup(void)
>>   {
>> +	SAFE_SIGNAL(SIGSEGV, sig_handler);
>>   -	tst_sig(NOFORK, DEF_HANDLER, cleanup);
>> -
>> -	/* call signal function to trap the signal generated */
>> -	if (signal(SIGSEGV, sig_handler) == SIG_ERR) {
>> -		tst_brkm(TBROK, cleanup, "signal fails to catch signal");
>> -	}
>> -
>> -	TEST_PAUSE;
>> -
>> -	/* Get the system page size */
>>   	page_sz = getpagesize();
>> +	map_len = page_sz * 3;
>>   -	/*
>> -	 * Get the length of the open file to be mapped into process
>> -	 * address space.
>> -	 */
>> -	map_len = 3 * page_sz;
>> -
>> -	tst_tmpdir();
>> +	fd = SAFE_OPEN(TEMPFILE, O_RDWR | O_CREAT, 0666);
>> +	SAFE_LSEEK(fd, map_len, SEEK_SET);
>> +	SAFE_WRITE(SAFE_WRITE_ALL, fd, "a", 1);
>> +}
>>   -	/* Creat a temporary file used for mapping */
>> -	if ((fildes = open(TEMPFILE, O_RDWR | O_CREAT, 0666)) < 0) {
>> -		tst_brkm(TBROK, cleanup, "open() on %s Failed, errno=%d : %s",
>> -			 TEMPFILE, errno, strerror(errno));
>> -	}
>> +static void run(void)
>> +{
>> +	addr1 = SAFE_MMAP(NULL, map_len, PROT_READ | PROT_WRITE, MAP_FILE | MAP_SHARED, fd, 0);
>>   -	/*
>> -	 * move the file pointer to maplength position from the beginning
>> -	 * of the file.
>> -	 */
>> -	SAFE_LSEEK(cleanup, fildes, map_len, SEEK_SET);
>> +	addr2 = (char *)((long)addr1 + page_sz);
>> +	map_len = page_sz * 2;
>>   -	/* Write one byte into temporary file */
>> -	if (write(fildes, "a", 1) != 1) {
>> -		tst_brkm(TBROK, cleanup, "write() on %s Failed, errno=%d : %s",
>> -			 TEMPFILE, errno, strerror(errno));
>> -	}
>> +	TST_EXP_PASS(munmap(addr2, map_len));
>> +	if (TST_RET == -1)
>> +		return;
>>   -	/*
>> -	 * map the open file 'TEMPFILE' from its beginning up to the maplength
>> -	 * into the calling process's address space at the system choosen
>> -	 * with read/write permissions to the the mapped region.
>> -	 */
>> -#ifdef UCLINUX
>> -	/* mmap() doesn't support MAP_SHARED on uClinux */
>> -	addr = mmap(0, map_len, PROT_READ | PROT_WRITE,
>> -		    MAP_FILE | MAP_PRIVATE, fildes, 0);
>> -#else
>> -	addr = mmap(0, map_len, PROT_READ | PROT_WRITE,
>> -		    MAP_FILE | MAP_SHARED, fildes, 0);
>> -#endif
>> +	if (sigsetjmp(env, 1) == 0)
>> +		*addr2 = 50;
>>   -	/* check for the return value of mmap system call */
>> -	if (addr == (char *)MAP_FAILED) {
>> -		tst_brkm(TBROK, cleanup, "mmap() Failed on %s, errno=%d : %s",
>> -			 TEMPFILE, errno, strerror(errno));
>> -	}
>> +	if (sig_flag == 1)
>> +		tst_res(TPASS, "Received SIGSEGV signal");
>> +	else
>> +		tst_res(TFAIL, "SIGSEGV signal not received");
>>   -	/*
>> -	 * increment the start address of the region at which the file is
>> -	 * mapped to a maplength of 3 times the system page size by the value
>> -	 * of system  page size and decrement the maplength value by the value
>> -	 * of system page size.
>> -	 */
>> -	addr = (char *)((long)addr + page_sz);
>> -	map_len = map_len - page_sz;
>> +	SAFE_MUNMAP(addr1, page_sz);
>> +	map_len = page_sz * 3;
>> +	sig_flag = 0;
>>   }
>>   -/*
>> - * void
>> - * sig_handler() - signal catching function.
>> - *   This function is used to trap the signal generated when tried to read or
>> - *   write to the memory mapped region which is already detached from the
>> - *   calling process address space.
>> - *   this function is invoked when SIGSEGV generated and it calls test
>> - *   cleanup function and exit the program.
>> - */
>> -void sig_handler(void)
>> +static void cleanup(void)
>>   {
>> -	tst_resm(TPASS, "Functionality of munmap() successful");
>> -
>> -	/* Invoke test cleanup function and exit */
>> -	cleanup();
>> -
>> -	tst_exit();
>> +	if (fd > 0)
>> +		SAFE_CLOSE(fd);
>>   }
>>   -/*
>> - * cleanup() - performs all ONE TIME cleanup for this test at
>> - *             completion or premature exit.
>> - *  Unmap the portion of the region of the file left unmapped.
>> - *  Close the temporary file.
>> - *  Remove the temporary directory.
>> - */
>> -void cleanup(void)
>> -{
>> -
>> -	/*
>> -	 * get the start address and length of the portion of
>> -	 * the mapped region of the file.
>> -	 */
>> -	addr = (char *)((long)addr - page_sz);
>> -	map_len = map_len - page_sz;
>> -
>> -	/* unmap the portion of the region of the file left unmapped */
>> -	SAFE_MUNMAP(NULL, addr, map_len);
>> -
>> -	/* Close the temporary file */
>> -	SAFE_CLOSE(NULL, fildes);
>> -
>> -	tst_rmdir();
>> -}
>> +static struct tst_test test = {
>> +	.setup = setup,
>> +	.cleanup = cleanup,
>> +	.test_all = run,
>> +	.needs_tmpdir = 1
>> +};


-- 
Thank you,
Richard.

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

Re: [LTP] [PATCH 2/2] syscalls/munmap02: Refactor the test using new LTP API

[Avinesh Kumar]

On Tuesday, November 14, 2023 9:37:16 AM CET Richard Palethorpe wrote:
> Hello,
> 
> Andrea Cervesato via ltp <ltp@lists.linux.it> writes:
> > Hi!
> > 
> > munmap01 and munmap02 looks quite similar. The refactoring is good to
> > me, but maybe we can merge them into a single test using 2 different
> > test cases, where the first is mapping a certain portion of the file
> > and the second an another.
> 
> Yes, these should be merged. Otherwise the rewrite looks good.
> 

Hi,

sorry for not responding to this review earlier.
But may I request for merging these patches if the refactoring is fine. I agree 
that these both should be combined to single test, and I would like to do 
that, but maybe in the second step after upcoming release.

Thank you,
Avinesh



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