             The STARFISH Parallel file-system simulator
       (Simulation Tool for Advanced Research in File Systems)

                              David Kotz
                          Dartmouth College
                             Version 2.0
                             January 1995
                         dfk@cs.dartmouth.edu

This directory contains the source code for my parallel file-system
simulator, and associated stuff.  See ../README for more information,
and rules about using and copying this code.

This code can be found 
via ftp at cs.dartmouth.edu in pub/pario/STARFISH 
via the WWW at http://www.cs.dartmouth.edu/cs_archive/STARFISH.html

WARNING: 
--------
 I AM PROVIDING THE CODE AS-IS, WITH LITTLE CLEANUP OR ADDED
DOCUMENTATION.  SOME OF THE CODE IS OUT-OF-DATE AND HAS BUGS.  OTHER
PARTS ARE INCOMPLETE.  MANY OF THE ANALYSIS SCRIPTS ARE FRAGILE.  THE
CODE IS CONSTANTLY EVOLVING, AND NEW PUBLIC RELEASES MAY BE RARE.

 IN PARTICULAR, please note that some of the comments in the code are
out of date, especially paragraph comments.  Sorry about that. 

 ALSO, PLEASE NOTE that the code included here has evolved since the
experiments in some of my papers were run; in particular, the OSDI
results are based on an earlier, buggier version of iopfs-cache.
See the TR version of that paper for correct results, which are based
on very nearly the version I include here.

Description of the files: see ./FILES
-------------------------

Structure of the code:  see ./STRUCTURE
----------------------

Compiling the code:
-------------------
Do not execute 'make' directly; run it as 'domake test' in the current
directory.  Expect several warning messages, mostly having to do with
variables that don't get used.  They do; it depends on the #defines. 

Configuring the parameters:
---------------------------
Run config (a proteus program) from ./test.  That's where all the
compiling and test-executing of proteus happens.

dmcache:  You may note references to 'dmcache' in several places.
-------   That's the old name for this simulator. 
