include/thread_mpi/barrier.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 #ifndef _TMPI_BARRIER_H_
  39 #define _TMPI_BARRIER_H_
  40
  41 /** Fast (possibly busy-wait-based) barrier type
  42  *
  43  *  This barrier has the same functionality as the standard
  44  *  tMPI_Thread_barrier_t, but since it is based on spinlocks that yield
  45  *  to the scheduler in case of waiting, it provides faster synchronization
  46  *  at the cost of busy-waiting, while still behaving relatively nicely
  47  *  to other processes/threads. This is therefore the preferred type of
  48  *  barrier for when waits are expected to be reasonably short.
  49  *
  50  *  Variables of this type should be initialized by calling
  51  *  tMPI_Spinlock_barrier_init() to set the number of threads
  52  *  that should be synchronized.
  53  *
  54  * \see
  55  * - tMPI_Spinlock_barrier_init
  56  * - tMPI_Spinlock_barrier_wait
  57  */
  58 typedef struct tMPI_Spinlock_barrier tMPI_Spinlock_barrier_t;
  59
  60 /** Initialize barrier
  61  *
  62  *  \param barrier  Pointer to _spinlock_ barrier. Note that this is not
  63  *                  the same datatype as the full, thread based, barrier.
  64  *  \param count    Number of threads to synchronize. All threads
  65  *                  will be released after \a count calls to
  66  *                  tMPI_Spinlock_barrier_wait().
  67  */
  68 void tMPI_Spinlock_barrier_init(tMPI_Spinlock_barrier_t *barrier, int count);
  69
  70
  71 /** Perform yielding, busy-waiting barrier synchronization
  72   *
  73   *  This function blocks until it has been called N times,
  74   *  where N is the count value the barrier was initialized with.
  75   *  After N total calls all threads return. The barrier automatically
  76   *  cycles, and thus requires another N calls to unblock another time.
  77   *
  78   *  \param barrier  Pointer to previously created barrier.
  79   *
  80   *  \return The last thread returns -1, all the others 0.
  81   */
  82 int tMPI_Spinlock_barrier_wait(tMPI_Spinlock_barrier_t *barrier);
  83
  84
  85 #ifdef DOXYGEN
  86 /** Get the number of threads to synchronize for a barrier
  87   *
  88   *  This function returns the total number of threads the barrier
  89   *  synchronizes.
  90   *
  91   *  \param barrier  Pointer to barrier.
  92   *
  93   *  \return the number of threads to synchronize
  94   */
  95 int tMPI_Spinlock_barrier_N(tMPI_Spinlock_barrier_t *barrier);
  96 #else
  97 #define tMPI_Spinlock_barrier_N(barrier)  ((barrier)->threshold)
  98 #endif
  99
 100 #endif