Skip to contentSkip to conversation

syscalls/mmap05: Rewrite the test using new LTP API

PATCH In review Avinesh Kumar 2 participants 6 messages Aug 24, 2023 – Aug 30, 2023

lore
Share & tools
lore
#0 lore raw

PATCH 1/3 syscalls/mmap05: Rewrite the test using new LTP API

old test had the condition of file descriptor being opened only in readonly mode, but to test SIGSEGV signal with PROT_NONE, file descriptor does not need to be opened with readonly mode, I changed the test to use file descriptor which is open with read-write mode.

PS: usage of SAFE_CALLOC is based on the patch sent earlier[1]

[1] https://lore.kernel.org/ltp/[email protected]/

---
 testcases/kernel/syscalls/mmap/mmap05.c | 223 ++++++------------------
 1 file changed, 51 insertions(+), 172 deletions(-)
testcases/kernel/syscalls/mmap/mmap05.c +51 -172
index 82f122543..35e8b47ef 100644
@@ -1,205 +1,84 @@
+// 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
+ *  07/2001 Ported by Wayne Boyer
+ * Copyright (c) 2023 SUSE LLC Avinesh Kumar <[email protected]>
  */
 
-/*
- * Test Description:
- *  Call mmap() to map a file creating mapped memory with no access under
- *  the following conditions -
- *	- The prot parameter is set to PROT_NONE
- *	- The file descriptor is open for read(any mode other than write)
- *	- The minimum file permissions should be 0444.
- *
- *  The call should succeed to map the file creating mapped memory with the
- *  required attributes.
- *
- * Expected Result:
- *  mmap() should succeed returning the address of the mapped region,
- *  and an attempt to access the contents of the mapped region should give
- *  rise to the signal SIGSEGV.
+/*\
+ * [Description]
  *
- * HISTORY
- *	07/2001 Ported by Wayne Boyer
+ * Verify that, mmap() call with 'PROT_NONE' and a file descriptor which is
+ * open for read and write, succeeds to map the file creating mapped memory,
+ * but any attempt to access the contents of the mapped region causes the
+ * SIGSEGV signal.
  */
-#include <stdio.h>
+
 #include <stdlib.h>
-#include <sys/types.h>
-#include <errno.h>
-#include <unistd.h>
-#include <fcntl.h>
-#include <string.h>
-#include <signal.h>
-#include <sys/stat.h>
-#include <sys/mman.h>
 #include <setjmp.h>
+#include "tst_test.h"
 
-#include "test.h"
-
-#define TEMPFILE	"mmapfile"
-
-char *TCID = "mmap05";
-int TST_TOTAL = 1;
-
+#define TEMPFILE "mmapfile"
 static size_t page_sz;
 static volatile char *addr;
-static int fildes;
-static volatile int pass = 0;
+static int fd;
+static volatile int sig_flag;
 static sigjmp_buf env;
 
-static void setup(void);
-static void cleanup(void);
-static void sig_handler(int sig);
-
-int main(int ac, char **av)
+static void sig_handler(int sig)
 {
-	int lc;
-	char file_content;
-
-	tst_parse_opts(ac, av, NULL, NULL);
-
-	setup();
-
-	for (lc = 0; TEST_LOOPING(lc); lc++) {
-
-		tst_count = 0;
-
-		/*
-		 * Call mmap to map the temporary file 'TEMPFILE'
-		 * with no access.
-		 */
-		errno = 0;
-		addr = mmap(0, page_sz, PROT_NONE,
-			    MAP_FILE | MAP_SHARED, fildes, 0);
-		TEST_ERRNO = errno;
-
-		/* Check for the return value of mmap() */
-		if (addr == MAP_FAILED) {
-			tst_resm(TFAIL | TERRNO, "mmap() failed on %s",
-				 TEMPFILE);
-			continue;
-		}
-
-		/*
-		 * Try to access the mapped region.  This should
-		 * generate a SIGSEGV which will be caught below.
-		 *
-		 * This is wrapped by the sigsetjmp() call that will
-		 * take care of restoring the program's context in an
-		 * elegant way in conjunction with the call to
-		 * siglongjmp() in the signal handler.
-		 */
-		if (sigsetjmp(env, 1) == 0) {
-			file_content = addr[0];
-		}
-
-		if (pass) {
-			tst_resm(TPASS, "Got SIGSEGV as expected");
-		} else {
-			tst_resm(TFAIL, "Mapped memory region with NO "
-				 "access is accessible");
-		}
-
-		/* Unmap mapped memory and reset pass in case we are looping */
-		if (munmap((void *)addr, page_sz) != 0) {
-			tst_brkm(TFAIL | TERRNO, cleanup, "munmap failed");
-		}
-		pass = 0;
-
-	}
-
-	cleanup();
-	tst_exit();
+	if (sig == SIGSEGV) {
+		sig_flag = 1;
+		siglongjmp(env, 1);
+	} else
+		tst_brk(TBROK, "Received an unexpected signal: %d", sig);
 }
 
 static void setup(void)
 {
-	char *tst_buff;
-
-	tst_sig(NOFORK, sig_handler, cleanup);
+	char *buf;
 
-	TEST_PAUSE;
+	SAFE_SIGNAL(SIGSEGV, sig_handler);
 
 	page_sz = getpagesize();
+	buf = SAFE_CALLOC(page_sz, sizeof(char));
+	memset(buf, 'A', page_sz);
 
-	/* Allocate space for the test buffer */
-	if ((tst_buff = calloc(page_sz, sizeof(char))) == NULL) {
-		tst_brkm(TFAIL, NULL, "calloc failed (tst_buff)");
-	}
-
-	/* Fill the test buffer with the known data */
-	memset(tst_buff, 'A', page_sz);
-
-	tst_tmpdir();
-
-	/* Creat a temporary file used for mapping */
-	if ((fildes = open(TEMPFILE, O_WRONLY | O_CREAT, 0666)) < 0) {
-		free(tst_buff);
-		tst_brkm(TFAIL | TERRNO, cleanup, "opening %s failed",
-			 TEMPFILE);
-	}
+	fd = SAFE_OPEN(TEMPFILE, O_RDWR | O_CREAT, 0666);
+	SAFE_WRITE(SAFE_WRITE_ALL, fd, buf, page_sz);
+	free(buf);
+}
 
-	/* Write test buffer contents into temporary file */
-	if (write(fildes, tst_buff, page_sz) != (int)page_sz) {
-		free(tst_buff);
-		tst_brkm(TFAIL, cleanup, "writing to %s failed", TEMPFILE);
+static void run(void)
+{
+	addr = mmap(0, page_sz, PROT_NONE, MAP_FILE | MAP_SHARED, fd, 0);
+	if (addr == MAP_FAILED) {
+		tst_res(TFAIL | TERRNO, "mmap() of %s failed", TEMPFILE);
+		return;
 	}
 
-	/* Free the memory allocated for test buffer */
-	free(tst_buff);
+	if (sigsetjmp(env, 1) == 0)
+		tst_res(TINFO, "Trying to access mapped region: %c", addr[0]);
 
-	/* Make sure proper permissions set on file */
-	if (fchmod(fildes, 0444) < 0) {
-		tst_brkm(TFAIL | TERRNO, cleanup, "fchmod of %s failed",
-			 TEMPFILE);
-	}
+	if (sig_flag)
+		tst_res(TPASS, "Received SIGSEGV signal as expected");
+	else
+		tst_res(TFAIL, "SIGSEGV signal not received");
 
-	/* Close the temporary file opened for write */
-	if (close(fildes) < 0) {
-		tst_brkm(TFAIL | TERRNO, cleanup, "closing %s failed",
-			 TEMPFILE);
-	}
+	SAFE_MUNMAP((char *)addr, page_sz);
 
-	/* Open the temporary file again for reading */
-	if ((fildes = open(TEMPFILE, O_RDONLY)) < 0) {
-		tst_brkm(TFAIL | TERRNO, cleanup, "opening %s readonly failed",
-			 TEMPFILE);
-	}
-}
-
-/*
- * sig_handler() - Signal Catching function.
- *   This function gets executed when the test process receives
- *   the signal SIGSEGV while trying to access the contents of memory which
- *   is not accessible.
- */
-static void sig_handler(int sig)
-{
-	if (sig == SIGSEGV) {
-		/* set the global variable and jump back */
-		pass = 1;
-		siglongjmp(env, 1);
-	} else {
-		tst_brkm(TBROK, cleanup, "received an unexpected signal: %d",
-			 sig);
-	}
+	sig_flag = 0;
 }
 
 static void cleanup(void)
 {
-	close(fildes);
-	tst_rmdir();
+	if (fd > 0)
+		SAFE_CLOSE(fd);
 }
+
+static struct tst_test test = {
+	.setup = setup,
+	.cleanup = cleanup,
+	.test_all = run,
+	.needs_tmpdir = 1
+};
Signature · 5 lines
2.41.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#1 lore raw

PATCH 2/3 syscalls/mmap06: Refactor and add scenarios for EACCES test

As mmap() should always result in EACCES when a file mapping is requested but the file descriptor is not open for reading, I've added few possible combinations for prot and flags arguments to test for EACCES.

---
 testcases/kernel/syscalls/mmap/mmap06.c | 171 +++++++-----------------
 1 file changed, 51 insertions(+), 120 deletions(-)
testcases/kernel/syscalls/mmap/mmap06.c +51 -120
index fb7c49257..05e0ffc69 100644
@@ -1,143 +1,74 @@
+// 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
+ *  07/2001 Ported by Wayne Boyer
+ * Copyright (c) 2023 SUSE LLC Avinesh Kumar <[email protected]>
  */
 
-/*
- * Test Description:
- *  Call mmap() to map a file creating a mapped region with read access
- *  under the following conditions -
- *	- The prot parameter is set to PROT_READ
- *	- The file descriptor is open for writing.
+/*\
+ * [Description]
  *
- *  The call should fail to map the file.
- *
- * Expected Result:
- *  mmap() should fail returning -1 and errno should get set to EACCES.
- *
- * HISTORY
- *	07/2001 Ported by Wayne Boyer
+ * Verify that, mmap() call fails when a file mapping is requested but the
+ * file descriptor is not open for reading, and errno is set to EACCES.
  */
-#include <stdio.h>
-#include <stdlib.h>
-#include <sys/types.h>
-#include <errno.h>
-#include <unistd.h>
-#include <fcntl.h>
-#include <string.h>
-#include <signal.h>
-#include <sys/stat.h>
-#include <sys/mman.h>
 
-#include "test.h"
-
-#define TEMPFILE	"mmapfile"
-
-char *TCID = "mmap06";
-int TST_TOTAL = 1;
+#include <stdlib.h>
+#include "tst_test.h"
 
+#define TEMPFILE "mmapfile"
 static size_t page_sz;
-static char *addr;
-static int fildes;
-
-static void setup(void);
-static void cleanup(void);
-
-int main(int ac, char **av)
-{
-	int lc;
-
-	tst_parse_opts(ac, av, NULL, NULL);
-
-	setup();
-
-	for (lc = 0; TEST_LOOPING(lc); lc++) {
-
-		tst_count = 0;
-
-		/*
-		 * Call mmap to map the temporary file 'TEMPFILE'
-		 * with read access.
-		 */
-		errno = 0;
-		addr = mmap(0, page_sz, PROT_READ,
-			    MAP_FILE | MAP_SHARED, fildes, 0);
-		TEST_ERRNO = errno;
-
-		/* Check for the return value of mmap() */
-		if (addr != MAP_FAILED) {
-			tst_resm(TFAIL | TERRNO,
-				 "mmap() returned invalid value, expected: %p",
-				 MAP_FAILED);
-			/* Unmap the mapped memory */
-			if (munmap(addr, page_sz) != 0) {
-				tst_resm(TBROK, "munmap() failed");
-				cleanup();
-			}
-			continue;
-		}
-		if (TEST_ERRNO == EACCES) {
-			tst_resm(TPASS, "mmap failed with EACCES");
-		} else {
-			tst_resm(TFAIL | TERRNO,
-				 "mmap failed with unexpected errno");
-		}
-	}
-	cleanup();
-	tst_exit();
-
-}
+static int fd;
+
+static struct tcase {
+	int prot;
+	int flags;
+} tcases[] = {
+	{PROT_WRITE, MAP_FILE | MAP_PRIVATE},
+	{PROT_WRITE, MAP_FILE | MAP_SHARED},
+	{PROT_READ, MAP_FILE | MAP_PRIVATE},
+	{PROT_READ, MAP_FILE | MAP_SHARED},
+	{PROT_READ | PROT_WRITE, MAP_FILE | MAP_PRIVATE},
+	{PROT_READ | PROT_WRITE, MAP_FILE | MAP_SHARED}
+};
 
 static void setup(void)
 {
-	char *tst_buff;
-
-	tst_sig(NOFORK, DEF_HANDLER, cleanup);
-
-	TEST_PAUSE;
+	char *buf;
 
 	page_sz = getpagesize();
+	buf = SAFE_CALLOC(page_sz, sizeof(char));
+	memset(buf, 'A', page_sz);
 
-	/* Allocate space for the test buffer */
-	if ((tst_buff = calloc(page_sz, sizeof(char))) == NULL) {
-		tst_brkm(TFAIL, NULL, "calloc() failed (tst_buff)");
-	}
-
-	/* Fill the test buffer with the known data */
-	memset(tst_buff, 'A', page_sz);
-
-	tst_tmpdir();
+	fd = SAFE_OPEN(TEMPFILE, O_WRONLY | O_CREAT, 0666);
+	SAFE_WRITE(SAFE_WRITE_ALL, fd, buf, page_sz);
+	free(buf);
+}
 
-	/* Creat a temporary file used for mapping */
-	if ((fildes = open(TEMPFILE, O_WRONLY | O_CREAT, 0666)) < 0) {
-		free(tst_buff);
-		tst_brkm(TFAIL, cleanup, "opening %s failed", TEMPFILE);
-	}
+static void run(unsigned int i)
+{
+	struct tcase *tc = &tcases[i];
 
-	/* Write test buffer contents into temporary file */
-	if (write(fildes, tst_buff, page_sz) < (ssize_t)page_sz) {
-		free(tst_buff);
-		tst_brkm(TFAIL, cleanup, "writing to %s failed", TEMPFILE);
-	}
+	TESTPTR(mmap(0, page_sz, tc->prot, tc->flags, fd, 0));
 
-	free(tst_buff);
+	if (TST_RET_PTR != MAP_FAILED) {
+		tst_res(TFAIL | TERRNO, "mmap() was successful unexpectedly");
+		SAFE_MUNMAP(TST_RET_PTR, page_sz);
+	} else if (TST_ERR == EACCES)
+		tst_res(TPASS, "mmap() failed with errno EACCES");
+	else
+		tst_res(TFAIL | TERRNO, "mmap() failed but unexpected errno");
 }
 
 static void cleanup(void)
 {
-	close(fildes);
-	tst_rmdir();
+	if (fd > 0)
+		SAFE_CLOSE(fd);
 }
+
+static struct tst_test test = {
+	.setup = setup,
+	.cleanup = cleanup,
+	.test = run,
+	.tcnt = ARRAY_SIZE(tcases),
+	.needs_tmpdir = 1
+};
Signature · 5 lines
2.41.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#2 lore raw

Re: [LTP] [PATCH 2/3] syscalls/mmap06: Refactor and add scenarios for EACCES test

Hi!
Pushed with minor changes, thanks.

- sizeof(char) == 1 again
- first mmap() parameter is pointer, hence should be NULL
- there is no point in printing the TERRNO if mmap() succeeded
- LKML coding style prefers curly braces around else block if they are around the if block

testcases/kernel/syscalls/mmap/mmap06.c +6 -5
index 05e0ffc69..012e7de41 100644
@@ -36,7 +36,7 @@ static void setup(void)
 	char *buf;
 
 	page_sz = getpagesize();
-	buf = SAFE_CALLOC(page_sz, sizeof(char));
+	buf = SAFE_MALLOC(page_sz);
 	memset(buf, 'A', page_sz);
 
 	fd = SAFE_OPEN(TEMPFILE, O_WRONLY | O_CREAT, 0666);
@@ -48,15 +48,16 @@ static void run(unsigned int i)
 {
 	struct tcase *tc = &tcases[i];
 
-	TESTPTR(mmap(0, page_sz, tc->prot, tc->flags, fd, 0));
+	TESTPTR(mmap(NULL, page_sz, tc->prot, tc->flags, fd, 0));
 
 	if (TST_RET_PTR != MAP_FAILED) {
-		tst_res(TFAIL | TERRNO, "mmap() was successful unexpectedly");
+		tst_res(TFAIL, "mmap() was successful unexpectedly");
 		SAFE_MUNMAP(TST_RET_PTR, page_sz);
-	} else if (TST_ERR == EACCES)
+	} else if (TST_ERR == EACCES) {
 		tst_res(TPASS, "mmap() failed with errno EACCES");
-	else
+	} else {
 		tst_res(TFAIL | TERRNO, "mmap() failed but unexpected errno");
+	}
 }
 
 static void cleanup(void)
Signature · 5 lines
Cyril Hrubis
[email protected]

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#3 lore raw

PATCH 3/3 syscalls/mmap07: Remove the test

In reply to Avinesh Kumar

As we are testing for EACCES in this test also when file descriptor is not open for reading, I have moved this scenario to mmap06.c along with other EACCES tests, so I guess it's safe to remove this one.

---
 runtest/syscalls                          |   1 -
 testcases/kernel/syscalls/mmap/.gitignore |   1 -
 testcases/kernel/syscalls/mmap/mmap07.c   | 146 ----------------------
 3 files changed, 148 deletions(-)
 delete mode 100644 testcases/kernel/syscalls/mmap/mmap07.c
runtest/syscalls +0 -1
index 1028e45fc..4bacb4017 100644
@@ -785,7 +785,6 @@ mmap03 mmap03
 mmap04 mmap04
 mmap05 mmap05
 mmap06 mmap06
-mmap07 mmap07
 mmap08 mmap08
 mmap09 mmap09
 mmap12 mmap12
testcases/kernel/syscalls/mmap/.gitignore +0 -1
index 569a76ac1..4591fdbb9 100644
@@ -5,7 +5,6 @@
 /mmap04
 /mmap05
 /mmap06
-/mmap07
 /mmap08
 /mmap09
 /mmap10
testcases/kernel/syscalls/mmap/mmap07.c deleted +0 -146

146 lines not on this page · raw message

Signature · 5 lines
2.41.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#4 lore raw

Re: [LTP] [PATCH 3/3] syscalls/mmap07: Remove the test

Hi!
Pushed, thanks.

Signature · 5 lines
Cyril Hrubis
[email protected]

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#5 lore raw
In reply to Avinesh Kumar

Hi!
Pushed with two minor changes, thanks.

testcases/kernel/syscalls/mmap/mmap05.c line 34

Quoted 7 lines
testcases/kernel/syscalls/mmap/mmap05.c +6 -0
+static void sig_handler(int sig)
 {
+	if (sig == SIGSEGV) {
+		sig_flag = 1;
+		siglongjmp(env, 1);
+	} else
+		tst_brk(TBROK, "Received an unexpected signal: %d", sig);

I've removed this else branch since tst_brk() unlike tst_res() is not async-signal-safe since tst_brk() calls exit.

Quoted 4 lines

}

static void setup(void)
{

testcases/kernel/syscalls/mmap/mmap05.c line 44

Quoted 10 lines
testcases/kernel/syscalls/mmap/mmap05.c +3 -4
-	char *tst_buff;
-
-	tst_sig(NOFORK, sig_handler, cleanup);
+	char *buf;
 
-	TEST_PAUSE;
+	SAFE_SIGNAL(SIGSEGV, sig_handler);
 
 	page_sz = getpagesize();
+	buf = SAFE_CALLOC(page_sz, sizeof(char));

And changed this to SAFE_MALLOC(page_sz); since sizeof(char) == 1 by definition.

Signature · 5 lines
Cyril Hrubis
[email protected]

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