even more fixmes/features
[nestedvm.git] / src / org / ibex / nestedvm / Runtime.java
index a745084..fc97e71 100644 (file)
@@ -8,14 +8,11 @@ import org.ibex.nestedvm.util.*;
 import java.io.*;
 import java.util.Arrays;
 
-// FEATURE: Look over the public API, make sure we're exposing a bare minimum
-// (we might make this an interface in the future)
-
 public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
     /** Number of bits to shift to get the page number (1<<<pageShift == pageSize) */
     protected final int pageShift;
     /** Bottom of region of memory allocated to the stack */
-    protected final int stackBottom;
+    private final int stackBottom;
     
     /** Readable main memory pages */
     protected int[][] readPages;
@@ -73,7 +70,7 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
     boolean closeOnExec[] = new boolean[OPEN_MAX];
     
     /** Pointer to a SecurityManager for this process */
-    protected SecurityManager sm;
+    SecurityManager sm;
     public void setSecurityManager(SecurityManager sm) { this.sm = sm; }
     
     /** Pointer to a callback for the call_java syscall */
@@ -84,7 +81,7 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
     private byte[] _byteBuf;
     /** Max size of temporary buffer
         @see Runtime#_byteBuf */
-    private final static int MAX_CHUNK = 16*1024*1024 - 1024;
+    final static int MAX_CHUNK = 16*1024*1024 - 1024;
         
     /** Subclasses should actually execute program in this method. They should continue 
         executing until state != RUNNING. Only syscall() can modify state. It is safe 
@@ -295,7 +292,6 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
     public final void memcpy(int dst, int src, int count) throws FaultException {
         int pageWords = (1<<pageShift)>>>2;
         int pageWordMask = pageWords - 1;
-        
         if((dst&3) == 0 && (src&3)==0) {
             if((count&~3) != 0) {
                 int c = count>>2;
@@ -456,7 +452,7 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
         return start;
     }
     
-    protected String[] createEnv(String[] extra) { if(extra == null) extra = new String[0]; return extra; }
+    String[] createEnv(String[] extra) { if(extra == null) extra = new String[0]; return extra; }
     
     /** Sets word number <i>index</i> in the _user_info table to <i>word</i>
      * The user_info table is a chunk of memory in the program's memory defined by the
@@ -506,7 +502,7 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
         return state != PAUSED;
     }
     
-    protected static String[] concatArgv(String argv0, String[] rest) {
+    static String[] concatArgv(String argv0, String[] rest) {
            String[] argv = new String[rest.length+1];
            System.arraycopy(rest,0,argv,1,rest.length);
         argv[0] = argv0;
@@ -564,7 +560,7 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
     }
     
     /** Hook for subclasses to do their own startup */
-    protected void _started() {  }
+    void _started() {  }
     
     public final int call(String sym, Object[] args) throws CallException, FaultException {
         if(state != PAUSED && state != CALLJAVA) throw new IllegalStateException("call() called in inappropriate state");
@@ -651,18 +647,11 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
         
         return cpustate.r[V1];
     }
-    
-    /** Determines if the process can access <i>fileName</i>. The default implementation simply logs 
-        the request and allows it */
-    protected boolean allowFileAccess(String fileName, boolean write) {
-        //System.err.println("Allowing " + (write?"write":"read-only") + " access to " + fileName);
-        return true;
-    }
-    
+        
     /** Allocated an entry in the FileDescriptor table for <i>fd</i> and returns the number.
         Returns -1 if the table is full. This can be used by subclasses to use custom file
         descriptors */
-    public int addFD(FD fd) {
+    public final int addFD(FD fd) {
         if(state == EXITED || state == EXECED) throw new IllegalStateException("addFD called in inappropriate state");
         int i;
         for(i=0;i<OPEN_MAX;i++) if(fds[i] == null) break;
@@ -673,7 +662,7 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
     }
 
     /** Closes file descriptor <i>fdn</i> and removes it from the file descriptor table */
-    public boolean closeFD(int fdn) {
+    public final boolean closeFD(int fdn) {
         if(state == EXITED || state == EXECED) throw new IllegalStateException("closeFD called in inappropriate state");
         if(fdn < 0 || fdn >= OPEN_MAX) return false;
         if(fds[fdn] == null) return false;
@@ -683,7 +672,7 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
     }
     
     /** Duplicates the file descriptor <i>fdn</i> and returns the new fs */
-    public int dupFD(int fdn) {
+    public final int dupFD(int fdn) {
                int i;
                if(fdn < 0 || fdn >= OPEN_MAX) return -1;
                if(fds[fdn] == null) return -1;
@@ -703,12 +692,12 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
     public static final int O_TRUNC = 0x0400;
     public static final int O_NONBLOCK = 0x4000;
     
-    FD hostFSOpen(final File f, int flags, int mode) throws ErrnoException {
+    FD hostFSOpen(final File f, int flags, int mode, final Object data) throws ErrnoException {
         if((flags & ~(3|O_CREAT|O_EXCL|O_APPEND|O_TRUNC)) != 0) {
             System.err.println("WARNING: Unsupported flags passed to open(): " + toHex(flags & ~(3|O_CREAT|O_EXCL|O_APPEND|O_TRUNC)));
             throw new ErrnoException(ENOTSUP);
         }
-        boolean write = mode!=RD_ONLY;
+        boolean write = (flags&3) != RD_ONLY;
 
         if(sm != null && !(write ? sm.allowWrite(f) : sm.allowRead(f))) throw new ErrnoException(EACCES);
         
@@ -722,7 +711,7 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
         } else if(!f.exists()) {
             if((flags&O_CREAT)==0) return null;
         } else if(f.isDirectory()) {
-            return hostFSDirFD(f);
+            return hostFSDirFD(f,data);
         }
         
         final Seekable.File sf;
@@ -733,14 +722,15 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
             return null;
         } catch(IOException e) { throw new ErrnoException(EIO); }
         
-        return new SeekableFD(sf,flags) { protected FStat _fstat() { return hostFStat(f); } };
+        return new SeekableFD(sf,flags) { protected FStat _fstat() { return hostFStat(f,data); } };
     }
     
-    FStat hostFStat(File f) { return new HostFStat(f); }
-    FD hostFSDirFD(File f) { return null; }
+    FStat hostFStat(File f, Object data) { return new HostFStat(f); }
+    
+    FD hostFSDirFD(File f, Object data) { return null; }
     
     FD _open(String path, int flags, int mode) throws ErrnoException {
-        return hostFSOpen(new File(path),flags,mode);
+        return hostFSOpen(new File(path),flags,mode,null);
     }
     
     /** The open syscall */
@@ -753,34 +743,26 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
     }
 
     /** The write syscall */
-    private int sys_write(int fdn, int addr, int count) throws FaultException {
+    
+    // FIXME: Handle pipe closed exception
+    private int sys_write(int fdn, int addr, int count) throws FaultException, ErrnoException {
         count = Math.min(count,MAX_CHUNK);
         if(fdn < 0 || fdn >= OPEN_MAX) return -EBADFD;
-        if(fds[fdn] == null || !fds[fdn].writable()) return -EBADFD;
-        try {
-            byte[] buf = byteBuf(count);
-            copyin(addr,buf,count);
-            return fds[fdn].write(buf,0,count);
-        } catch(IOException e) {
-            // NOTE: This should really send a SIGPIPE
-            if(e.getMessage().equals("Pipe closed")) return sys_exit(128+13);
-            return -EIO;
-        }
+        if(fds[fdn] == null) return -EBADFD;
+        byte[] buf = byteBuf(count);
+        copyin(addr,buf,count);
+        return fds[fdn].write(buf,0,count);
     }
 
     /** The read syscall */
-    private int sys_read(int fdn, int addr, int count) throws FaultException {
+    private int sys_read(int fdn, int addr, int count) throws FaultException, ErrnoException {
         count = Math.min(count,MAX_CHUNK);
         if(fdn < 0 || fdn >= OPEN_MAX) return -EBADFD;
-        if(fds[fdn] == null || !fds[fdn].readable()) return -EBADFD;
-        try {
-            byte[] buf = byteBuf(count);
-            int n = fds[fdn].read(buf,0,count);
-            copyout(buf,addr,n);
-            return n;
-        } catch(IOException e) {
-            return -EIO;
-        }
+        if(fds[fdn] == null) return -EBADFD;
+        byte[] buf = byteBuf(count);
+        int n = fds[fdn].read(buf,0,count);
+        copyout(buf,addr,n);
+        return n;
     }
     
     /** The close syscall */
@@ -790,16 +772,12 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
 
     
     /** The seek syscall */
-    private int sys_lseek(int fdn, int offset, int whence) {
+    private int sys_lseek(int fdn, int offset, int whence) throws ErrnoException {
         if(fdn < 0 || fdn >= OPEN_MAX) return -EBADFD;
         if(fds[fdn] == null) return -EBADFD;
         if(whence != SEEK_SET && whence !=  SEEK_CUR && whence !=  SEEK_END) return -EINVAL;
-        try {
-            int n = fds[fdn].seek(offset,whence);
-            return n < 0 ? -ESPIPE : n;
-        } catch(IOException e) {
-            return -ESPIPE;
-        }
+        int n = fds[fdn].seek(offset,whence);
+        return n < 0 ? -ESPIPE : n;
     }
     
     /** The stat/fstat syscall helper */
@@ -893,7 +871,7 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
     
     /** The sbrk syscall. This can also be used by subclasses to allocate memory.
         <i>incr</i> is how much to increase the break by */
-    public int sbrk(int incr) {
+    public final int sbrk(int incr) {
         if(incr < 0) return -ENOMEM;
         if(incr==0) return heapEnd;
         incr = (incr+3)&~3;
@@ -919,7 +897,7 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
 
     /** The getpid syscall */
     private int sys_getpid() { return getPid(); }
-    protected int getPid() { return 1; }
+    int getPid() { return 1; }
     
     public static interface CallJavaCB { public int call(int a, int b, int c, int d); }
     
@@ -950,15 +928,8 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
     
     private int sys_getpagesize() { return writePages.length == 1 ? 4096 : (1<<pageShift); }
     
-    private int sys_isatty(int fdn) {
-        if(fdn < 0 || fdn >= OPEN_MAX) return -EBADFD;
-        if(fds[fdn] == null) return -EBADFD;
-        return fds[fdn].isatty() ? 1 : 0;
-    }
-
-    
     /** Hook for subclasses to do something when the process exits  */
-    protected void _exited() {  }
+    void _exited() {  }
     
     private int sys_exit(int status) {
         exitStatus = status;
@@ -983,10 +954,7 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
                 fds[i] = fd.dup();
                 return 0;
             case F_GETFL:
-                int flags = 0;
-                if(fd.writable() && fd.readable())  flags = 2;
-                else if(fd.writable()) flags = 1;
-                return flags;
+                return fd.flags();
             case F_SETFD:
                    closeOnExec[fdn] = arg != 0;
                 return 0;
@@ -1035,9 +1003,11 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
             case SYS_sleep: return sys_sleep(a);
             case SYS_times: return sys_times(a);
             case SYS_getpagesize: return sys_getpagesize();
-            case SYS_isatty: return sys_isatty(a);
             case SYS_fcntl: return sys_fcntl(a,b,c);
             case SYS_sysconf: return sys_sysconf(a);
+            
+            case SYS_memcpy: memcpy(a,b,c); return a;
+            case SYS_memset: memset(a,b,c); return a;
 
             case SYS_kill:
             case SYS_fork:
@@ -1081,7 +1051,7 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
     }
     
     /** Helper function to read a cstring from main memory */
-    public String cstring(int addr) throws ReadFaultException {
+    public final String cstring(int addr) throws ReadFaultException {
         StringBuffer sb = new StringBuffer();
         for(;;) {
             int word = memRead(addr&~3);
@@ -1097,28 +1067,23 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
     /** File Descriptor class */
     public static abstract class FD {
         private int refCount = 1;
-    
-        /** returns true if the fd is readable */
-        public boolean readable() { return false; }
-        /** returns true if the fd is writable */
-        public boolean writable() { return false; }
         
         /** Read some bytes. Should return the number of bytes read, 0 on EOF, or throw an IOException on error */
-        public int read(byte[] a, int off, int length) throws IOException { throw new IOException("no definition"); }
+        public int read(byte[] a, int off, int length) throws ErrnoException { throw new ErrnoException(EBADFD); }
         /** Write. Should return the number of bytes written or throw an IOException on error */
-        public int write(byte[] a, int off, int length) throws IOException { throw new IOException("no definition"); }
+        public int write(byte[] a, int off, int length) throws ErrnoException { throw new ErrnoException(EBADFD); }
 
         /** Seek in the filedescriptor. Whence is SEEK_SET, SEEK_CUR, or SEEK_END. Should return -1 on error or the new position. */
-        public int seek(int n, int whence)  throws IOException  { return -1; }
+        public int seek(int n, int whence)  throws ErrnoException  { return -1; }
+        
+        public int getdents(byte[] a, int off, int length) throws ErrnoException { throw new ErrnoException(EBADFD); }
+        
+        public int flags() { return O_RDONLY; }
         
         /** Return a Seekable object representing this file descriptor (can be read only) 
             This is required for exec() */
         Seekable seekable() { return null; }
         
-        /** Should return true if this is a tty */
-        // FEATURE: get rid of the isatty syscall and just do with newlib's dumb isatty.c
-        public boolean isatty() { return false; }
-        
         private FStat cachedFStat = null;
         public final FStat fstat() {
             if(cachedFStat == null) cachedFStat = _fstat(); 
@@ -1138,35 +1103,48 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
     public abstract static class SeekableFD extends FD {
         private final int flags;
         private final Seekable data;
-        public boolean readable() { return (flags&3) != WR_ONLY; }
-        public boolean writable() { return (flags&3) != RD_ONLY; }
         
         SeekableFD(Seekable data, int flags) { this.data = data; this.flags = flags; }
         
         protected abstract FStat _fstat();
+        public int flags() { return flags; }
 
         Seekable seekable() { return data; }
         
-        public int seek(int n, int whence) throws IOException {
-            switch(whence) {
-                case SEEK_SET: break;
-                case SEEK_CUR: n += data.pos(); break;
-                case SEEK_END: n += data.length(); break;
-                default: return -1;
+        public int seek(int n, int whence) throws ErrnoException {
+            try {
+                   switch(whence) {
+                           case SEEK_SET: break;
+                           case SEEK_CUR: n += data.pos(); break;
+                           case SEEK_END: n += data.length(); break;
+                           default: return -1;
+                   }
+                   data.seek(n);
+                   return n;
+            } catch(IOException e) {
+                   throw new ErrnoException(ESPIPE);
             }
-            data.seek(n);
-            return n;
         }
         
-        public int write(byte[] a, int off, int length) throws IOException {
+        public int write(byte[] a, int off, int length) throws ErrnoException {
+            if((flags&3) == RD_ONLY) throw new ErrnoException(EBADFD);
             // NOTE: There is race condition here but we can't fix it in pure java
             if((flags&O_APPEND) != 0) seek(0,SEEK_END);
-            return data.write(a,off,length);
+            try {
+                   return data.write(a,off,length);
+            } catch(IOException e) {
+                   throw new ErrnoException(EIO);
+            }
         }
         
-        public int read(byte[] a, int off, int length) throws IOException {
-            int n = data.read(a,off,length);
-            return n < 0 ? 0 : n;
+        public int read(byte[] a, int off, int length) throws ErrnoException {
+            if((flags&3) == WR_ONLY) throw new ErrnoException(EBADFD);
+            try {
+                   int n = data.read(a,off,length);
+                   return n < 0 ? 0 : n;
+            } catch(IOException e) {
+                   throw new ErrnoException(EIO);
+            }
         }
         
         protected void _close() { try { data.close(); } catch(IOException e) { /*ignore*/ } }        
@@ -1174,33 +1152,46 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
     
     public static class OutputStreamFD extends FD {
         private OutputStream os;
-        public boolean writable() { return true; }
+        public int flags() { return O_WRONLY; }
         public OutputStreamFD(OutputStream os) { this.os = os; }
-        public int write(byte[] a, int off, int length) throws IOException { os.write(a,off,length); return length; }
+        public int write(byte[] a, int off, int length) throws ErrnoException {
+            try {
+                   os.write(a,off,length);
+                   return length;
+            } catch(IOException e) {
+                   throw new ErrnoException(EIO);
+            }
+        }
         public void _close() { try { os.close(); } catch(IOException e) { /*ignore*/ }  }
         public FStat _fstat() { return new FStat(); }
     }
     
     public static class InputStreamFD extends FD {
         private InputStream is;
-        public boolean readable() { return true; }
+        public int flags() { return O_RDONLY; }
         public InputStreamFD(InputStream is) { this.is = is; }
-        public int read(byte[] a, int off, int length) throws IOException { int n = is.read(a,off,length); return n < 0 ? 0 : n; }
+        public int read(byte[] a, int off, int length) throws ErrnoException {
+            try {
+                int n = is.read(a,off,length);
+                return n < 0 ? 0 : n;
+            } catch(IOException e) {
+                throw new ErrnoException(EIO);
+            }
+        }
         public void _close() { try { is.close(); } catch(IOException e) { /*ignore*/ } }
         public FStat _fstat() { return new FStat(); }
     }
     
-    protected static class StdinFD extends InputStreamFD {
+    static class StdinFD extends InputStreamFD {
         public StdinFD(InputStream is) { super(is); }
         public void _close() { /* noop */ }
         public FStat _fstat() { return new FStat() { public int type() { return S_IFCHR; } }; }
-        public boolean isatty() { return true; }
     }
-    protected static class StdoutFD extends OutputStreamFD {
+    
+    static class StdoutFD extends OutputStreamFD {
         public StdoutFD(OutputStream os) { super(os); }
         public void _close() { /* noop */ }
         public FStat _fstat() { return new FStat() { public int type() { return S_IFCHR; } }; }
-        public boolean isatty() { return true; }
     }
     
     public static class FStat {
@@ -1209,9 +1200,8 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
         public static final int S_IFDIR = 0040000;
         public static final int S_IFREG = 0100000;
         
-        public int dev() { return -1; }
-        // FEATURE: inode numbers are calculated inconsistently throught the runtime
-        public int inode() { return hashCode() & 0xfffff; }
+        public int dev() { return 1; }
+        public int inode() { return hashCode() & 0x7fff; }
         public int mode() { return 0; }
         public int type() { return S_IFIFO; }
         public int nlink() { return 0; }
@@ -1225,12 +1215,13 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
         public int blocks() { return (size()+blksize()-1)/blksize(); }        
     }
     
-    protected static class HostFStat extends FStat {
+    static class HostFStat extends FStat {
         private final File f;
         private final boolean executable; 
-        public HostFStat(File f) {
+        public HostFStat(File f) { this(f,false); }
+        public HostFStat(File f, boolean executable) {
             this.f = f;
-            executable = executable();
+            this.executable = executable;
         }
         public int dev() { return 1; }
         public int inode() { return f.getName().hashCode() & 0xffff; }
@@ -1245,21 +1236,21 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
             return mode;
         }
         public int size() { return (int) f.length(); }
-        public int mtime() { return (int)(f.lastModified()/1000); }
-        
-        boolean executable() { return false; }
+        public int mtime() { return (int)(f.lastModified()/1000); }        
     }
     
     // Exceptions
-    public class ReadFaultException extends FaultException {
+    public static class ReadFaultException extends FaultException {
         public ReadFaultException(int addr) { super(addr); }
     }
-    public class WriteFaultException extends FaultException {
+    public static class WriteFaultException extends FaultException {
         public WriteFaultException(int addr) { super(addr); }
     }
-    public abstract class FaultException extends ExecutionException {
-        public int addr;
-        public FaultException(int addr) { super("fault at: " + toHex(addr)); this.addr = addr; }
+    public static class FaultException extends ExecutionException {
+        public final int addr;
+        public final RuntimeException cause;
+        public FaultException(int addr) { super("fault at: " + toHex(addr)); this.addr = addr; cause = null; }
+        public FaultException(RuntimeException e) { super(e.toString()); addr = -1; cause = e; }
     }
     public static class ExecutionException extends Exception {
         private String message = "(null)";
@@ -1316,14 +1307,14 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
     }
     
     // Utility functions
-    private byte[] byteBuf(int size) {
+    byte[] byteBuf(int size) {
         if(_byteBuf==null) _byteBuf = new byte[size];
         else if(_byteBuf.length < size)
             _byteBuf = new byte[min(max(_byteBuf.length*2,size),MAX_CHUNK)];
         return _byteBuf;
     }
     
-    protected static String getSystemProperty(String key) {
+    static String getSystemProperty(String key) {
         try {
             return System.getProperty(key);
         } catch(SecurityException e) {
@@ -1348,7 +1339,7 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
         return buf;
     }
     
-    protected static byte[] getBytes(String s) {
+    static byte[] getBytes(String s) {
         try {
             return s.getBytes("ISO-8859-1");
         } catch(UnsupportedEncodingException e) {
@@ -1356,7 +1347,7 @@ public abstract class Runtime implements UsermodeConstants,Registers,Cloneable {
         }
     }
     
-    protected final static String toHex(int n) { return "0x" + Long.toString(n & 0xffffffffL, 16); }
-    protected final static int min(int a, int b) { return a < b ? a : b; }
-    protected final static int max(int a, int b) { return a > b ? a : b; }
+    final static String toHex(int n) { return "0x" + Long.toString(n & 0xffffffffL, 16); }
+    final static int min(int a, int b) { return a < b ? a : b; }
+    final static int max(int a, int b) { return a > b ? a : b; }
 }