FTMPI
Karl Orbell
June 2002

This directory contains the code and documentation for FTMPI.  The
directory structure is the same as is documented in the implementation
system, but a brief overview will be presented here for users.

There are three directories making up the source code distribution:

* bin/

Directory containing the harness script,
'ftmpirun', and the test programs.  A script is also contained
in the directory, 'allcomp', which compiles the test programs.

ftmpirun is called as follows...

% ftmpirun <machines> <# nodes> <w. dir> <program> <pars> [-restore]

<machines> = a file containing machine names, one per line, this will be 
used for nodes, in the order listed in the file (the master node (rank 0), 
will always be on the local machine).

<# nodes> = number of nodes required

<w. dir> = working directory for checkpoint files

<program> = full path to FTMPI program

<pars> = real parameters for program

[-restore] = optional, restores program if possible - tries to find latest 
set of checkpoint files for restore.

* include/

This directory contains all of the header
files for the system, if you wish to use FTMPI in your program, you
should include the file "ftmpi.h" from this directory.

* lib/

This directory contains all of the source for
the FTMPI library, there is a make file in this directory that can be
used to compile the library.  Simply type the following to compile the
library:

home:/ftmpi/lib > make clean
home:/ftmpi/lib > make

The library should compile on any standard linux distribution, note
that the library uses the `pthreads' library.

If you wish to compile a program with the FTMPI library, then as well
as including the main FTMPI header file, you should also link your
program to the FTMPI library and the 'pthreads' library.  A
sample command line would be:

home:/src > gcc -I/ftmpi/include -L/ftmpi/lib -o myprog myprog.c
                -lftmpi -lpthread

The extensions to the standard MPI interface for controlling the
checkpointing are documented in the checkpointing section of the report.

Anyone is welcome to use this code, and comment on it.  Comments
should be sent to karl.orbell@ic.ac.uk or karlorbell@hotmail.com

Note: There are still bugs with the starting harness (ftmpirun), if you 
need help using this utility *please* contact me.




Karl.