granicus.if.org Git - postgresql/blob - src/include/storage/s_lock.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * s_lock.h
   4  *         This file contains the implementation (if any) for spinlocks.
   5  *
   6  * Copyright (c) 1994, Regents of the University of California
   7  *
   8  *
   9  * IDENTIFICATION
  10  *        $Header: /cvsroot/pgsql/src/include/storage/s_lock.h,v 1.58 1999/02/13 23:22:09 momjian Exp $
  11  *
  12  *-------------------------------------------------------------------------
  13  */
  14
  15 /*
  16  *       DESCRIPTION
  17  *              The public macros that must be provided are:
  18  *
  19  *              void S_INIT_LOCK(slock_t *lock)
  20  *
  21  *              void S_LOCK(slock_t *lock)
  22  *
  23  *              void S_UNLOCK(slock_t *lock)
  24  *
  25  *              void S_LOCK_FREE(slock_t *lock)
  26  *                      Tests if the lock is free. Returns non-zero if free, 0 if locked.
  27  *
  28  *              The S_LOCK() macro      implements a primitive but still useful random
  29  *              backoff to avoid hordes of busywaiting lockers chewing CPU.
  30  *
  31  *              Effectively:
  32  *              void
  33  *              S_LOCK(slock_t *lock)
  34  *              {
  35  *                      while (TAS(lock))
  36  *                      {
  37  *                      // back off the cpu for a semi-random short time
  38  *                      }
  39  *              }
  40  *
  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.
  45  *
  46  *              #define TAS(lock) tas(lock)
  47  *              int tas(slock_t *lock)          // True if lock already set
  48  *
  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
  51  *              override them.
  52  *
  53  *      NOTES
  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)...).
  57  *
  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.
  64  *
  65  */
  66 #if !defined(S_LOCK_H)
  67 #define S_LOCK_H
  68
  69 #include "storage/ipc.h"
  70
  71 extern void s_lock_sleep(unsigned spin);
  72
  73 #if defined(HAS_TEST_AND_SET)
  74
  75
  76 #if defined(__GNUC__)
  77 /*************************************************************************
  78  * All the gcc inlines
  79  */
  80
  81 #if defined(__alpha)
  82 #define TAS(lock) tas(lock)
  83 #define S_UNLOCK(lock) { __asm__("mb"); *(lock) = 0; }
  84
  85 static __inline__ int
  86 tas(volatile slock_t *lock)
  87 {
  88         register slock_t _res;
  89
  90 __asm__("    ldq   $0, %0              \n\
  91                  bne   $0, 3f          \n\
  92                  ldq_l $0, %0              \n\
  93                  bne   $0, 3f          \n\
  94                  or    $31, 1, $0          \n\
  95                  stq_c $0, %0              \n\
  96                  beq   $0, 2f              \n\
  97                  bis   $31, $31, %1        \n\
  98                  mb                                \n\
  99                  jmp   $31, 4f             \n\
 100               2: or    $31, 1, $0              \n\
 101               3: bis   $0, $0, %1              \n\
 102               4: nop      ": "=m"(*lock), "=r"(_res): :"0");
 103
 104         return (int) _res;
 105 }
 106
 107 #endif   /* __alpha */
 108
 109
 110
 111 #if defined(i386)
 112 #define TAS(lock) tas(lock)
 113
 114 static __inline__ int
 115 tas(volatile slock_t *lock)
 116 {
 117         register slock_t _res = 1;
 118
 119 __asm__("lock; xchgb %0,%1": "=q"(_res), "=m"(*lock):"0"(_res));
 120         return (int) _res;
 121 }
 122
 123 #endif   /* i386 */
 124
 125
 126
 127 #if defined(sparc)
 128 #define TAS(lock) tas(lock)
 129
 130 static __inline__ int
 131 tas(volatile slock_t *lock)
 132 {
 133         register slock_t _res = 1;
 134
 135         __asm__("ldstub [%2], %0" \
 136 :                       "=r"(_res), "=m"(*lock) \
 137 :                       "r"(lock));
 138         return (int) _res;
 139 }
 140
 141 #endif   /* sparc */
 142
 143
 144
 145 #if defined(NEED_VAX_TAS_ASM)
 146 /*
 147  * VAXen -- even multiprocessor ones
 148  * (thanks to Tom Ivar Helbekkmo)
 149  */
 150 #define TAS(lock) tas(lock)
 151
 152 typedef unsigned char slock_t;
 153
 154 static __inline__ int
 155 tas(volatile slock_t *lock)
 156 {
 157         register        _res;
 158
 159         __asm__("       movl $1, r0 \
 160                         bbssi $0, (%1), 1 f \
 161                         clrl r0 \
 162 1:                      movl r0, %0 "
 163 :                       "=r"(_res)                      /* return value, in register */
 164 :                       "r"(lock)                       /* argument, 'lock pointer', in register */
 165 :                       "r0");                          /* inline code uses this register */
 166         return (int) _res;
 167 }
 168
 169 #endif   /* NEED_VAX_TAS_ASM */
 170
 171
 172
 173 #if defined(NEED_NS32K_TAS_ASM)
 174 #define TAS(lock) tas(lock)
 175
 176 static __inline__ int
 177 tas(volatile slock_t *lock)
 178 {
 179   register _res;
 180   __asm__("sbitb 0, %0 \n\
 181         sfsd %1"
 182         : "=m"(*lock), "=r"(_res));
 183   return (int) _res;
 184 }
 185
 186 #endif  /* NEED_NS32K_TAS_ASM */
 187
 188
 189
 190 #else                                                   /* __GNUC__ */
 191 /***************************************************************************
 192  * All non gcc
 193  */
 194
 195 #if defined(__alpha)
 196 /*
 197  * OSF/1 (Alpha AXP)
 198  *
 199  * Note that slock_t on the Alpha AXP is msemaphore instead of char
 200  * (see storage/ipc.h).
 201  */
 202 #define TAS(lock)       (msem_lock((lock), MSEM_IF_NOWAIT) < 0)
 203 #define S_UNLOCK(lock)  msem_unlock((lock), 0)
 204 #define S_INIT_LOCK(lock)       msem_init((lock), MSEM_UNLOCKED)
 205 #define S_LOCK_FREE(lock)       (!(lock)->msem_state)
 206 #endif   /* __alpha */
 207
 208
 209
 210 #if defined(NEED_I386_TAS_ASM)
 211 /* non gcc i386 based things */
 212
 213 #if defined(USE_UNIVEL_CC)
 214 #define TAS(lock)       tas(lock)
 215
 216 asm int
 217 tas(slock_t *s_lock)
 218 {
 219 /* UNIVEL wants %mem in column 1, so we don't pg_indent this file */
 220 %mem s_lock
 221         pushl %ebx
 222         movl s_lock, %ebx
 223         movl $255, %eax
 224         lock
 225         xchgb %al, (%ebx)
 226         popl %ebx
 227 }
 228
 229 #endif   /* USE_UNIVEL_CC */
 230
 231 #endif   /* NEED_I386_TAS_ASM */
 232
 233 #endif   /* defined(__GNUC__) */
 234
 235
 236
 237 /*************************************************************************
 238  * These are the platforms that have common code for gcc and non-gcc
 239  */
 240
 241 #if defined(__hpux)
 242 /*
 243  * HP-UX (PA-RISC)
 244  *
 245  * Note that slock_t on PA-RISC is a structure instead of char
 246  * (see include/port/hpux.h).
 247  *
 248  * a "set" slock_t has a single word cleared.  a "clear" slock_t has
 249  * all words set to non-zero. tas() in tas.s
 250  */
 251
 252 #define S_UNLOCK(lock) \
 253 { \
 254         volatile slock_t *lock_ = (volatile slock_t *) (lock); \
 255         lock_->sema[0] = lock_->sema[1] = lock_->sema[2] = lock_->sema[3] = -1; \
 256 }
 257
 258 #define S_LOCK_FREE(lock)       ( *(int *) (((long) (lock) + 15) & ~15) != 0)
 259
 260 #endif   /* __hpux */
 261
 262
 263 #if defined(__sgi)
 264 /*
 265  * SGI IRIX 5
 266  * slock_t is defined as a unsigned long. We use the standard SGI
 267  * mutex API.
 268  *
 269  * The following comment is left for historical reasons, but is probably
 270  * not a good idea since the mutex ABI is supported.
 271  *
 272  * This stuff may be supplemented in the future with Masato Kataoka's MIPS-II
 273  * assembly from his NECEWS SVR4 port, but we probably ought to retain this
 274  * for the R3000 chips out there.
 275  */
 276 #include <mutex.h>
 277 #define TAS(lock)       (test_and_set(lock,1))
 278 #define S_UNLOCK(lock)  (test_then_and(lock,0))
 279 #define S_INIT_LOCK(lock)       (test_then_and(lock,0))
 280 #define S_LOCK_FREE(lock)       (test_then_add(lock,0) == 0)
 281 #endif   /* __sgi */
 282
 283 #if defined(sinix)
 284 /*
 285  * SINIX / Reliant UNIX
 286  * slock_t is defined as a struct abilock_t, which has a single unsigned long
 287  * member. (Basically same as SGI)
 288  *
 289  */
 290 #define TAS(lock)       (!acquire_lock(lock))
 291 #define S_UNLOCK(lock)  release_lock(lock)
 292 #define S_INIT_LOCK(lock)       init_lock(lock)
 293 #define S_LOCK_FREE(lock)       (stat_lock(lock) == UNLOCKED)
 294 #endif   /* sinix */
 295
 296
 297 #if defined(_AIX)
 298 /*
 299  * AIX (POWER)
 300  *
 301  * Note that slock_t on POWER/POWER2/PowerPC is int instead of char
 302  * (see storage/ipc.h).
 303  */
 304 #define TAS(lock)       cs((int *) (lock), 0, 1)
 305 #endif   /* _AIX */
 306
 307
 308 #if defined (nextstep)
 309 /*
 310  * NEXTSTEP (mach)
 311  * slock_t is defined as a struct mutex.
 312  */
 313
 314 #define S_LOCK(lock)    mutex_lock(lock)
 315 #define S_UNLOCK(lock)  mutex_unlock(lock)
 316 #define S_INIT_LOCK(lock)       mutex_init(lock)
 317 /* For Mach, we have to delve inside the entrails of `struct mutex'.  Ick! */
 318 #define S_LOCK_FREE(alock)      ((alock)->lock == 0)
 319 #endif   /* nextstep */
 320
 321
 322
 323
 324 /****************************************************************************
 325  * Default Definitions - override these above as needed.
 326  */
 327
 328 #if !defined(S_LOCK)
 329 extern void s_lock(volatile slock_t *lock, const char *file, const int line);
 330
 331 #define S_LOCK(lock) \
 332         do { \
 333                 if (TAS((volatile slock_t *) lock)) \
 334                         s_lock((volatile slock_t *) lock, __FILE__, __LINE__); \
 335         } while (0)
 336 #endif   /* S_LOCK */
 337
 338 #if !defined(S_LOCK_FREE)
 339 #define S_LOCK_FREE(lock)       (*(lock) == 0)
 340 #endif   /* S_LOCK_FREE */
 341
 342 #if !defined(S_UNLOCK)
 343 #define S_UNLOCK(lock)          (*(lock) = 0)
 344 #endif   /* S_UNLOCK */
 345
 346 #if !defined(S_INIT_LOCK)
 347 #define S_INIT_LOCK(lock)       S_UNLOCK(lock)
 348 #endif   /* S_INIT_LOCK */
 349
 350 #if !defined(TAS)
 351 int                     tas(volatile slock_t *lock);            /* port/.../tas.s, or
 352                                                                                                  * s_lock.c */
 353
 354 #define TAS(lock)               tas((volatile slock_t *) lock)
 355 #endif   /* TAS */
 356
 357 #endif   /* HAS_TEST_AND_SET */
 358 #endif   /* S_LOCK_H */