src/gromacs/legacyheaders/thread_mpi/atomic/gcc_spinlock.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 /* this is for newer versions of gcc that have built-in intrinsics.
  40    These are the generic spinlocks:*/
  41
  42
  43 typedef struct tMPI_Spinlock
  44 {
  45     volatile unsigned int  lock /*__attribute__ ((aligned(64)))*/;
  46 } tMPI_Spinlock_t;
  47
  48
  49
  50
  51 #define TMPI_SPINLOCK_INITIALIZER   { 0 }
  52
  53
  54
  55 static inline void tMPI_Spinlock_init(tMPI_Spinlock_t *x)
  56 {
  57     x->lock = 0;
  58 }
  59
  60
  61 static inline void tMPI_Spinlock_lock(tMPI_Spinlock_t *x)
  62 {
  63 #if 1
  64     while (__sync_lock_test_and_set(&(x->lock), 1) == 1)
  65     {
  66         /* this is nicer on the system bus: */
  67         while (x->lock == 1)
  68         {
  69         }
  70     }
  71 #else
  72     do
  73     {
  74     }
  75     while (__sync_lock_test_and_set(&(x->lock), 1) == 1);
  76 #endif
  77 }
  78
  79
  80 static inline int tMPI_Spinlock_trylock(tMPI_Spinlock_t *x)
  81 {
  82     return __sync_lock_test_and_set(&(x->lock), 1);
  83 }
  84
  85
  86 static inline void tMPI_Spinlock_unlock(tMPI_Spinlock_t *  x)
  87 {
  88     __sync_lock_release(&(x->lock));
  89 }
  90
  91 static inline int tMPI_Spinlock_islocked(const tMPI_Spinlock_t *  x)
  92 {
  93     __sync_synchronize();
  94     return ( x->lock == 1 );
  95 }
  96
  97 static inline void tMPI_Spinlock_wait(tMPI_Spinlock_t *   x)
  98 {
  99     do
 100     {
 101     }
 102     while (x->lock == 1);
 103     __sync_synchronize();
 104 }