src/external/thread_mpi/include/thread_mpi/wait.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 #ifndef TMPI_WAIT_H_
  40 #define TMPI_WAIT_H_
  41
  42 #if TMPI_WAIT_FOR_NO_ONE
  43
  44 #ifdef HAVE_CONFIG_H
  45 #include "config.h"
  46 #endif
  47
  48 #if GMX_FAHCORE
  49 // This lets F@H throttle CPU usage
  50 #define TMPI_YIELD_WAIT_DATA
  51 #define TMPI_YIELD_WAIT_DATA_INIT(data)
  52 #define TMPI_YIELD_WAIT(data) fcYieldWait()
  53
  54 #elif !(defined( _WIN32 ) || defined( _WIN64 ) )
  55 #ifdef HAVE_UNISTD_H
  56 #include <unistd.h>
  57 #endif
  58 #ifdef HAVE_SCHED_H
  59 #include <sched.h>
  60 #endif
  61
  62 /* for now we just do sched_yield(). It's in POSIX. */
  63 /* the data associated with waiting. */
  64 #define TMPI_YIELD_WAIT_DATA
  65 /* the initialization  associated with waiting. */
  66 #define TMPI_YIELD_WAIT_DATA_INIT(data)
  67
  68 /* the waiting macro */
  69 #define TMPI_YIELD_WAIT(data)  sched_yield()
  70
  71 #else
  72 /* and in Windows, we do SwitchToThread() alternated with Sleep(0). This
  73    is apparently recommende practice (SwitchToThread() alone just gives
  74    up the slice for threads on the current core, and Sleep(0) alone could
  75    lead to starvation. This mixed approach actually gives better real-world
  76    performance in the test program.*/
  77 /* the data associated with waiting. */
  78 #define TMPI_YIELD_WAIT_DATA  int yield_wait_counter;
  79 /* the initialization  associated with waiting. */
  80 #define TMPI_YIELD_WAIT_DATA_INIT(data) { (data)->yield_wait_counter = 0; }
  81
  82 /* the waiting macro is so complicated because using SwitchToThread only schedules */
  83 #define TMPI_YIELD_WAIT(data)  { \
  84         if ( ((data)->yield_wait_counter++)%100 == 0) \
  85         { \
  86             SwitchToThread(); \
  87         } \
  88         else \
  89         { \
  90             Sleep(0); \
  91         } \
  92 }
  93
  94 #endif
  95
  96
  97 #else /* !TMPI_WAIT_FOR_NO_ONE */
  98
  99 /* the data associated with waiting. */
 100 #define TMPI_YIELD_WAIT_DATA
 101 /* the initialization  associated with waiting. */
 102 #define TMPI_YIELD_WAIT_DATA_INIT(data)
 103
 104 /* the waiting macro */
 105 #define TMPI_YIELD_WAIT(data)  tMPI_Atomic_memory_barrier()
 106
 107
 108 #endif /* !TMPI_WAIT_FOR_NO_ONE */
 109
 110 #endif /* TMPI_WAIT_H_ */