2 * Copyright 1988, 1989 Hans-J. Boehm, Alan J. Demers
3 * Copyright (c) 1991-1994 by Xerox Corporation. All rights reserved.
4 * Copyright (c) 1996-1999 by Silicon Graphics. All rights reserved.
5 * Copyright (c) 1999 by Hewlett-Packard Company. All rights reserved.
8 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
9 * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
11 * Permission is hereby granted to use or copy this program
12 * for any purpose, provided the above notices are retained on all copies.
13 * Permission to modify the code and to distribute modified code is granted,
14 * provided the above notices are retained, and a notice that the code was
15 * modified is included with the above copyright notice.
22 * Mutual exclusion between allocator/collector routines.
23 * Needed if there is more than one allocator thread.
24 * FASTLOCK() is assumed to try to acquire the lock in a cheap and
25 * dirty way that is acceptable for a few instructions, e.g. by
26 * inhibiting preemption. This is assumed to have succeeded only
27 * if a subsequent call to FASTLOCK_SUCCEEDED() returns TRUE.
28 * FASTUNLOCK() is called whether or not FASTLOCK_SUCCEEDED().
29 * If signals cannot be tolerated with the FASTLOCK held, then
30 * FASTLOCK should disable signals. The code executed under
31 * FASTLOCK is otherwise immune to interruption, provided it is
33 * DCL_LOCK_STATE declares any local variables needed by LOCK and UNLOCK
34 * and/or DISABLE_SIGNALS and ENABLE_SIGNALS and/or FASTLOCK.
35 * (There is currently no equivalent for FASTLOCK.)
37 * In the PARALLEL_MARK case, we also need to define a number of
38 * other inline finctions here:
39 * GC_bool GC_compare_and_exchange( volatile GC_word *addr,
40 * GC_word old, GC_word new )
41 * GC_word GC_atomic_add( volatile GC_word *addr, GC_word how_much )
42 * void GC_memory_barrier( )
46 void GC_noop1
GC_PROTO((word
));
47 # ifdef PCR_OBSOLETE /* Faster, but broken with multiple lwp's */
48 # include "th/PCR_Th.h"
49 # include "th/PCR_ThCrSec.h"
50 extern struct PCR_Th_MLRep GC_allocate_ml
;
51 # define DCL_LOCK_STATE PCR_sigset_t GC_old_sig_mask
52 # define LOCK() PCR_Th_ML_Acquire(&GC_allocate_ml)
53 # define UNLOCK() PCR_Th_ML_Release(&GC_allocate_ml)
54 # define UNLOCK() PCR_Th_ML_Release(&GC_allocate_ml)
55 # define FASTLOCK() PCR_ThCrSec_EnterSys()
56 /* Here we cheat (a lot): */
57 # define FASTLOCK_SUCCEEDED() (*(int *)(&GC_allocate_ml) == 0)
58 /* TRUE if nobody currently holds the lock */
59 # define FASTUNLOCK() PCR_ThCrSec_ExitSys()
62 # include <base/PCR_Base.h>
63 # include <th/PCR_Th.h>
64 extern PCR_Th_ML GC_allocate_ml
;
65 # define DCL_LOCK_STATE \
66 PCR_ERes GC_fastLockRes; PCR_sigset_t GC_old_sig_mask
67 # define LOCK() PCR_Th_ML_Acquire(&GC_allocate_ml)
68 # define UNLOCK() PCR_Th_ML_Release(&GC_allocate_ml)
69 # define FASTLOCK() (GC_fastLockRes = PCR_Th_ML_Try(&GC_allocate_ml))
70 # define FASTLOCK_SUCCEEDED() (GC_fastLockRes == PCR_ERes_okay)
71 # define FASTUNLOCK() {\
72 if( FASTLOCK_SUCCEEDED() ) PCR_Th_ML_Release(&GC_allocate_ml); }
75 extern GC_word RT0u__inCritical
;
76 # define LOCK() RT0u__inCritical++
77 # define UNLOCK() RT0u__inCritical--
79 # ifdef GC_SOLARIS_THREADS
82 extern mutex_t GC_allocate_ml
;
83 # define LOCK() mutex_lock(&GC_allocate_ml);
84 # define UNLOCK() mutex_unlock(&GC_allocate_ml);
87 /* Try to define GC_TEST_AND_SET and a matching GC_CLEAR for spin lock */
88 /* acquisition and release. We need this for correct operation of the */
92 inline static int GC_test_and_set(volatile unsigned int *addr
) {
94 /* Note: the "xchg" instruction does not need a "lock" prefix */
95 __asm__
__volatile__("xchgl %0, %1"
96 : "=r"(oldval
), "=m"(*(addr
))
97 : "0"(1), "m"(*(addr
)) : "memory");
100 # define GC_TEST_AND_SET_DEFINED
103 # include <ia64intrin.h>
104 inline static int GC_test_and_set(volatile unsigned int *addr
) {
105 return __sync_lock_test_and_set(addr
, 1);
107 # define GC_TEST_AND_SET_DEFINED
108 inline static void GC_clear(volatile unsigned int *addr
) {
111 # define GC_CLEAR_DEFINED
114 inline static int GC_test_and_set(volatile unsigned int *addr
) {
117 __asm__
__volatile__("ldstub %1,%0"
118 : "=r"(oldval
), "=m"(*addr
)
119 : "m"(*addr
) : "memory");
122 # define GC_TEST_AND_SET_DEFINED
125 /* Contributed by Tony Mantler. I'm not sure how well it was */
127 inline static int GC_test_and_set(volatile unsigned int *addr
) {
128 char oldval
; /* this must be no longer than 8 bits */
130 /* The return value is semi-phony. */
131 /* 'tas' sets bit 7 while the return */
132 /* value pretends bit 0 was set */
133 __asm__
__volatile__(
134 "tas %1@; sne %0; negb %0"
136 : "a" (addr
) : "memory");
139 # define GC_TEST_AND_SET_DEFINED
141 # if defined(POWERPC)
142 inline static int GC_test_and_set(volatile unsigned int *addr
) {
144 int temp
= 1; /* locked value */
146 __asm__
__volatile__(
147 "1:\tlwarx %0,0,%3\n" /* load and reserve */
148 "\tcmpwi %0, 0\n" /* if load is */
149 "\tbne 2f\n" /* non-zero, return already set */
150 "\tstwcx. %2,0,%1\n" /* else store conditional */
151 "\tbne- 1b\n" /* retry if lost reservation */
152 "\tsync\n" /* import barrier */
153 "2:\t\n" /* oldval is zero if we set */
154 : "=&r"(oldval
), "=p"(addr
)
155 : "r"(temp
), "1"(addr
)
159 # define GC_TEST_AND_SET_DEFINED
160 inline static void GC_clear(volatile unsigned int *addr
) {
161 __asm__
__volatile__("eieio" : : : "memory");
164 # define GC_CLEAR_DEFINED
167 inline static int GC_test_and_set(volatile unsigned int * addr
)
169 unsigned long oldvalue
;
172 __asm__
__volatile__(
186 ".section .text2,\"ax\"\n"
190 :"=&r" (temp
), "=m" (*addr
), "=&r" (oldvalue
)
191 :"Ir" (1), "m" (*addr
)
196 # define GC_TEST_AND_SET_DEFINED
197 inline static void GC_clear(volatile unsigned int *addr
) {
198 __asm__
__volatile__("mb" : : : "memory");
201 # define GC_CLEAR_DEFINED
204 inline static int GC_test_and_set(volatile unsigned int *addr
) {
206 /* SWP on ARM is very similar to XCHG on x86. Doesn't lock the
207 * bus because there are no SMP ARM machines. If/when there are,
208 * this code will likely need to be updated. */
209 /* See linuxthreads/sysdeps/arm/pt-machine.h in glibc-2.1 */
210 __asm__
__volatile__("swp %0, %1, [%2]"
216 # define GC_TEST_AND_SET_DEFINED
219 inline static int GC_test_and_set(volatile unsigned int *addr
) {
220 /* Ripped from linuxthreads/sysdeps/cris/pt-machine.h. */
221 /* Included with Hans-Peter Nilsson's permission. */
222 register unsigned long int ret
;
224 /* Note the use of a dummy output of *addr to expose the write.
225 * The memory barrier is to stop *other* writes being moved past
228 __asm__
__volatile__("clearf\n"
235 : "=&r" (ret
), "=m" (*addr
)
236 : "r" (addr
), "r" ((int) 1), "m" (*addr
)
240 # define GC_TEST_AND_SET_DEFINED
243 inline static int GC_test_and_set(volatile unsigned int *addr
) {
245 __asm__
__volatile__ (
247 "0: cs %0,%1,0(%2)\n"
250 : "d" (1), "a" (addr
)
255 # endif /* __GNUC__ */
256 # if (defined(ALPHA) && !defined(__GNUC__))
258 --> We currently assume that
if gcc is
not used
, we are
259 --> running under Tru64
.
261 # include <machine/builtins.h>
263 # define GC_test_and_set(addr) __ATOMIC_EXCH_LONG(addr, 1)
264 # define GC_TEST_AND_SET_DEFINED
265 # define GC_clear(addr) { asm("mb"); *(volatile unsigned *)addr = 0; }
266 # define GC_CLEAR_DEFINED
268 # if defined(MSWIN32)
269 # define GC_test_and_set(addr) InterlockedExchange((LPLONG)addr,1)
270 # define GC_TEST_AND_SET_DEFINED
274 # include <sys/tas.h>
275 # define GC_test_and_set(addr) _test_and_set((int *) addr,1)
276 # define GC_TEST_AND_SET_DEFINED
277 # elif __mips < 3 || !(defined (_ABIN32) || defined(_ABI64)) \
278 || !defined(_COMPILER_VERSION) || _COMPILER_VERSION < 700
280 # define GC_test_and_set(addr) _test_and_set((void *)addr,1)
282 # define GC_test_and_set(addr) test_and_set((void *)addr,1)
285 # define GC_test_and_set(addr) __test_and_set32((void *)addr,1)
286 # define GC_clear(addr) __lock_release(addr);
287 # define GC_CLEAR_DEFINED
289 # define GC_TEST_AND_SET_DEFINED
292 # include <sys/atomic_op.h>
293 # if (defined(_POWER) || defined(_POWERPC))
294 # if defined(__GNUC__)
295 inline static void GC_memsync() {
296 __asm__
__volatile__ ("sync" : : : "memory");
300 # define inline __inline
302 # pragma mc_func GC_memsync { \
303 "7c0004ac" /* sync (same opcode used for dcs)*/ \
307 # error dont know how to memsync
309 inline static int GC_test_and_set(volatile unsigned int * addr
) {
311 if (compare_and_swap((void *)addr
, &oldvalue
, 1)) {
316 # define GC_TEST_AND_SET_DEFINED
317 inline static void GC_clear(volatile unsigned int *addr
) {
321 # define GC_CLEAR_DEFINED
324 # if 0 /* defined(HP_PA) */
325 /* The official recommendation seems to be to not use ldcw from */
326 /* user mode. Since multithreaded incremental collection doesn't */
327 /* work anyway on HP_PA, this shouldn't be a major loss. */
329 /* "set" means 0 and "clear" means 1 here. */
330 # define GC_test_and_set(addr) !GC_test_and_clear(addr);
331 # define GC_TEST_AND_SET_DEFINED
332 # define GC_clear(addr) GC_noop1((word)(addr)); *(volatile unsigned int *)addr = 1;
333 /* The above needs a memory barrier! */
334 # define GC_CLEAR_DEFINED
336 # if defined(GC_TEST_AND_SET_DEFINED) && !defined(GC_CLEAR_DEFINED)
338 inline static void GC_clear(volatile unsigned int *addr
) {
339 /* Try to discourage gcc from moving anything past this. */
340 __asm__
__volatile__(" " : : : "memory");
344 /* The function call in the following should prevent the */
345 /* compiler from moving assignments to below the UNLOCK. */
346 # define GC_clear(addr) GC_noop1((word)(addr)); \
347 *((volatile unsigned int *)(addr)) = 0;
349 # define GC_CLEAR_DEFINED
350 # endif /* !GC_CLEAR_DEFINED */
352 # if !defined(GC_TEST_AND_SET_DEFINED)
353 # define USE_PTHREAD_LOCKS
356 # if defined(GC_PTHREADS) && !defined(GC_SOLARIS_THREADS) \
357 && !defined(GC_IRIX_THREADS) && !defined(GC_WIN32_THREADS)
358 # define NO_THREAD (pthread_t)(-1)
359 # include <pthread.h>
360 # if defined(PARALLEL_MARK)
361 /* We need compare-and-swap to update mark bits, where it's */
362 /* performance critical. If USE_MARK_BYTES is defined, it is */
363 /* no longer needed for this purpose. However we use it in */
364 /* either case to implement atomic fetch-and-add, though that's */
365 /* less performance critical, and could perhaps be done with */
367 # if defined(GENERIC_COMPARE_AND_SWAP)
368 /* Probably not useful, except for debugging. */
369 /* We do use GENERIC_COMPARE_AND_SWAP on PA_RISC, but we */
370 /* minimize its use. */
371 extern pthread_mutex_t GC_compare_and_swap_lock
;
373 /* Note that if GC_word updates are not atomic, a concurrent */
374 /* reader should acquire GC_compare_and_swap_lock. On */
375 /* currently supported platforms, such updates are atomic. */
376 extern GC_bool
GC_compare_and_exchange(volatile GC_word
*addr
,
377 GC_word old
, GC_word new_val
);
378 # endif /* GENERIC_COMPARE_AND_SWAP */
380 # if !defined(GENERIC_COMPARE_AND_SWAP)
381 /* Returns TRUE if the comparison succeeded. */
382 inline static GC_bool
GC_compare_and_exchange(volatile GC_word
*addr
,
387 __asm__
__volatile__("lock; cmpxchgl %2, %0; setz %1"
388 : "+m"(*(addr
)), "=r"(result
)
389 : "r" (new_val
), "a"(old
) : "memory");
390 return (GC_bool
) result
;
392 # endif /* !GENERIC_COMPARE_AND_SWAP */
393 inline static void GC_memory_barrier()
395 /* We believe the processor ensures at least processor */
396 /* consistent ordering. Thus a compiler barrier */
397 /* should suffice. */
398 __asm__
__volatile__("" : : : "memory");
402 # if defined(POWERPC)
403 # if !defined(GENERIC_COMPARE_AND_SWAP)
404 /* Returns TRUE if the comparison succeeded. */
405 inline static GC_bool
GC_compare_and_exchange(volatile GC_word
*addr
,
406 GC_word old
, GC_word new_val
)
409 __asm__
__volatile__(
410 "1:\tlwarx %0,0,%5\n"
420 : "=&r" (dummy
), "=r" (result
), "=p" (addr
)
421 : "r" (new_val
), "r" (old
), "2"(addr
)
423 return (GC_bool
) result
;
425 # endif /* !GENERIC_COMPARE_AND_SWAP */
426 inline static void GC_memory_barrier()
428 __asm__
__volatile__("sync" : : : "memory");
430 # endif /* POWERPC */
433 # if !defined(GENERIC_COMPARE_AND_SWAP)
434 inline static GC_bool
GC_compare_and_exchange(volatile GC_word
*addr
,
438 return __sync_bool_compare_and_swap (addr
, old
, new_val
);
440 # endif /* !GENERIC_COMPARE_AND_SWAP */
442 /* Shouldn't be needed; we use volatile stores instead. */
443 inline static void GC_memory_barrier()
445 __sync_synchronize ();
450 # if !defined(GENERIC_COMPARE_AND_SWAP)
451 # if defined(__GNUC__)
452 inline static GC_bool
GC_compare_and_exchange(volatile GC_word
*addr
,
453 GC_word old
, GC_word new_val
)
455 unsigned long was_equal
;
458 __asm__
__volatile__(
467 :"=&r" (temp
), "=m" (*addr
), "=&r" (was_equal
)
468 : "r" (new_val
), "Ir" (old
)
472 # else /* !__GNUC__ */
473 inline static GC_bool
GC_compare_and_exchange(volatile GC_word
*addr
,
474 GC_word old
, GC_word new_val
)
476 return __CMP_STORE_QUAD(addr
, old
, new_val
, addr
);
478 # endif /* !__GNUC__ */
479 # endif /* !GENERIC_COMPARE_AND_SWAP */
481 inline static void GC_memory_barrier()
483 __asm__
__volatile__("mb" : : : "memory");
486 # define GC_memory_barrier() asm("mb")
487 # endif /* !__GNUC__ */
490 # if !defined(GENERIC_COMPARE_AND_SWAP)
491 inline static GC_bool
GC_compare_and_exchange(volatile C_word
*addr
,
492 GC_word old
, GC_word new_val
)
495 __asm__
__volatile__ (
503 : "=&d" (retval
), "+d" (old
)
504 : "d" (new_val
), "a" (addr
)
510 # if !defined(GENERIC_COMPARE_AND_SWAP)
511 /* Returns the original value of *addr. */
512 inline static GC_word
GC_atomic_add(volatile GC_word
*addr
,
518 } while (!GC_compare_and_exchange(addr
, old
, old
+how_much
));
521 # else /* GENERIC_COMPARE_AND_SWAP */
522 /* So long as a GC_word can be atomically updated, it should */
523 /* be OK to read *addr without a lock. */
524 extern GC_word
GC_atomic_add(volatile GC_word
*addr
, GC_word how_much
);
525 # endif /* GENERIC_COMPARE_AND_SWAP */
527 # endif /* PARALLEL_MARK */
529 # if !defined(THREAD_LOCAL_ALLOC) && !defined(USE_PTHREAD_LOCKS)
530 /* In the THREAD_LOCAL_ALLOC case, the allocation lock tends to */
531 /* be held for long periods, if it is held at all. Thus spinning */
532 /* and sleeping for fixed periods are likely to result in */
533 /* significant wasted time. We thus rely mostly on queued locks. */
534 # define USE_SPIN_LOCK
535 extern volatile unsigned int GC_allocate_lock
;
536 extern void GC_lock(void);
537 /* Allocation lock holder. Only set if acquired by client through */
538 /* GC_call_with_alloc_lock. */
539 # ifdef GC_ASSERTIONS
541 { if (GC_test_and_set(&GC_allocate_lock)) GC_lock(); \
544 { GC_ASSERT(I_HOLD_LOCK()); UNSET_LOCK_HOLDER(); \
545 GC_clear(&GC_allocate_lock); }
548 { if (GC_test_and_set(&GC_allocate_lock)) GC_lock(); }
550 GC_clear(&GC_allocate_lock)
551 # endif /* !GC_ASSERTIONS */
553 /* Another alternative for OSF1 might be: */
554 # include <sys/mman.h>
555 extern msemaphore GC_allocate_semaphore
;
556 # define LOCK() { if (msem_lock(&GC_allocate_semaphore, MSEM_IF_NOWAIT) \
557 != 0) GC_lock(); else GC_allocate_lock = 1; }
558 /* The following is INCORRECT, since the memory model is too weak. */
559 /* Is this true? Presumably msem_unlock has the right semantics? */
561 # define UNLOCK() { GC_allocate_lock = 0; \
562 msem_unlock(&GC_allocate_semaphore, 0); }
564 # else /* THREAD_LOCAL_ALLOC || USE_PTHREAD_LOCKS */
565 # ifndef USE_PTHREAD_LOCKS
566 # define USE_PTHREAD_LOCKS
568 # endif /* THREAD_LOCAL_ALLOC */
569 # ifdef USE_PTHREAD_LOCKS
570 # include <pthread.h>
571 extern pthread_mutex_t GC_allocate_ml
;
572 # ifdef GC_ASSERTIONS
577 { GC_ASSERT(I_HOLD_LOCK()); UNSET_LOCK_HOLDER(); \
578 pthread_mutex_unlock(&GC_allocate_ml); }
579 # else /* !GC_ASSERTIONS */
580 # if defined(NO_PTHREAD_TRYLOCK)
581 # define LOCK() GC_lock();
582 # else /* !defined(NO_PTHREAD_TRYLOCK) */
584 { if (0 != pthread_mutex_trylock(&GC_allocate_ml)) GC_lock(); }
586 # define UNLOCK() pthread_mutex_unlock(&GC_allocate_ml)
587 # endif /* !GC_ASSERTIONS */
588 # endif /* USE_PTHREAD_LOCKS */
589 # define SET_LOCK_HOLDER() GC_lock_holder = pthread_self()
590 # define UNSET_LOCK_HOLDER() GC_lock_holder = NO_THREAD
591 # define I_HOLD_LOCK() (pthread_equal(GC_lock_holder, pthread_self()))
592 extern VOLATILE GC_bool GC_collecting
;
593 # define ENTER_GC() GC_collecting = 1;
594 # define EXIT_GC() GC_collecting = 0;
595 extern void GC_lock(void);
596 extern pthread_t GC_lock_holder
;
597 # ifdef GC_ASSERTIONS
598 extern pthread_t GC_mark_lock_holder
;
600 # endif /* GC_PTHREADS with linux_threads.c implementation */
601 # if defined(GC_IRIX_THREADS)
602 # include <pthread.h>
603 /* This probably should never be included, but I can't test */
604 /* on Irix anymore. */
607 extern volatile unsigned int GC_allocate_lock
;
608 /* This is not a mutex because mutexes that obey the (optional) */
609 /* POSIX scheduling rules are subject to convoys in high contention */
610 /* applications. This is basically a spin lock. */
611 extern pthread_t GC_lock_holder
;
612 extern void GC_lock(void);
613 /* Allocation lock holder. Only set if acquired by client through */
614 /* GC_call_with_alloc_lock. */
615 # define SET_LOCK_HOLDER() GC_lock_holder = pthread_self()
616 # define NO_THREAD (pthread_t)(-1)
617 # define UNSET_LOCK_HOLDER() GC_lock_holder = NO_THREAD
618 # define I_HOLD_LOCK() (pthread_equal(GC_lock_holder, pthread_self()))
619 # define LOCK() { if (GC_test_and_set(&GC_allocate_lock)) GC_lock(); }
620 # define UNLOCK() GC_clear(&GC_allocate_lock);
621 extern VOLATILE GC_bool GC_collecting
;
622 # define ENTER_GC() \
626 # define EXIT_GC() GC_collecting = 0;
627 # endif /* GC_IRIX_THREADS */
628 # if defined(GC_WIN32_THREADS)
629 # if defined(GC_PTHREADS)
630 # include <pthread.h>
631 extern pthread_mutex_t GC_allocate_ml
;
632 # define LOCK() pthread_mutex_lock(&GC_allocate_ml)
633 # define UNLOCK() pthread_mutex_unlock(&GC_allocate_ml)
635 # include <windows.h>
636 GC_API CRITICAL_SECTION GC_allocate_ml
;
637 # define LOCK() EnterCriticalSection(&GC_allocate_ml);
638 # define UNLOCK() LeaveCriticalSection(&GC_allocate_ml);
641 # ifndef SET_LOCK_HOLDER
642 # define SET_LOCK_HOLDER()
643 # define UNSET_LOCK_HOLDER()
644 # define I_HOLD_LOCK() FALSE
645 /* Used on platforms were locks can be reacquired, */
646 /* so it doesn't matter if we lie. */
648 # else /* !THREADS */
651 # endif /* !THREADS */
652 # ifndef SET_LOCK_HOLDER
653 # define SET_LOCK_HOLDER()
654 # define UNSET_LOCK_HOLDER()
655 # define I_HOLD_LOCK() FALSE
656 /* Used on platforms were locks can be reacquired, */
657 /* so it doesn't matter if we lie. */
664 # ifndef DCL_LOCK_STATE
665 # define DCL_LOCK_STATE
668 # define FASTLOCK() LOCK()
669 # define FASTLOCK_SUCCEEDED() TRUE
670 # define FASTUNLOCK() UNLOCK()
673 #endif /* GC_LOCKS_H */