Updated xfs-interface

Author: arun-joseph

.gitignore

@@ -8,6 +8,8 @@ disk.xfs
 *.txt
 *.tmp
 *.dSYM
+*.vscode/
+.DS_Store
 temp*
 test
 inodetable.txt

AUTHORS

@@ -1,9 +1,9 @@
  Current Maintainers
 ----------------------------------
-        K Muralikrishnan 				[email protected]
+    K Muralikrishnan 				[email protected]
 	Shamil CM						[email protected]
 	Sreeraj S	 					[email protected]
-	Vivek Anand T Kallampally	[email protected]
+	Vivek Anand T Kallampally	    [email protected]
 
 
  Contributors
@@ -14,7 +14,7 @@
 	Deepak Goyal 
 	Jeril K Goerge
 	K Dinesh 
-        K Muralikrishnan
+    K Muralikrishnan
 	Mathew Kumpalamthanam 
 	Naseem Iqbal 
 	Nitish Kumar 

LICENSE

@@ -1,33 +1,11 @@
-#Our compiler.
 CC = gcc
 CFLAGS = -g
 LDFLAGS = -lreadline
-#Default rule.
 
 default: xfs-interface
 
 xfs-interface: *.c *.h
 	$(CC) $(CFLAGS) *.c -o xfs-interface $(LDFLAGS)
-#xfs-interface: labels.o diskUtility.o inode.o interface.o fileSystem.o exception.o
-#	$(CC) $(CFLAGS) -o xfs-interface  labels.o diskUtility.o inode.o interface.o fileSystem.o exception.o $(LDFLAGS)
-
-#diskUtility.o: diskUtility.c diskUtility.h exception.h
-#	$(CC) $(CFLAGS) -c diskUtility.c
-
-#exception.o: exception.c exception.h
-#	$(CC) $(CFLAGS) -c exception.c
-
-#fileSystem.o: fileSystem.c fileSystem.h memOrg.h inode.h diskUtility.h constants.h
-#	$(CC) $(CFLAGS) -c fileSystem.c
-
-#inode.o: inode.c inode.h
-#	$(CC) $(CFLAGS) -c inode.c
-
-#interface.o: interface.c interface.h inode.h diskUtility.h fileSystem.h
-#	$(CC) $(CFLAGS) -c interface.c
-
-#labels.o: labels.c labels.h
-#	$(CC) $(CFLAGS) -c labels.c
 
 clean:
 	$(RM) xfs-interface *.o disk.xfs rootfile.txt inodeusertable.txt

Makefile

@@ -0,0 +1,19 @@
+XFS Interface
+=============
+
+**Introduction** : XFS (eXperimental File System) Interface is an external interface to access the file system of the eXpOS. The filesystem is simulated on a binary file called ”disk.xfs”. The interface can format the disk, load/remove files, list files and copy blocks to a UNIX file.
+
+Prerequisites :
+-------------
+	• GCC (GNU project C and C++ compiler)
+	• libreadline-dev (readline library for command completion)
+
+Compiling and Running :
+---------------------
+Run the following commands to compile and run the XFS interface:
+1. `make`
+2. `./xfs-interface`
+
+Commands :
+--------
+Type `help` in the interface to display the list of commands.

README

@@ -1,31 +1,18 @@
-#ifndef _XSM_CONSTANTS_H
+#ifndef XFS_CONSTANTS_H
 
-#define _XSM_CONSTANTS_H
+#define XFS_CONSTANTS_H
 
 #include <stdbool.h>
 
 #define XSM_WORD_SIZE 16
 #define XSM_MEMORY_NUMPAGES 128
 #define XSM_PAGE_SIZE 512
 
-#define XSM_REGSIZE XSM_WORD_SIZE
-#define XSM_NUM_REG 33
-
-#define XSM_ILLINSTR -1
-
-#define XSM_SUCCESS 1
-#define XSM_FAILURE 0
+#define XFS_SUCCESS 0
+#define XFS_FAILURE -1
 
 #define XSM_INSTRUCTION_SIZE 2
 
-/* Disk states. */
-#define XSM_DISK_IDLE 0
-#define XSM_DISK_BUSY 1
-
-/* Console states. */
-#define XSM_CONSOLE_IDLE 0
-#define XSM_CONSOLE_BUSY 1
-
 #ifndef TRUE
 #define TRUE 1
 #endif
@@ -34,10 +21,4 @@
 #define FALSE 0
 #endif
 
-/* Interrupts */
-#define XSM_INTERRUPT_EXCEPTION 0
-#define XSM_INTERRUPT_TIMER 1
-#define XSM_INTERRUPT_DISK 2
-#define XSM_INTERRUPT_CONSOLE 3
-
 #endif

README.md

@@ -1,77 +1,69 @@
+/*
+Interface to access disk file.
+*/
+
 #include "disk.h"
-#include "exception.h"
+
 #include <fcntl.h>
 #include <stdlib.h>
 #include <unistd.h>
 #include <sys/types.h>
 
-BLOCK* disk;
+BLOCK *disk;
 
-/*
- This function reads an entire BLOCK from the address specified from fileBlockNumber on the disk file to virtBlockNumber on the memory copy of the disk.
-*/
-int readFromDisk(int virtBlockNumber, int fileBlockNumber) {
-	int fd;
-	fd = openDiskFile(O_RDONLY);
-	lseek(fd,sizeof (BLOCK)*fileBlockNumber,SEEK_SET);
-	read(fd,&disk[virtBlockNumber],sizeof (BLOCK));
-	close(fd);
-	return 0;
+/* Reads an entire block from fileBlockNumber on the disk to virtBlockNumber on the memory copy of the disk */
+int readFromDisk(int virtBlockNumber, int fileBlockNumber)
+{
+    int fd = openDiskFile(O_RDONLY);
+
+    lseek(fd, sizeof(BLOCK) * fileBlockNumber, SEEK_SET);
+    read(fd, &disk[virtBlockNumber], sizeof(BLOCK));
+    close(fd);
+
+    return XFS_SUCCESS;
 }
 
+/* Writes an entire block to fileBlocknumber on the disk from virtBlockNumber on the memory copy of the disk */
+int writeToDisk(int virtBlockNumber, int fileBlockNumber)
+{
+    int fd = openDiskFile(O_WRONLY);
 
-/*
-  This function writes an entire block to fileBlocknumber on the disk file from virtBlockNumber on the memory copy of the disk.
-*/
-int writeToDisk(int virtBlockNumber, int fileBlockNumber) {
-	int fd;
-	fd = openDiskFile(O_WRONLY);
-	lseek(fd,0,SEEK_SET);
-	lseek(fd,sizeof (BLOCK)*fileBlockNumber,SEEK_CUR);
-	write(fd,&disk[virtBlockNumber],sizeof (BLOCK));
-	close(fd);	
-	return 0;
+    lseek(fd, 0, SEEK_SET);
+    lseek(fd, sizeof(BLOCK) * fileBlockNumber, SEEK_CUR);
+    write(fd, &disk[virtBlockNumber], sizeof(BLOCK));
+    close(fd);
+
+    return XFS_SUCCESS;
 }
 
-/*
-	Opens the disk file returns the file descriptor
-	if it fails, throws an exception and transfers control to the interface
-*/
+/* Opens the disk file and returns the file descriptor */
 int openDiskFile(int access)
 {
-	int fd;
-	fd = open(DISK_NAME, access, 0666);
-	if(fd < 0){
-	  exception_throwException(EXCEPTION_CANT_OPEN_DISK);
-	}
-	return fd;
+    int fd = open(DISK_NAME, access, 0666);
+    if (fd < 0)
+        exception_throwException(EXCEPTION_CANT_OPEN_DISK);
+
+    return fd;
 }
 
-/*
-	Creates the disk file
-	Arguments: format) disk is formatted if its value is DISK_FORMAT
-	if it fails, throws an exception and transfers control to the interface
-*/
+/* Creates the disk file */
 void createDiskFile(int format)
 {
-	int fd;
+    int fd;
+
+    if (format == DISK_FORMAT)
+        fd = open(DISK_NAME, O_CREAT | O_TRUNC | O_SYNC, 0666);
+    else
+        fd = open(DISK_NAME, O_CREAT, 0666);
 
-	if(format==DISK_FORMAT)
-		fd = open(DISK_NAME, O_CREAT | O_TRUNC | O_SYNC, 0666);
-	else
-		fd = open(DISK_NAME, O_CREAT, 0666);
+    if (fd < 0)
+        exception_throwException(EXCEPTION_CANT_CREATE_DISK);
 
-	if(fd < 0){
-	  exception_throwException(EXCEPTION_CANT_CREATE_DISK);
-	}
-	close(fd);
+    close(fd);
 }
 
-/*
-	Tries to open the disk file, throws an exception if it fails.
-	An exception returns the control to the jmppoint set in interface.c
-*/
+/* Tries to open the disk */
 void diskCheckFileExists()
 {
-	close(openDiskFile(O_RDONLY));
-}
+    close(openDiskFile(O_RDONLY));
+}

constants.h

@@ -1,17 +1,19 @@
-#ifndef DISK_H
-#define DISK_H
+#ifndef XFS_DISK_H
+
+#define XFS_DISK_H
 
 #include "fileSystem.h"
+#include "exception.h"
 
-#define DISK_NAME 	"disk.xfs"
-#define BOOT_BLOCK	0
+#define DISK_NAME "disk.xfs"
 
 #define DISK_NO_FORMAT 0
 #define DISK_FORMAT 1
 
-typedef struct{
-	char word[BLOCK_SIZE][WORD_SIZE];
-}BLOCK;
+typedef struct
+{
+    char word[BLOCK_SIZE][WORD_SIZE];
+} BLOCK;
 
 int readFromDisk(int virtBlockNumber, int fileBlockNumber);
 int writeToDisk(int virtBlockNumber, int fileBlockNumber);