src/external/thread_mpi/include/thread_mpi/event.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_EVENT_H_
  39 #define TMPI_EVENT_H_
  40
  41 #include "visibility.h"
  42 #include "wait.h"
  43
  44 /*! \file
  45
  46    \brief Event notification wait and signaling functions.
  47
  48    The event structure offers lightweight signaling and scheduler-yielding
  49    (but still spinning) waiting for waits of intermediate durations (i.e.
  50    longer than appropriate for a spin lock but shorter than mutex_cond_wait().
  51    These functions only take care of the waiting and signaling; the user is
  52    responsible for the handling of the actual event structures and condition
  53    variables.
  54  */
  55
  56 /*! \brief Event notification structure.
  57
  58    Structure for notifying one thread that something has happened, allowing
  59    that thread to wait, and possibly give up its timeslice. This structure
  60    only takes care of the notification itself, and will not handle data
  61    about incoming events - that is left up to the user.
  62
  63    This structure allows notification of a single thread by any number of
  64    threads*/
  65 typedef struct tMPI_Event_t tMPI_Event;
  66 struct tMPI_Event_t
  67 {
  68     tMPI_Atomic_t sync;      /* the event sync counter */
  69     int           last_sync; /* the last sync event looked at */
  70     TMPI_YIELD_WAIT_DATA     /* data associated with yielding */
  71 };
  72
  73
  74
  75 /*! \brief Initialize the event object.
  76
  77     \param ev The event structure to be intialized. */
  78 TMPI_EXPORT
  79 void tMPI_Event_init(tMPI_Event *ev);
  80
  81 /*! \brief Deallocate the internals of the contents of event object.
  82
  83     \param ev The event structure to be destroyed. */
  84 TMPI_EXPORT
  85 void tMPI_Event_destroy(tMPI_Event *ev);
  86
  87 /*! \brief Wait for an event to occur.
  88
  89    Sets the number of events that had occurred during the wait in N.
  90    \param ev The event structure to wait on.
  91    \returns  The number of events that have occurred at function
  92              return time. */
  93 TMPI_EXPORT
  94 int tMPI_Event_wait(tMPI_Event *ev);
  95
  96 #ifdef DOXYGEN
  97 /*! \brief Signal an event, possibly waking an tMPI_Event_wait().
  98
  99     \param ev  The event to signal. */
 100 TMPI_EXPORT
 101 void tMPI_Event_signal(tMPI_Event *ev);
 102 #else
 103 #define tMPI_Event_signal(ev) \
 104     { \
 105         tMPI_Atomic_memory_barrier_rel(); \
 106         tMPI_Atomic_fetch_add( &((ev)->sync), 1); \
 107     }
 108 #endif
 109
 110 #ifdef DOXYGEN
 111 /*! \brief Signal processing of an event.
 112
 113    Each event that is handled by the receiver, must be processed through
 114    tMPI_Event_process(). Unprocessed events will make tMPI_Event_wait() return
 115    immediately.
 116
 117    \param ev  The event object.
 118    \param N   The number of processed events. */
 119 TMPI_EXPORT
 120 void tMPI_Event_process(tMPI_Event *ev, int N);
 121 #else
 122 #define tMPI_Event_process(ev, N) \
 123     { \
 124         (ev)->last_sync += N; \
 125     }
 126 #endif
 127
 128 #endif /* TMPI_EVENT_H_ */