summaryrefslogtreecommitdiff
path: root/libs/pthreads/src/ptw32_MCS_lock.c
diff options
context:
space:
mode:
Diffstat (limited to 'libs/pthreads/src/ptw32_MCS_lock.c')
-rw-r--r--libs/pthreads/src/ptw32_MCS_lock.c125
1 files changed, 77 insertions, 48 deletions
diff --git a/libs/pthreads/src/ptw32_MCS_lock.c b/libs/pthreads/src/ptw32_MCS_lock.c
index 659cda60de..9116f35308 100644
--- a/libs/pthreads/src/ptw32_MCS_lock.c
+++ b/libs/pthreads/src/ptw32_MCS_lock.c
@@ -6,41 +6,42 @@
*
* --------------------------------------------------------------------------
*
- * Pthreads-win32 - POSIX Threads Library for Win32
+ * Pthreads4w - POSIX Threads Library for Win32
* Copyright(C) 1998 John E. Bossom
- * Copyright(C) 1999,2005 Pthreads-win32 contributors
- *
- * Contact Email: rpj@callisto.canberra.edu.au
- *
+ * Copyright(C) 1999-2018, Pthreads4w contributors
+ *
+ * Homepage: https://sourceforge.net/projects/pthreads4w/
+ *
* The current list of contributors is contained
* in the file CONTRIBUTORS included with the source
* code distribution. The list can also be seen at the
* following World Wide Web location:
- * http://sources.redhat.com/pthreads-win32/contributors.html
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library in the file COPYING.LIB;
- * if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+ * https://sourceforge.net/p/pthreads4w/wiki/Contributors/
+ *
+ * This file is part of Pthreads4w.
+ *
+ * Pthreads4w is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Pthreads4w is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Pthreads4w. If not, see <http://www.gnu.org/licenses/>. *
*/
/*
+
* About MCS locks:
*
* MCS locks are queue-based locks, where the queue nodes are local to the
* thread. The 'lock' is nothing more than a global pointer that points to
* the last node in the queue, or is NULL if the queue is empty.
- *
+ *
* Originally designed for use as spin locks requiring no kernel resources
* for synchronisation or blocking, the implementation below has adapted
* the MCS spin lock for use as a general mutex that will suspend threads
@@ -63,7 +64,7 @@
* every lock held concurrently by a thread.
*
* E.g.:
- *
+ *
* ptw32_mcs_lock_t lock1 = 0;
* ptw32_mcs_lock_t lock2 = 0;
*
@@ -87,26 +88,41 @@
* }
* return (void *)0;
* }
+ *
*/
+#ifdef HAVE_CONFIG_H
+# include <config.h>
+#endif
+
#include "pthread.h"
#include "sched.h"
#include "implement.h"
/*
* ptw32_mcs_flag_set -- notify another thread about an event.
- *
+ *
* Set event if an event handle has been stored in the flag, and
* set flag to -1 otherwise. Note that -1 cannot be a valid handle value.
*/
-INLINE void
+INLINE void
ptw32_mcs_flag_set (HANDLE * flag)
{
HANDLE e = (HANDLE)(PTW32_INTERLOCKED_SIZE)PTW32_INTERLOCKED_COMPARE_EXCHANGE_SIZE(
(PTW32_INTERLOCKED_SIZEPTR)flag,
(PTW32_INTERLOCKED_SIZE)-1,
(PTW32_INTERLOCKED_SIZE)0);
- if ((HANDLE)0 != e)
+ /*
+ * NOTE: when e == -1 and the MSVC debugger is attached to
+ * the process, we get an exception that halts the
+ * program noting that the handle value is invalid;
+ * although innocuous this behavior is cumbersome when
+ * debugging. Therefore we avoid calling SetEvent()
+ * for 'known' invalid HANDLE values that can arise
+ * when the above interlocked-compare-and-exchange
+ * is executed.
+ */
+ if (((HANDLE)0 != e) && ((HANDLE)-1 != e))
{
/* another thread has already stored an event handle in the flag */
SetEvent(e);
@@ -114,15 +130,15 @@ ptw32_mcs_flag_set (HANDLE * flag)
}
/*
- * ptw32_mcs_flag_set -- wait for notification from another.
- *
+ * ptw32_mcs_flag_wait -- wait for notification from another.
+ *
* Store an event handle in the flag and wait on it if the flag has not been
* set, and proceed without creating an event otherwise.
*/
-INLINE void
+INLINE void
ptw32_mcs_flag_wait (HANDLE * flag)
{
- if ((PTW32_INTERLOCKED_LONG)0 ==
+ if ((PTW32_INTERLOCKED_SIZE)0 ==
PTW32_INTERLOCKED_EXCHANGE_ADD_SIZE((PTW32_INTERLOCKED_SIZEPTR)flag,
(PTW32_INTERLOCKED_SIZE)0)) /* MBR fence */
{
@@ -145,25 +161,25 @@ ptw32_mcs_flag_wait (HANDLE * flag)
/*
* ptw32_mcs_lock_acquire -- acquire an MCS lock.
- *
- * See:
+ *
+ * See:
* J. M. Mellor-Crummey and M. L. Scott.
* Algorithms for Scalable Synchronization on Shared-Memory Multiprocessors.
* ACM Transactions on Computer Systems, 9(1):21-65, Feb. 1991.
*/
#if defined(PTW32_BUILD_INLINED)
-INLINE
+INLINE
#endif /* PTW32_BUILD_INLINED */
-void
+void
ptw32_mcs_lock_acquire (ptw32_mcs_lock_t * lock, ptw32_mcs_local_node_t * node)
{
ptw32_mcs_local_node_t *pred;
-
+
node->lock = lock;
node->nextFlag = 0;
node->readyFlag = 0;
node->next = 0; /* initially, no successor */
-
+
/* queue for the lock */
pred = (ptw32_mcs_local_node_t *)PTW32_INTERLOCKED_EXCHANGE_PTR((PTW32_INTERLOCKED_PVOID_PTR)lock,
(PTW32_INTERLOCKED_PVOID)node);
@@ -171,7 +187,7 @@ ptw32_mcs_lock_acquire (ptw32_mcs_lock_t * lock, ptw32_mcs_local_node_t * node)
if (0 != pred)
{
/* the lock was not free. link behind predecessor. */
- pred->next = node;
+ PTW32_INTERLOCKED_EXCHANGE_PTR((PTW32_INTERLOCKED_PVOID_PTR)&pred->next, (PTW32_INTERLOCKED_PVOID)node);
ptw32_mcs_flag_set(&pred->nextFlag);
ptw32_mcs_flag_wait(&node->readyFlag);
}
@@ -179,16 +195,16 @@ ptw32_mcs_lock_acquire (ptw32_mcs_lock_t * lock, ptw32_mcs_local_node_t * node)
/*
* ptw32_mcs_lock_release -- release an MCS lock.
- *
- * See:
+ *
+ * See:
* J. M. Mellor-Crummey and M. L. Scott.
* Algorithms for Scalable Synchronization on Shared-Memory Multiprocessors.
* ACM Transactions on Computer Systems, 9(1):21-65, Feb. 1991.
*/
#if defined(PTW32_BUILD_INLINED)
-INLINE
+INLINE
#endif /* PTW32_BUILD_INLINED */
-void
+void
ptw32_mcs_lock_release (ptw32_mcs_local_node_t * node)
{
ptw32_mcs_lock_t *lock = node->lock;
@@ -208,12 +224,17 @@ ptw32_mcs_lock_release (ptw32_mcs_local_node_t * node)
/* no successor, lock is free now */
return;
}
-
- /* A successor has started enqueueing behind us so wait for them to link to us */
+
+ /* wait for successor */
ptw32_mcs_flag_wait(&node->nextFlag);
next = (ptw32_mcs_local_node_t *)
PTW32_INTERLOCKED_EXCHANGE_ADD_SIZE((PTW32_INTERLOCKED_SIZEPTR)&node->next, (PTW32_INTERLOCKED_SIZE)0); /* MBR fence */
}
+ else
+ {
+ /* Even if the next is non-0, the successor may still be trying to set the next flag on us, therefore we must wait. */
+ ptw32_mcs_flag_wait(&node->nextFlag);
+ }
/* pass the lock */
ptw32_mcs_flag_set(&next->readyFlag);
@@ -223,9 +244,9 @@ ptw32_mcs_lock_release (ptw32_mcs_local_node_t * node)
* ptw32_mcs_lock_try_acquire
*/
#if defined(PTW32_BUILD_INLINED)
-INLINE
+INLINE
#endif /* PTW32_BUILD_INLINED */
-int
+int
ptw32_mcs_lock_try_acquire (ptw32_mcs_lock_t * lock, ptw32_mcs_local_node_t * node)
{
node->lock = lock;
@@ -251,9 +272,9 @@ ptw32_mcs_lock_try_acquire (ptw32_mcs_lock_t * lock, ptw32_mcs_local_node_t * no
* Should only be called by the thread that has the lock.
*/
#if defined(PTW32_BUILD_INLINED)
-INLINE
+INLINE
#endif /* PTW32_BUILD_INLINED */
-void
+void
ptw32_mcs_node_transfer (ptw32_mcs_local_node_t * new_node, ptw32_mcs_local_node_t * old_node)
{
new_node->lock = old_node->lock;
@@ -269,10 +290,18 @@ ptw32_mcs_node_transfer (ptw32_mcs_local_node_t * new_node, ptw32_mcs_local_node
/*
* A successor has queued after us, so wait for them to link to us
*/
- while (old_node->next == 0)
+ while (0 == old_node->next)
{
sched_yield();
}
+
+ /* we must wait for the next Node to finish inserting itself. */
+ ptw32_mcs_flag_wait(&old_node->nextFlag);
+ /*
+ * Copy the nextFlag state also so we don't block on it when releasing
+ * this lock.
+ */
new_node->next = old_node->next;
+ new_node->nextFlag = old_node->nextFlag;
}
}