libcfs/include/libcfs/user-lock.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * libcfs/include/libcfs/user-lock.h
  37  *
  38  * Author: Nikita Danilov <nikita@clusterfs.com>
  39  */
  40
  41 #ifndef __LIBCFS_USER_LOCK_H__
  42 #define __LIBCFS_USER_LOCK_H__
  43
  44 #ifndef __LIBCFS_LIBCFS_H__
  45 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
  46 #endif
  47
  48 /* Implementations of portable synchronization APIs for liblustre */
  49
  50 /*
  51  * liblustre is single-threaded, so most "synchronization" APIs are trivial.
  52  *
  53  * XXX Liang: There are several branches share lnet with b_hd_newconfig,
  54  * if we define lock APIs at here, there will be conflict with liblustre
  55  * in other branches.
  56  */
  57
  58 #ifndef __KERNEL__
  59
  60 /*
  61  * The userspace implementations of linux/spinlock.h vary; we just
  62  * include our own for all of them
  63  */
  64 #define __LINUX_SPINLOCK_H
  65
  66 /*
  67  * Optional debugging (magic stamping and checking ownership) can be added.
  68  */
  69
  70 /*
  71  * spin_lock
  72  *
  73  * - spin_lock_init(x)
  74  * - spin_lock(x)
  75  * - spin_lock_nested(x, subclass)
  76  * - spin_unlock(x)
  77  * - spin_trylock(x)
  78  *
  79  * - spin_lock_irqsave(x, f)
  80  * - spin_unlock_irqrestore(x, f)
  81  *
  82  * No-op implementation.
  83  */
  84 struct spin_lock {int foo;};
  85
  86 typedef struct spin_lock spinlock_t;
  87
  88 #define SPIN_LOCK_UNLOCKED (spinlock_t) { }
  89 #define LASSERT_SPIN_LOCKED(lock) do {} while(0)
  90 #define LASSERT_SEM_LOCKED(sem) do {} while(0)
  91
  92 void spin_lock_init(spinlock_t *lock);
  93 void spin_lock(spinlock_t *lock);
  94 void spin_lock_nested(spinlock_t *lock, unsigned int subclass);
  95 void spin_unlock(spinlock_t *lock);
  96 int spin_trylock(spinlock_t *lock);
  97 void spin_lock_bh_init(spinlock_t *lock);
  98 void spin_lock_bh(spinlock_t *lock);
  99 void spin_unlock_bh(spinlock_t *lock);
 100
 101 static inline int spin_is_locked(spinlock_t *l) {return 1;}
 102 static inline void spin_lock_irqsave(spinlock_t *l, unsigned long f){}
 103 static inline void spin_unlock_irqrestore(spinlock_t *l, unsigned long f){}
 104
 105 /*
 106  * Semaphore
 107  *
 108  * - sema_init(x, v)
 109  * - __down(x)
 110  * - __up(x)
 111  */
 112 typedef struct semaphore {
 113     int foo;
 114 } mutex_t;
 115
 116 void sema_init(struct semaphore *s, int val);
 117 void __down(struct semaphore *s);
 118 void __up(struct semaphore *s);
 119
 120 /*
 121  * Mutex:
 122  *
 123  * - init_mutex(x)
 124  * - init_mutex_locked(x)
 125  * - mutex_up(x)
 126  * - mutex_down(x)
 127  */
 128 #define DECLARE_MUTEX(name)     \
 129         struct semaphore name = { 1 }
 130
 131 #define mutex_up(s)                     __up(s)
 132 #define up(s)                           mutex_up(s)
 133 #define mutex_down(s)                   __down(s)
 134 #define down(s)                         mutex_down(s)
 135
 136 #define init_MUTEX(x)                   sema_init(x, 1)
 137 #define init_MUTEX_LOCKED(x)            sema_init(x, 0)
 138 #define init_mutex(s)                   init_MUTEX(s)
 139
 140 /*
 141  * Completion:
 142  *
 143  * - init_completion(c)
 144  * - complete(c)
 145  * - wait_for_completion(c)
 146  */
 147 struct completion {
 148         unsigned int done;
 149         cfs_waitq_t wait;
 150 };
 151
 152 void init_completion(struct completion *c);
 153 void complete(struct completion *c);
 154 void wait_for_completion(struct completion *c);
 155 int wait_for_completion_interruptible(struct completion *c);
 156
 157 #define COMPLETION_INITIALIZER(work) \
 158         { 0, __WAIT_QUEUE_HEAD_INITIALIZER((work).wait) }
 159
 160 #define DECLARE_COMPLETION(work) \
 161         struct completion work = COMPLETION_INITIALIZER(work)
 162
 163 #define INIT_COMPLETION(x)      ((x).done = 0)
 164
 165
 166 /*
 167  * rw_semaphore:
 168  *
 169  * - init_rwsem(x)
 170  * - down_read(x)
 171  * - up_read(x)
 172  * - down_write(x)
 173  * - up_write(x)
 174  */
 175 struct rw_semaphore {
 176         int foo;
 177 };
 178
 179 void init_rwsem(struct rw_semaphore *s);
 180 void down_read(struct rw_semaphore *s);
 181 int down_read_trylock(struct rw_semaphore *s);
 182 void down_write(struct rw_semaphore *s);
 183 int down_write_trylock(struct rw_semaphore *s);
 184 void up_read(struct rw_semaphore *s);
 185 void up_write(struct rw_semaphore *s);
 186
 187 /*
 188  * read-write lock : Need to be investigated more!!
 189  * XXX nikita: for now, let rwlock_t to be identical to rw_semaphore
 190  *
 191  * - DECLARE_RWLOCK(l)
 192  * - rwlock_init(x)
 193  * - read_lock(x)
 194  * - read_unlock(x)
 195  * - write_lock(x)
 196  * - write_unlock(x)
 197  */
 198 typedef struct rw_semaphore rwlock_t;
 199 #define RW_LOCK_UNLOCKED        (rwlock_t) { }
 200
 201 #define rwlock_init(pl)         init_rwsem(pl)
 202
 203 #define read_lock(l)            down_read(l)
 204 #define read_unlock(l)          up_read(l)
 205 #define write_lock(l)           down_write(l)
 206 #define write_unlock(l)         up_write(l)
 207
 208 static inline void
 209 write_lock_irqsave(rwlock_t *l, unsigned long f) { write_lock(l); }
 210 static inline void
 211 write_unlock_irqrestore(rwlock_t *l, unsigned long f) { write_unlock(l); }
 212
 213 static inline void
 214 read_lock_irqsave(rwlock_t *l, unsigned long f) { read_lock(l); }
 215 static inline void
 216 read_unlock_irqrestore(rwlock_t *l, unsigned long f) { read_unlock(l); }
 217
 218 /*
 219  * Atomic for user-space
 220  * Copied from liblustre
 221  */
 222 typedef struct { volatile int counter; } atomic_t;
 223
 224 #define ATOMIC_INIT(i) { (i) }
 225
 226 #define atomic_read(a) ((a)->counter)
 227 #define atomic_set(a,b) do {(a)->counter = b; } while (0)
 228 #define atomic_dec_and_test(a) ((--((a)->counter)) == 0)
 229 #define atomic_dec_and_lock(a,b) ((--((a)->counter)) == 0)
 230 #define atomic_inc(a)  (((a)->counter)++)
 231 #define atomic_dec(a)  do { (a)->counter--; } while (0)
 232 #define atomic_add(b,a)  do {(a)->counter += b;} while (0)
 233 #define atomic_add_return(n,a) ((a)->counter += n)
 234 #define atomic_inc_return(a) atomic_add_return(1,a)
 235 #define atomic_sub(b,a)  do {(a)->counter -= b;} while (0)
 236 #define atomic_sub_return(n,a) ((a)->counter -= n)
 237 #define atomic_dec_return(a)  atomic_sub_return(1,a)
 238
 239
 240 #ifdef HAVE_LIBPTHREAD
 241 #include <pthread.h>
 242
 243 /*
 244  * Completion
 245  */
 246
 247 struct cfs_completion {
 248         int c_done;
 249         pthread_cond_t c_cond;
 250         pthread_mutex_t c_mut;
 251 };
 252
 253 void cfs_init_completion(struct cfs_completion *c);
 254 void cfs_fini_completion(struct cfs_completion *c);
 255 void cfs_complete(struct cfs_completion *c);
 256 void cfs_wait_for_completion(struct cfs_completion *c);
 257
 258 /*
 259  * atomic.h
 260  */
 261
 262 typedef struct { volatile int counter; } cfs_atomic_t;
 263
 264 int cfs_atomic_read(cfs_atomic_t *a);
 265 void cfs_atomic_set(cfs_atomic_t *a, int b);
 266 int cfs_atomic_dec_and_test(cfs_atomic_t *a);
 267 void cfs_atomic_inc(cfs_atomic_t *a);
 268 void cfs_atomic_dec(cfs_atomic_t *a);
 269 void cfs_atomic_add(int b, cfs_atomic_t *a);
 270 void cfs_atomic_sub(int b, cfs_atomic_t *a);
 271
 272 #endif /* HAVE_LIBPTHREAD */
 273
 274 /**************************************************************************
 275  *
 276  * Mutex interface.
 277  *
 278  **************************************************************************/
 279
 280 struct mutex {
 281         struct semaphore m_sem;
 282 };
 283
 284 static inline void mutex_init(struct mutex *mutex)
 285 {
 286         init_mutex(&mutex->m_sem);
 287 }
 288
 289 static inline void mutex_lock(struct mutex *mutex)
 290 {
 291         mutex_down(&mutex->m_sem);
 292 }
 293
 294 static inline void mutex_unlock(struct mutex *mutex)
 295 {
 296         mutex_up(&mutex->m_sem);
 297 }
 298
 299 /**
 300  * Try-lock this mutex.
 301  *
 302  * \retval 1 try-lock succeeded.
 303  *
 304  * \retval 0 try-lock failed.
 305  */
 306 static inline int mutex_trylock(struct mutex *mutex)
 307 {
 308         return 1;
 309 }
 310
 311 static inline void mutex_lock_nested(struct mutex *mutex, unsigned int subclass)
 312 {
 313         return mutex_lock(mutex);
 314 }
 315
 316 static inline void mutex_destroy(struct mutex *lock)
 317 {
 318 }
 319
 320 /*
 321  * This is for use in assertions _only_, i.e., this function should always
 322  * return 1.
 323  *
 324  * \retval 1 mutex is locked.
 325  *
 326  * \retval 0 mutex is not locked. This should never happen.
 327  */
 328 static inline int mutex_is_locked(struct mutex *lock)
 329 {
 330         return 1;
 331 }
 332
 333
 334 /**************************************************************************
 335  *
 336  * Lockdep "implementation". Also see lustre_compat25.h
 337  *
 338  **************************************************************************/
 339
 340 struct lock_class_key {
 341         ;
 342 };
 343
 344 static inline void lockdep_set_class(void *lock, struct lock_class_key *key)
 345 {
 346 }
 347
 348 /* !__KERNEL__ */
 349 #endif
 350
 351 /* __LIBCFS_USER_LOCK_H__ */
 352 #endif
 353 /*
 354  * Local variables:
 355  * c-indentation-style: "K&R"
 356  * c-basic-offset: 8
 357  * tab-width: 8
 358  * fill-column: 80
 359  * scroll-step: 1
 360  * End:
 361  */