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

                              David Kotz
                          Dartmouth College
                             Version 2.0
                             January 1995

This directory contains my parallel file-system simulator, and
associated stuff.  I have used this simulator in experiments for
several research papers (see PAPERS.bib), and am actively extending it
and using it for further experiments.

This package 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.

See other warnings in the src/README file.

USAGE RULES:
------------
 You're welcome to look at the code and even try to run it, but I
really don't have time to help you out much.  If you publish any
results based on this simulator, please cite me and provide the URL
where people can find this code.

COPYING RULES: 
--------------
 This package may be freely copied as long as it is kept intact with
my name on it.  Please send me a note if you have a copy of this code,
so I can keep track of how many copies there are, send you email about
new versions, and so forth.  Please ask me before you distribute any
modified version. 

Other software you need:
------------------------
 This package is based on Proteus version 3.01.  You can get that from
ftp to mintaka.lcs.mit.edu:/pub/brewer in proteus-V3.01.tar.Z.  I have
fixed several bugs in the 'stats' program; I supply a MIPS executable
of the fixed program, and the patches needed to make my version from
the original Eric Brewer sources.  You can find those sources at the
same ftp site, although I'm not sure that the ftable sources are
identical to the version I picked up.  If it's a big deal let me know
and I'll make a new patch file.

Related papers:  see ./PAPERS.bib
---------------
  NOTE that the code included here has evolved since the experiments
in some of those papers were run; in particular, the OSDI results are
based on an earlier, buggier version of the iopfs-cache.  See the TR
version of that paper for correct results.

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

Subdirectories:
---------------
bin/		some new or changed executables from proteus
figs/		figures and data from the kotz:jdiskdir paper
proteus/	the proteus engine code, with my changes
run/		the place where experiments are run
src/		the source code, and compilation director


David Kotz
Assistant Professor
Department of Computer Science
Dartmouth College
6211 Sudikoff Laboratory
Hanover, NH  03755-3510 USA
email: dfk@cs.dartmouth.edu
URL: http://www.cs.dartmouth.edu/faculty/kotz.html
603-646-1439
