src/gromacs/gmxlib/thread_mpi/collective.h

   1 /*
   2    This source code file is part of thread_mpi.
   3    Written by Sander Pronk, Erik Lindahl, and possibly others.
   4
   5    Copyright (c) 2009, Sander Pronk, Erik Lindahl.
   6    All rights reserved.
   7
   8    Redistribution and use in source and binary forms, with or without
   9    modification, are permitted provided that the following conditions are met:
  10    1) Redistributions of source code must retain the above copyright
  11    notice, this list of conditions and the following disclaimer.
  12    2) Redistributions in binary form must reproduce the above copyright
  13    notice, this list of conditions and the following disclaimer in the
  14    documentation and/or other materials provided with the distribution.
  15    3) Neither the name of the copyright holders nor the
  16    names of its contributors may be used to endorse or promote products
  17    derived from this software without specific prior written permission.
  18
  19    THIS SOFTWARE IS PROVIDED BY US ''AS IS'' AND ANY
  20    EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  21    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22    DISCLAIMED. IN NO EVENT SHALL WE BE LIABLE FOR ANY
  23    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  24    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  26    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  28    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30    If you want to redistribute modifications, please consider that
  31    scientific software is very special. Version control is crucial -
  32    bugs must be traceable. We will be happy to consider code for
  33    inclusion in the official distribution, but derived work should not
  34    be called official thread_mpi. Details are found in the README & COPYING
  35    files.
  36  */
  37
  38
  39 /* get a pointer the next coll_env once it's ready */
  40 struct coll_env *tMPI_Get_cev(tMPI_Comm comm, int myrank, int *synct);
  41
  42 /* post the availability of data in a cev.
  43    cev         = the collective comm environment
  44    myrank      = my rank
  45    index       = the buffer index
  46    tag         = the tag
  47    datatype    = the datatype
  48    busize      = the buffer size
  49    buf         = the buffer to xfer
  50    n_remaining = the number of remaining threads that need to transfer
  51    synct       = the multicast sync number
  52    dest        = -1 for all theads, or a specific rank number.
  53  */
  54 int tMPI_Post_multi(struct coll_env *cev, int myrank, int index,
  55                     int tag, tMPI_Datatype datatype,
  56                     size_t bufsize, void *buf, int n_remaining,
  57                     int synct, int dest);
  58
  59 /* transfer data from cev->met[rank] to recvbuf */
  60 void tMPI_Mult_recv(tMPI_Comm comm, struct coll_env *cev, int rank,
  61                     int index, int expected_tag, tMPI_Datatype recvtype,
  62                     size_t recvsize, void *recvbuf, int *ret);
  63
  64 /* do a root transfer (from root send buffer to root recv buffer) */
  65 void tMPI_Coll_root_xfer(tMPI_Comm comm,
  66                          tMPI_Datatype sendtype, tMPI_Datatype recvtype,
  67                          size_t sendsize, size_t recvsize,
  68                          void* sendbuf, void* recvbuf, int *ret);
  69
  70 /* wait for other processes to copy data from my cev */
  71 void tMPI_Wait_for_others(struct coll_env *cev, int myrank);
  72 /* wait for data to become available from a specific rank */
  73 void tMPI_Wait_for_data(struct tmpi_thread *cur, struct coll_env *cev,
  74                         int myrank);
  75 /*int rank, int myrank, int synct);*/