Merge pull request #16 from OmSaran/posix_test

Changes to support using posix test suite on SplitFS

Author: vijay03

Makefile

@@ -0,0 +1,14 @@
+all:
+	@echo Nothing here
+
+test: 
+	@echo "============================ Executing Posix Mode ============================"
+	$(MAKE) -C tests pjd.posix
+	@echo "============================ Finished Posix Mode ============================="
+	@echo "============================ Executing Sync Mode ============================="
+	$(MAKE) -C tests pjd.sync
+	@echo "============================ Finished Sync Mode =============================="
+	@echo "============================ Executing Strict Mode ==========================="
+	$(MAKE) -C tests pjd.strict
+	@echo "============================ Finished Strict Mode ============================"
+

README.md

@@ -27,7 +27,7 @@ $ cd splitfs; make clean; make; cd .. # Compile SplitFS
 $ export LD_LIBRARY_PATH=./splitfs
 $ export NVP_TREE_FILE=./splitfs/bin/nvp_nvp.tree
 ```
-4. <b>Set up ext4-DAX </b>
+4. #### Set up ext4-DAX 
 ```
 $ sudo mkfs.ext4 -b 4096 /dev/pmem0
 $ sudo mount -o dax /dev/pmem0 /mnt/pmem_emul
@@ -100,6 +100,31 @@ SplitFS is under active development.
 1. The current implementation of SplitFS handles the following system calls: `open, openat, close, read, pread64, write, pwrite64, fsync, unlink, ftruncate, fallocate, stat, fstat, lstat, dup, dup2, execve and clone`. The rest of the calls are passed through to the kernel.
 2. The current implementation of SplitFS works correctly for the following applictions: `LevelDB running YCSB, SQLite running TPCC, tar, git, rsync`. This limitation is purely due to the state of the implementation, and we aim to increase the coverage of applications by supporting more system calls in the future.
 
+## Testing
+[PJD POSIX Test Suite](https://www.tuxera.com/community/posix-test-suite/) that tests primarily the metadata operations was run on SplitFS and yielded the following result.  
+Tests Passed: 1944 out of a total of 1957.  
+Tests that failed include: 
+1. Tests on `link` (tests 56-58, 63-65 in links/00.t)
+2. Tests on `rename` (tests 49, 53, 57, 61 in rename/00.t)
+3. Tests on `unlink` (tests 17, 22, 53 in in unlink/00.t)  
+
+We aim to to improve this to a 100% pass rate soon.
+
+**Running the Test Suite**  
+Before running the tests, make sure you have [set-up ext4-DAX](#set-up-ext4-DAX)  
+
+To run tests in all modes:  
+```
+$ make test
+```
+To run tests in a specific mode:
+```
+$ make -C tests pjd.<mode>
+```
+where `<mode>` is one of `posix`, `sync` or `strict`.  Example: `make -C tests pjd.posix`  
+
+Tip: Redirect stderr for less verbose output: e.g `make test 2>/dev/null`
+
 ## License
 
 Copyright for SplitFS is held by the University of Texas at Austin. Please contact us if you would like to obtain a license to use SplitFS in your commercial product.

splitfs/fileops_hub.c

@@ -363,9 +363,6 @@ int hub_check_resolve_fileops(char* tree)
 	{
 		_hub_fd_lookup[i] = _hub_fileops;
 	}
-	_hub_fd_lookup[0] = _hub_managed_fileops;
-	_hub_fd_lookup[1] = _hub_managed_fileops;
-	_hub_fd_lookup[2] = _hub_managed_fileops;
 
 	return 0;
 }
@@ -815,6 +812,8 @@ RETT_OPENAT _hub_OPENAT(INTF_OPENAT)
 }
 
 RETT_EXECVE _hub_EXECVE(INTF_EXECVE) {
+	int pid = getpid();
+	char exec_hub_filename[BUF_SIZE];
 
         HUB_CHECK_RESOLVE_FILEOPS(_hub_, EXECVE);
 
@@ -832,7 +831,8 @@ RETT_EXECVE _hub_EXECVE(INTF_EXECVE) {
 			hub_ops[i] = 2;
 	}
 
-        exec_hub_fd = shm_open("exec-hub", O_RDWR | O_CREAT, S_IRUSR | S_IWUSR);
+        sprintf(exec_hub_filename, "exec-hub-%d", pid);
+        exec_hub_fd = shm_open(exec_hub_filename, O_RDWR | O_CREAT, S_IRUSR | S_IWUSR);
         if (exec_hub_fd == -1) {
 		printf("%s: %s\n", __func__, strerror(errno));
 		assert(0);
@@ -864,6 +864,8 @@ RETT_EXECVE _hub_EXECVE(INTF_EXECVE) {
 }
 
 RETT_EXECVP _hub_EXECVP(INTF_EXECVP) {
+	int pid = getpid();
+	char exec_hub_filename[BUF_SIZE];
 
 	HUB_CHECK_RESOLVE_FILEOPS(_hub_, EXECVP);
 
@@ -881,13 +883,14 @@ RETT_EXECVP _hub_EXECVP(INTF_EXECVP) {
 			hub_ops[i] = 2;
 	}
 
-	exec_hub_fd = shm_open("exec-hub", O_RDWR | O_CREAT, S_IRUSR | S_IWUSR);
+	sprintf(exec_hub_filename, "exec-hub-%d", pid);
+	exec_hub_fd = shm_open(exec_hub_filename, O_RDWR | O_CREAT, S_IRUSR | S_IWUSR);
 	if (exec_hub_fd == -1) {
 		printf("%s: %s\n", __func__, strerror(errno));
 		assert(0);
 	}
 
-	int res = _hub_managed_fileops->FTRUNC64(exec_hub_fd, (1024*1024));
+	int res = _hub_fileops->FTRUNC64(exec_hub_fd, (1024*1024));
 	if (res == -1) {
 		printf("%s: ftruncate failed. Err = %s\n", __func__, strerror(errno));
 		assert(0);
@@ -918,8 +921,11 @@ RETT_SHM_COPY _hub_SHM_COPY() {
 	int exec_hub_fd = -1, i = 0;
 	int hub_ops[1024];
 	unsigned long offset_in_map = 0;
+	int pid = getpid();
+	char exec_hub_filename[BUF_SIZE];
 
-	exec_hub_fd = shm_open("exec-hub", O_RDONLY, 0666);
+	sprintf(exec_hub_filename, "exec-hub-%d", pid);
+	exec_hub_fd = shm_open(exec_hub_filename, O_RDONLY, 0666);
 	if (exec_hub_fd == -1) {
 		MSG("%s: %s\n", __func__, strerror(errno));
 		assert(0);
@@ -946,7 +952,7 @@ RETT_SHM_COPY _hub_SHM_COPY() {
 	}
 
         munmap(shm_area, 1024*1024);
-	shm_unlink("exec-hub");
+	shm_unlink(exec_hub_filename);
 
 	return _hub_managed_fileops->SHM_COPY();
 }
@@ -1101,16 +1107,18 @@ RETT_CLOSE _hub_CLOSE(INTF_CLOSE)
 	DEBUG("_hub_CLOSE is calling %s->CLOSE\n", _hub_fd_lookup[file]->name);
 
 	struct Fileops_p* temp = _hub_fd_lookup[file];
-	_hub_fd_lookup[file] = NULL;
+
+	// Restore it to the state similar to the initialised state.
+	_hub_fd_lookup[file] = _hub_fileops;
 	int result = temp->CLOSE(CALL_CLOSE);
 
 	if(result) {
 		DEBUG("call to %s->CLOSE failed: %s\n", _hub_fileops->name, strerror(errno));
-		return 0;
+		return result;
 	}
 
 	DEBUG_FILE("%s: Return = %d\n", __func__, result);
-	return 0;
+	return result;
 }
 
 #ifdef TRACE_FP_CALLS				
@@ -1225,12 +1233,6 @@ RETT_DUP2 _hub_DUP2(INTF_DUP2)
 	else
 	{ 
 		DEBUG("DUP2 call completed successfully.\n");
-		
-		if(result != fd2)
-		{
-			DEBUG("_hub_DUP2: result!=fd2 (%i != %i), so let's update the table...\n", result, fd2);
-			_hub_fd_lookup[fd2] = NULL;
-		}
 
 		DEBUG("Hub(dup2) managing new FD %i with same ops (\"%s\") as initial FD (%i)\n",
 			result, _hub_fd_lookup[file]->name, file);
@@ -1479,3 +1481,4 @@ RETT_CLONE _hub_CLONE(INTF_CLONE)
 */
 
 // breaking the build
+

splitfs/fileops_nvp.c

@@ -1021,8 +1021,11 @@ void _nvp_SHM_COPY() {
         int exec_ledger_fd = -1;
 	int i,j;
 	unsigned long offset_in_map = 0;
-	
-	exec_ledger_fd = shm_open("exec-ledger", O_RDONLY, 0666);
+	int pid = getpid();
+	char exec_nvp_filename[BUF_SIZE];
+
+	sprintf(exec_nvp_filename, "exec-ledger-%d", pid);
+	exec_ledger_fd = shm_open(exec_nvp_filename, O_RDONLY, 0666);
 
 	if (exec_ledger_fd == -1) {
 		printf("%s: shm_open failed. Err = %s\n", __func__, strerror(errno));
@@ -1096,7 +1099,7 @@ void _nvp_SHM_COPY() {
 	}
 
 	munmap(shm_area, 10*1024*1024);
-	shm_unlink("exec-ledger");
+	shm_unlink(exec_nvp_filename);
 }
 
 void _mm_cache_flush(void const* p) {
@@ -1244,13 +1247,11 @@ void _nvp_init2(void)
 		if (!_nvp_node_lookup[i])
 			assert(0);
 
-#if WORKLOAD_TAR | WORKLOAD_GIT | WORKLOAD_RSYNC
 		_nvp_backup_roots[i] = (struct backupRoots*)calloc(OPEN_MAX,
 								   sizeof(struct backupRoots));
 		if (!_nvp_backup_roots[i])
 			assert(0);
 
-#endif	// WORKLOAD_TAR
 
 		memset((void *)_nvp_node_lookup[i], 0, OPEN_MAX * sizeof(struct NVNode));	
 		// Allocating and initializing all the dynamic structs inside struct NVNode 
@@ -1276,11 +1277,9 @@ void _nvp_init2(void)
 			// Allocating and Initializing DR root of the node
 			memset((void *)&_nvp_node_lookup[i][j].dr_info, 0, sizeof(struct free_dr_pool));
 
-#if WORKLOAD_TAR | WORKLOAD_GIT | WORKLOAD_RSYNC
 			_nvp_backup_roots[i][j].root = _nvp_node_lookup[i][j].root;
 			_nvp_backup_roots[i][j].merkle_root = _nvp_node_lookup[i][j].merkle_root;
 			_nvp_backup_roots[i][j].root_dirty_cache = _nvp_node_lookup[i][j].root_dirty_cache;
-#endif // WORKLOAD_TAR
 
 		}
 	}
@@ -1555,15 +1554,15 @@ void _nvp_init2(void)
 	*/
 	atexit(nvp_exit_handler);
 
-#if WORKLOAD_TAR | WORKLOAD_GIT | WORKLOAD_RSYNC
+	int pid = getpid();
+	char exec_nvp_filename[BUF_SIZE];
 
-	if (access("/dev/shm/exec-ledger", F_OK ) != -1) 
+	sprintf(exec_nvp_filename, "/dev/shm/exec-ledger-%d", pid);
+	if (access(exec_nvp_filename, F_OK ) != -1)
 		execv_done = 1;
 	else
 		execv_done = 0;
 
-#endif // WORKLOAD_TAR
-
 }
 
 void nvp_transfer_to_free_dr_pool(struct NVNode *node)
@@ -4744,6 +4743,8 @@ RETT_EXECVE _nvp_EXECVE(INTF_EXECVE) {
 
 	int exec_ledger_fd = -1, i = 0;
 	unsigned long offset_in_map = 0;
+	int pid = getpid();
+	char exec_nvp_filename[BUF_SIZE];
 
 	for (i = 0; i < 1024; i++) {
 		if (_nvp_fd_lookup[i].offset != NULL)
@@ -4752,7 +4753,8 @@ RETT_EXECVE _nvp_EXECVE(INTF_EXECVE) {
 			execve_fd_passing[i] = 0;
 	}
 
-	exec_ledger_fd = shm_open("exec-ledger", O_RDWR | O_CREAT, S_IRUSR | S_IWUSR);
+	sprintf(exec_nvp_filename, "exec-ledger-%d", pid);
+	exec_ledger_fd = shm_open(exec_nvp_filename, O_RDWR | O_CREAT, S_IRUSR | S_IWUSR);
 	if (exec_ledger_fd == -1) {
 		printf("%s: %s\n", __func__, strerror(errno));
 		assert(0);
@@ -4813,6 +4815,8 @@ RETT_EXECVP _nvp_EXECVP(INTF_EXECVP) {
 
 	int exec_ledger_fd = -1, i = 0;
 	unsigned long offset_in_map = 0;
+	int pid = getpid();
+	char exec_nvp_filename[BUF_SIZE];
 
 	for (i = 0; i < 1024; i++) {
 		if (_nvp_fd_lookup[i].offset != NULL)
@@ -4825,8 +4829,9 @@ RETT_EXECVP _nvp_EXECVP(INTF_EXECVP) {
 		if (_nvp_fd_lookup[i].node != NULL && _nvp_fd_lookup[i].valid)
 			_nvp_FSYNC(_nvp_fd_lookup[i].fd);
 	}
-		
-	exec_ledger_fd = shm_open("exec-ledger", O_RDWR | O_CREAT, S_IRUSR | S_IWUSR);
+	
+	sprintf(exec_nvp_filename, "exec-ledger-%d", pid);
+	exec_ledger_fd = shm_open(exec_nvp_filename, O_RDWR | O_CREAT, S_IRUSR | S_IWUSR);
 	if (exec_ledger_fd == -1) {
 		printf("%s: %s\n", __func__, strerror(errno));
 		assert(0);
@@ -5911,6 +5916,9 @@ RETT_DUP2 _nvp_DUP2(INTF_DUP2)
 	nvf2->node = nvf->node;
 	nvf2->valid = nvf->valid;
 	nvf2->posix = nvf->posix;
+	// Increment the refernce count as this file 
+	// descriptor is pointing to the same NVFNode
+	nvf2->node->reference++;
 
 	SANITYCHECK(nvf2->node != NULL);
 	SANITYCHECK(nvf2->valid);
@@ -6541,3 +6549,4 @@ RETT_FALLOCATE _nvp_FALLOCATE(INTF_FALLOCATE)
 	return result;
 }
 */
+

splitfs/nv_common.h

@@ -32,6 +32,8 @@
 #include "boost/preprocessor/seq/for_each.hpp"
 //#include "boost/preprocessor/cat.hpp"
 
+#define BUF_SIZE 40
+
 #define MIN(X,Y) (((X)<(Y))?(X):(Y))
 #define MAX(X,Y) (((X)>(Y))?(X):(Y))
 

tests/Makefile

@@ -0,0 +1,49 @@
+# Run tests for splitfs
+
+# The current working directory
+CWD=$(shell pwd)
+# Root of the repo
+ROOT=$(CWD)/..
+# SplitFS path
+SFS_PATH=/mnt/pmem_emul/
+# PJD Dir
+PJD_DIR=$(CWD)/pjd-fstest-20080816
+
+all: pjd.posix pjd.sync pjd.strict
+
+# Compile with posix specific flags
+pjd.posix_compile: 
+	export LEDGER_DATAJ=0 && \
+    export LEDGER_POSIX=1 && \
+    $(MAKE) -C ../splitfs clean && \
+    $(MAKE) -e -C ../splitfs
+
+# Compile with sync specific flags
+pjd.sync_compile:
+	export LEDGER_DATAJ=0 && \
+    export LEDGER_POSIX=0 && \
+    $(MAKE) -C ../splitfs clean && \
+    $(MAKE) -e -C ../splitfs
+
+# Compile with strict specific flags
+pjd.strict_compile:
+	export LEDGER_DATAJ=1 && \
+    export LEDGER_POSIX=0 && \
+    $(MAKE) -C ../splitfs clean && \
+    $(MAKE) -e -C ../splitfs
+
+pjd.compile:
+	$(MAKE) -C $(PJD_DIR) clean
+	$(MAKE) -C $(PJD_DIR)
+
+pjd.run:
+	export LD_LIBRARY_PATH=$(ROOT)/splitfs; \
+		export NVP_TREE_FILE=$(ROOT)/splitfs/bin/nvp_nvp.tree; \
+		export LD_PRELOAD=$(ROOT)/splitfs/libnvp.so; \
+		cd $(SFS_PATH) && prove -r $(PJD_DIR)/tests
+
+pjd.posix: pjd.posix_compile pjd.compile pjd.run
+
+pjd.sync: pjd.sync_compile pjd.compile pjd.run
+
+pjd.strict: pjd.strict_compile pjd.compile pjd.run

tests/pjd-fstest-20080816/LICENSE

@@ -0,0 +1,27 @@
+$FreeBSD: src/tools/regression/fstest/LICENSE,v 1.1 2007/01/17 01:42:07 pjd Exp $
+
+License for all regression tests available with fstest:
+
+Copyright (c) 2006-2007 Pawel Jakub Dawidek <[email protected]>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

tests/pjd-fstest-20080816/Makefile

@@ -0,0 +1,15 @@
+# $FreeBSD: src/tools/regression/fstest/Makefile,v 1.1 2007/01/17 01:42:07 pjd Exp $
+
+#CFLAGS+=-DHAS_LCHMOD
+#CFLAGS+=-DHAS_CHFLAGS
+#CFLAGS+=-DHAS_LCHFLAGS
+#CFLAGS+=-DHAS_TRUNCATE64
+#CFLAGS+=-DHAS_STAT64
+
+all:	fstest
+
+fstest:	fstest.c
+	gcc -Wall ${CFLAGS} fstest.c -o fstest
+
+clean:
+	rm -f fstest