1 /*-------------------------------------------------------------------------
4 * This file contains the implementation (if any) for spinlocks.
6 * Copyright (c) 1994, Regents of the University of California
10 * $Header: /cvsroot/pgsql/src/include/storage/s_lock.h,v 1.44 1998/08/22 04:24:21 momjian Exp $
12 *-------------------------------------------------------------------------
17 * The public macros that must be provided are:
19 * void S_INIT_LOCK(slock_t *lock)
21 * void S_LOCK(slock_t *lock)
23 * void S_UNLOCK(slock_t *lock)
25 * void S_LOCK_FREE(slock_t *lock)
26 * Tests if the lock is free. Returns non-zero if free, 0 if locked.
28 * The S_LOCK() macro implements a primitive but still useful random
29 * backoff to avoid hordes of busywaiting lockers chewing CPU.
33 * S_LOCK(slock_t *lock)
37 * // back off the cpu for a semi-random short time
41 * This implementation takes advantage of a tas function written
42 * (in assembly language) on machines that have a native test-and-set
43 * instruction. Alternative mutex implementations may also be used.
44 * This function is hidden under the TAS macro to allow substitutions.
46 * #define TAS(lock) tas(lock)
47 * int tas(slock_t *lock) // True if lock already set
49 * There are default implementations for all these macros at the bottom
50 * of this file. Check if your platform can use these or needs to
54 * If none of this can be done, POSTGRES will default to using
55 * System V semaphores (and take a large performance hit -- around 40%
56 * of its time on a DS5000/240 is spent in semop(3)...).
58 * AIX has a test-and-set but the recommended interface is the cs(3)
59 * system call. This provides an 8-instruction (plus system call
60 * overhead) uninterruptible compare-and-set operation. True
61 * spinlocks might be faster but using cs(3) still speeds up the
62 * regression test suite by about 25%. I don't have an assembler
63 * manual for POWER in any case.
66 #if !defined(S_LOCK_H)
69 #include "storage/ipc.h"
71 #if defined(HAS_TEST_AND_SET)
75 /*************************************************************************
80 #define TAS(lock) tas(lock)
81 #define S_UNLOCK(lock) { __asm__("mb"); *(lock) = 0; }
84 tas(volatile slock_t *lock)
86 register slock_t _res;
88 __asm__(" ldq $0, %0 \n\
89 bne $0, already_set \n\
91 bne $0, already_set \n\
95 success: bis $31, $31, %1 \n\
98 stqc_fail: or $31, 1, $0 \n\
99 already_set: bis $0, $0, %1 \n\
100 end: nop " : "=m"(*lock), "=r"(_res) : : "0");
109 #define TAS(lock) tas(lock)
111 static __inline__ int
112 tas(volatile slock_t *lock)
114 register slock_t _res = 1;
116 __asm__("lock; xchgb %0,%1" : "=q"(_res), "=m"(*lock) : "0"(_res) );
124 #define TAS(lock) tas(lock)
126 static __inline__ int
127 tas(volatile slock_t *lock)
129 register slock_t _res = 1;
131 __asm__("ldstub [%2], %0" \
132 : "=r" (_res), "=m" (*lock) \
140 #if defined(NEED_VAX_TAS_ASM)
142 * VAXen -- even multiprocessor ones
143 * (thanks to Tom Ivar Helbekkmo)
145 #define TAS(lock) tas(lock)
147 typedef unsigned char slock_t;
149 static __inline__ int
150 tas(volatile slock_t *lock)
154 __asm__(" movl $1, r0
158 : "=r"(_res) /* return value, in register */
159 : "r"(lock) /* argument, 'lock pointer', in register */
160 : "r0"); /* inline code uses this register */
163 #endif /* NEED_VAX_TAS_ASM */
169 /***************************************************************************
177 * Note that slock_t on the Alpha AXP is msemaphore instead of char
178 * (see storage/ipc.h).
180 #define TAS(lock) (msem_lock((lock), MSEM_IF_NOWAIT) < 0)
181 #define S_UNLOCK(lock) msem_unlock((lock), 0)
182 #define S_INIT_LOCK(lock) msem_init((lock), MSEM_UNLOCKED)
183 #define S_LOCK_FREE(lock) (!(lock)->msem_state)
188 #if defined(NEED_I386_TAS_ASM)
189 /* non gcc i386 based things */
191 #if defined(USE_UNIVEL_CC)
192 #define TAS(lock) tas(lock)
206 #endif /* USE_UNIVEL_CC */
208 #endif /* NEED_I386_TAS_ASM */
212 #if defined(NEED_NS32K_TAS_ASM)
214 #define S_LOCK(lock) \
218 __asm__("movqd 0, r0"); \
219 __asm__("sbitd r0, %0" : "=m"(*lock)); \
220 __asm__("sprb us, %0" : "=r" (res)); \
221 res = ((res >> 5) & 1); \
225 #endif /* NEED_NS32K_TAS_ASM */
228 #endif /* defined(__GNUC__) */
232 /*************************************************************************
233 * These are the platforms that have common code for gcc and non-gcc
240 * Note that slock_t on PA-RISC is a structure instead of char
241 * (see storage/ipc.h).
243 * a "set" slock_t has a single word cleared. a "clear" slock_t has
244 * all words set to non-zero. tas() in tas.s
246 static const slock_t clear_lock =
249 #define S_UNLOCK(lock) (*(lock) = clear_lock) /* struct assignment */
250 #define S_LOCK_FREE(lock) ( *(int *) (((long) (lock) + 15) & ~15) != 0)
257 * slock_t is defined as a struct abilock_t, which has a single unsigned long
260 * This stuff may be supplemented in the future with Masato Kataoka's MIPS-II
261 * assembly from his NECEWS SVR4 port, but we probably ought to retain this
262 * for the R3000 chips out there.
264 #define TAS(lock) (!acquire_lock(lock))
265 #define S_UNLOCK(lock) release_lock(lock)
266 #define S_INIT_LOCK(lock) init_lock(lock)
267 #define S_LOCK_FREE(lock) (stat_lock(lock) == UNLOCKED)
275 * Note that slock_t on POWER/POWER2/PowerPC is int instead of char
276 * (see storage/ipc.h).
278 #define TAS(lock) cs((int *) (lock), 0, 1)
282 #if defined (nextstep)
285 * slock_t is defined as a struct mutex.
288 #define S_LOCK(lock) mutex_lock(lock)
289 #define S_UNLOCK(lock) mutex_unlock(lock)
290 #define S_INIT_LOCK(lock) mutex_init(lock)
291 /* For Mach, we have to delve inside the entrails of `struct mutex'. Ick! */
292 #define S_LOCK_FREE(alock) ((alock)->lock == 0)
293 #endif /* nextstep */
298 /****************************************************************************
299 * Default Definitions - override these above as needed.
303 extern void s_lock(volatile slock_t *lock, const char *file, const int line);
304 #define S_LOCK(lock) \
305 if (TAS((volatile slock_t *) lock)) {\
306 s_lock((volatile slock_t *) lock, __FILE__, __LINE__); \
310 #if !defined(S_LOCK_FREE)
311 #define S_LOCK_FREE(lock) (*(lock) == 0)
312 #endif /* S_LOCK_FREE */
314 #if !defined(S_UNLOCK)
315 #define S_UNLOCK(lock) (*(lock) = 0)
316 #endif /* S_UNLOCK */
318 #if !defined(S_INIT_LOCK)
319 #define S_INIT_LOCK(lock) S_UNLOCK(lock)
320 #endif /* S_INIT_LOCK */
323 int tas(volatile slock_t *lock); /* port/.../tas.s, or s_lock.c */
324 #define TAS(lock) tas((volatile slock_t *) lock)
327 #endif /* HAS_TEST_AND_SET */
328 #endif /* S_LOCK_H */