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.50 1998/09/21 02:25:27 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 #if defined(HAS_TEST_AND_SET)
  72
  73
  74 #if defined(__GNUC__)
  75 /*************************************************************************
  76  * All the gcc inlines
  77  */
  78
  79 #if defined(__alpha)
  80 #define TAS(lock) tas(lock)
  81 #define S_UNLOCK(lock) { __asm__("mb"); *(lock) = 0; }
  82
  83 static __inline__ int
  84 tas(volatile slock_t *lock)
  85 {
  86         register slock_t _res;
  87
  88 __asm__("    ldq   $0, %0              \n\
  89                  bne   $0, already_set     \n\
  90                  ldq_l $0, %0              \n\
  91                  bne   $0, already_set     \n\
  92                  or    $31, 1, $0          \n\
  93                  stq_c $0, %0              \n\
  94                  beq   $0, stqc_fail       \n\
  95         success: bis   $31, $31, %1        \n\
  96                  mb                                \n\
  97                  jmp   $31, end            \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");
 101
 102         return (int) _res;
 103 }
 104
 105 #endif   /* __alpha */
 106
 107
 108
 109 #if defined(i386)
 110 #define TAS(lock) tas(lock)
 111
 112 static __inline__ int
 113 tas(volatile slock_t *lock)
 114 {
 115         register slock_t _res = 1;
 116
 117 __asm__("lock; xchgb %0,%1": "=q"(_res), "=m"(*lock):"0"(_res));
 118         return (int) _res;
 119 }
 120
 121 #endif   /* i386 */
 122
 123
 124
 125 #if defined(sparc)
 126 #define TAS(lock) tas(lock)
 127
 128 static __inline__ int
 129 tas(volatile slock_t *lock)
 130 {
 131         register slock_t _res = 1;
 132
 133         __asm__("ldstub [%2], %0" \
 134 :                       "=r"(_res), "=m"(*lock) \
 135 :                       "r"(lock));
 136         return (int) _res;
 137 }
 138
 139 #endif   /* sparc */
 140
 141
 142
 143 #if defined(NEED_VAX_TAS_ASM)
 144 /*
 145  * VAXen -- even multiprocessor ones
 146  * (thanks to Tom Ivar Helbekkmo)
 147  */
 148 #define TAS(lock) tas(lock)
 149
 150 typedef unsigned char slock_t;
 151
 152 static __inline__ int
 153 tas(volatile slock_t *lock)
 154 {
 155         register        _res;
 156
 157         __asm__("       movl $1, r0 \
 158                         bbssi $0, (%1), 1 f \
 159                         clrl r0 \
 160 1:                      movl r0, %0 "
 161 :                       "=r"(_res)                      /* return value, in register */
 162 :                       "r"(lock)                       /* argument, 'lock pointer', in register */
 163 :                       "r0");                          /* inline code uses this register */
 164         return (int) _res;
 165 }
 166
 167 #endif   /* NEED_VAX_TAS_ASM */
 168
 169
 170
 171
 172 #else                                                   /* __GNUC__ */
 173 /***************************************************************************
 174  * All non gcc
 175  */
 176
 177 #if defined(__alpha)
 178 /*
 179  * OSF/1 (Alpha AXP)
 180  *
 181  * Note that slock_t on the Alpha AXP is msemaphore instead of char
 182  * (see storage/ipc.h).
 183  */
 184 #define TAS(lock)       (msem_lock((lock), MSEM_IF_NOWAIT) < 0)
 185 #define S_UNLOCK(lock)  msem_unlock((lock), 0)
 186 #define S_INIT_LOCK(lock)       msem_init((lock), MSEM_UNLOCKED)
 187 #define S_LOCK_FREE(lock)       (!(lock)->msem_state)
 188 #endif   /* __alpha */
 189
 190
 191
 192 #if defined(NEED_I386_TAS_ASM)
 193 /* non gcc i386 based things */
 194
 195 #if defined(USE_UNIVEL_CC)
 196 #define TAS(lock)       tas(lock)
 197
 198 asm int
 199 tas(slock_t *s_lock)
 200 {
 201 /* UNIVEL wants %mem in column 1, so we don't pg_indent this file */
 202 %mem s_lock
 203         pushl %ebx
 204         movl s_lock, %ebx
 205         movl $255, %eax
 206         lock
 207         xchgb %al, (%ebx)
 208         popl %ebx
 209 }
 210
 211 #endif   /* USE_UNIVEL_CC */
 212
 213 #endif   /* NEED_I386_TAS_ASM */
 214
 215
 216
 217 #if defined(NEED_NS32K_TAS_ASM)
 218
 219 #define S_LOCK(lock)                            \
 220 {                                               \
 221         slock_t res = 1;                                \
 222         while (res) {                           \
 223           __asm__("movqd 0, r0");                       \
 224           __asm__("sbitd r0, %0" : "=m"(*lock));        \
 225           __asm__("sprb us, %0" : "=r" (res));  \
 226           res = ((res >> 5) & 1);                       \
 227         }                                               \
 228 }
 229
 230 #endif   /* NEED_NS32K_TAS_ASM */
 231
 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 storage/ipc.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 static const slock_t clear_lock =
 252 {{-1, -1, -1, -1}};
 253
 254 #define S_UNLOCK(lock)  (*(lock) = clear_lock)  /* struct assignment */
 255 #define S_LOCK_FREE(lock)       ( *(int *) (((long) (lock) + 15) & ~15) != 0)
 256 #endif   /* __hpux */
 257
 258
 259 #if defined(__sgi)
 260 /*
 261  * SGI IRIX 5
 262  * slock_t is defined as a struct abilock_t, which has a single unsigned long
 263  * member.
 264  *
 265  * This stuff may be supplemented in the future with Masato Kataoka's MIPS-II
 266  * assembly from his NECEWS SVR4 port, but we probably ought to retain this
 267  * for the R3000 chips out there.
 268  */
 269 #include <mutex.h>
 270 #define TAS(lock)       (test_and_set(lock,1))
 271 #define S_UNLOCK(lock)  (test_then_and(lock,0))
 272 #define S_INIT_LOCK(lock)       (test_then_and(lock,0))
 273 #define S_LOCK_FREE(lock)       (test_then_add(lock,0) == 0)
 274 #endif   /* __sgi */
 275
 276 #if defined(sinix)
 277 /*
 278  * SINIX / Reliant UNIX
 279  * slock_t is defined as a struct abilock_t, which has a single unsigned long
 280  * member. (Basically same as SGI)
 281  *
 282  */
 283 #define TAS(lock)       (!acquire_lock(lock))
 284 #define S_UNLOCK(lock)  release_lock(lock)
 285 #define S_INIT_LOCK(lock)       init_lock(lock)
 286 #define S_LOCK_FREE(lock)       (stat_lock(lock) == UNLOCKED)
 287 #endif   /* sinix */
 288
 289
 290 #if defined(_AIX)
 291 /*
 292  * AIX (POWER)
 293  *
 294  * Note that slock_t on POWER/POWER2/PowerPC is int instead of char
 295  * (see storage/ipc.h).
 296  */
 297 #define TAS(lock)       cs((int *) (lock), 0, 1)
 298 #endif   /* _AIX */
 299
 300
 301 #if defined (nextstep)
 302 /*
 303  * NEXTSTEP (mach)
 304  * slock_t is defined as a struct mutex.
 305  */
 306
 307 #define S_LOCK(lock)    mutex_lock(lock)
 308 #define S_UNLOCK(lock)  mutex_unlock(lock)
 309 #define S_INIT_LOCK(lock)       mutex_init(lock)
 310 /* For Mach, we have to delve inside the entrails of `struct mutex'.  Ick! */
 311 #define S_LOCK_FREE(alock)      ((alock)->lock == 0)
 312 #endif   /* nextstep */
 313
 314
 315
 316
 317 /****************************************************************************
 318  * Default Definitions - override these above as needed.
 319  */
 320
 321 #if !defined(S_LOCK)
 322 extern void s_lock(volatile slock_t *lock, const char *file, const int line);
 323
 324 #define S_LOCK(lock) \
 325         if (TAS((volatile slock_t *) lock)) {\
 326                 s_lock((volatile slock_t *) lock, __FILE__, __LINE__); \
 327         } else
 328 #endif   /* S_LOCK */
 329
 330 #if !defined(S_LOCK_FREE)
 331 #define S_LOCK_FREE(lock)       (*(lock) == 0)
 332 #endif   /* S_LOCK_FREE */
 333
 334 #if !defined(S_UNLOCK)
 335 #define S_UNLOCK(lock)          (*(lock) = 0)
 336 #endif   /* S_UNLOCK */
 337
 338 #if !defined(S_INIT_LOCK)
 339 #define S_INIT_LOCK(lock)       S_UNLOCK(lock)
 340 #endif   /* S_INIT_LOCK */
 341
 342 #if !defined(TAS)
 343 int                     tas(volatile slock_t *lock);            /* port/.../tas.s, or
 344                                                                                                  * s_lock.c */
 345
 346 #define TAS(lock)               tas((volatile slock_t *) lock)
 347 #endif   /* TAS */
 348
 349 #endif   /* HAS_TEST_AND_SET */
 350 #endif   /* S_LOCK_H */