Copyright 1998-2001, University of Notre Dame.
Authors: Jeffrey M. Squyres, Arun Rodrigues, and Brian Barrett with
         Kinis L. Meyer, M. D. McNally, and Andrew Lumsdaine

This file is part of the Notre Dame LAM implementation of MPI.

You should have received a copy of the License Agreement for the Notre
Dame LAM implementation of MPI along with the software; see the file
LICENSE.  If not, contact Office of Research, University of Notre
Dame, Notre Dame, IN 46556.

Redistribution and use in source and binary forms, with or without
modification, are permitted subject to the conditions specified in the
LICENSE file.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

Additional copyrights may follow.


The ring program is a canonical example of MPI usage.  It sends a
simple message around in a ring pattern:

       Rank 0 sends to rank 1
       Rank 1 sends to rank 2
       Rank 2 sends to rank 3
       ...
       Rank N-1 sends to rank N
       Rank N sends to rank 0
       Rank 0 sends to rank 1
       etc.

The message that is sent around the ring is a single integer.  If the
integer is zero, each rank quits after it has passed the message on.
Rank zero is special -- it will receive the message and decrement the
integer before it passes the message on.  This scheme guarantees that
the application completes in an orderly fashion in finite time.

Rank zero is also special in that it both starts and finishes the
ring.  Rank 0 sends the initial message (which is hardwired to "5" in
this example) to rank 1 to start the whole process.  Rank 0 then also
has to consume the final "0" message from rank N so as not to leave a
message "hanging" out on the network when all the ranks quit.

Use "make" to compile this example.  Make will use mpicc to compile
the program:

        mpicc -o ring ring.c 

This program can be run with any number of MPI ranks, including 1.
