libcfs/libcfs/user-lock.c

   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/libcfs/user-lock.c
  37  *
  38  * Author: Nikita Danilov <nikita@clusterfs.com>
  39  */
  40
  41 /* Implementations of portable synchronization APIs for liblustre */
  42
  43 /*
  44  * liblustre is single-threaded, so most "synchronization" APIs are trivial.
  45  *
  46  * XXX Liang: There are several branches share lnet with b_hd_newconfig,
  47  * if we define lock APIs at here, there will be conflict with liblustre
  48  * in other branches.
  49  */
  50
  51 #ifndef __KERNEL__
  52
  53 #include <libcfs/libcfs.h>
  54
  55 /*
  56  * Optional debugging (magic stamping and checking ownership) can be added.
  57  */
  58
  59 /*
  60  * spin_lock
  61  *
  62  * - spin_lock_init(x)
  63  * - spin_lock(x)
  64  * - spin_lock_nested(x, subclass)
  65  * - spin_unlock(x)
  66  * - spin_trylock(x)
  67  *
  68  * - spin_lock_irqsave(x, f)
  69  * - spin_unlock_irqrestore(x, f)
  70  *
  71  * No-op implementation.
  72  */
  73
  74 void spin_lock_init(spinlock_t *lock)
  75 {
  76         LASSERT(lock != NULL);
  77         (void)lock;
  78 }
  79
  80 void spin_lock(spinlock_t *lock)
  81 {
  82         (void)lock;
  83 }
  84
  85 void spin_unlock(spinlock_t *lock)
  86 {
  87         (void)lock;
  88 }
  89
  90 int spin_trylock(spinlock_t *lock)
  91 {
  92         (void)lock;
  93         return 1;
  94 }
  95
  96 void spin_lock_bh_init(spinlock_t *lock)
  97 {
  98         LASSERT(lock != NULL);
  99         (void)lock;
 100 }
 101
 102 void spin_lock_bh(spinlock_t *lock)
 103 {
 104         LASSERT(lock != NULL);
 105         (void)lock;
 106 }
 107
 108 void spin_unlock_bh(spinlock_t *lock)
 109 {
 110         LASSERT(lock != NULL);
 111         (void)lock;
 112 }
 113
 114 /*
 115  * Semaphore
 116  *
 117  * - sema_init(x, v)
 118  * - __down(x)
 119  * - __up(x)
 120  */
 121
 122 void sema_init(struct semaphore *s, int val)
 123 {
 124         LASSERT(s != NULL);
 125         (void)s;
 126         (void)val;
 127 }
 128
 129 void __down(struct semaphore *s)
 130 {
 131         LASSERT(s != NULL);
 132         (void)s;
 133 }
 134
 135 void __up(struct semaphore *s)
 136 {
 137         LASSERT(s != NULL);
 138         (void)s;
 139 }
 140
 141
 142 /*
 143  * Completion:
 144  *
 145  * - init_completion(c)
 146  * - complete(c)
 147  * - wait_for_completion(c)
 148  */
 149
 150 void init_completion(struct completion *c)
 151 {
 152         LASSERT(c != NULL);
 153         c->done = 0;
 154         cfs_waitq_init(&c->wait);
 155 }
 156
 157 void complete(struct completion *c)
 158 {
 159         LASSERT(c != NULL);
 160         c->done  = 1;
 161         cfs_waitq_signal(&c->wait);
 162 }
 163
 164 void wait_for_completion(struct completion *c)
 165 {
 166         LASSERT(c != NULL);
 167 }
 168
 169 int wait_for_completion_interruptible(struct completion *c)
 170 {
 171         LASSERT(c != NULL);
 172         return 0;
 173 }
 174
 175 /*
 176  * rw_semaphore:
 177  *
 178  * - DECLARE_RWSEM(x)
 179  * - init_rwsem(x)
 180  * - down_read(x)
 181  * - up_read(x)
 182  * - down_write(x)
 183  * - up_write(x)
 184  */
 185
 186 void init_rwsem(struct rw_semaphore *s)
 187 {
 188         LASSERT(s != NULL);
 189         (void)s;
 190 }
 191
 192 void down_read(struct rw_semaphore *s)
 193 {
 194         LASSERT(s != NULL);
 195         (void)s;
 196 }
 197
 198 int down_read_trylock(struct rw_semaphore *s)
 199 {
 200         LASSERT(s != NULL);
 201         (void)s;
 202         return 1;
 203 }
 204
 205 void down_write(struct rw_semaphore *s)
 206 {
 207         LASSERT(s != NULL);
 208         (void)s;
 209 }
 210
 211 int down_write_trylock(struct rw_semaphore *s)
 212 {
 213         LASSERT(s != NULL);
 214         (void)s;
 215         return 1;
 216 }
 217
 218 void up_read(struct rw_semaphore *s)
 219 {
 220         LASSERT(s != NULL);
 221         (void)s;
 222 }
 223
 224 void up_write(struct rw_semaphore *s)
 225 {
 226         LASSERT(s != NULL);
 227         (void)s;
 228 }
 229
 230 #ifdef HAVE_LIBPTHREAD
 231
 232 /*
 233  * Completion
 234  */
 235
 236 void cfs_init_completion(struct cfs_completion *c)
 237 {
 238         LASSERT(c != NULL);
 239         c->c_done = 0;
 240         pthread_mutex_init(&c->c_mut, NULL);
 241         pthread_cond_init(&c->c_cond, NULL);
 242 }
 243
 244 void cfs_fini_completion(struct cfs_completion *c)
 245 {
 246         LASSERT(c != NULL);
 247         pthread_mutex_destroy(&c->c_mut);
 248         pthread_cond_destroy(&c->c_cond);
 249 }
 250
 251 void cfs_complete(struct cfs_completion *c)
 252 {
 253         LASSERT(c != NULL);
 254         pthread_mutex_lock(&c->c_mut);
 255         c->c_done++;
 256         pthread_cond_signal(&c->c_cond);
 257         pthread_mutex_unlock(&c->c_mut);
 258 }
 259
 260 void cfs_wait_for_completion(struct cfs_completion *c)
 261 {
 262         LASSERT(c != NULL);
 263         pthread_mutex_lock(&c->c_mut);
 264         while (c->c_done == 0)
 265                 pthread_cond_wait(&c->c_cond, &c->c_mut);
 266         c->c_done--;
 267         pthread_mutex_unlock(&c->c_mut);
 268 }
 269
 270 /*
 271  * atomic primitives
 272  */
 273
 274 static pthread_mutex_t atomic_guard_lock = PTHREAD_MUTEX_INITIALIZER;
 275
 276 int cfs_atomic_read(cfs_atomic_t *a)
 277 {
 278         int r;
 279
 280         pthread_mutex_lock(&atomic_guard_lock);
 281         r = a->counter;
 282         pthread_mutex_unlock(&atomic_guard_lock);
 283         return r;
 284 }
 285
 286 void cfs_atomic_set(cfs_atomic_t *a, int b)
 287 {
 288         pthread_mutex_lock(&atomic_guard_lock);
 289         a->counter = b;
 290         pthread_mutex_unlock(&atomic_guard_lock);
 291 }
 292
 293 int cfs_atomic_dec_and_test(cfs_atomic_t *a)
 294 {
 295         int r;
 296
 297         pthread_mutex_lock(&atomic_guard_lock);
 298         r = --a->counter;
 299         pthread_mutex_unlock(&atomic_guard_lock);
 300         return (r == 0);
 301 }
 302
 303 void cfs_atomic_inc(cfs_atomic_t *a)
 304 {
 305         pthread_mutex_lock(&atomic_guard_lock);
 306         ++a->counter;
 307         pthread_mutex_unlock(&atomic_guard_lock);
 308 }
 309
 310 void cfs_atomic_dec(cfs_atomic_t *a)
 311 {
 312         pthread_mutex_lock(&atomic_guard_lock);
 313         --a->counter;
 314         pthread_mutex_unlock(&atomic_guard_lock);
 315 }
 316 void cfs_atomic_add(int b, cfs_atomic_t *a)
 317
 318 {
 319         pthread_mutex_lock(&atomic_guard_lock);
 320         a->counter += b;
 321         pthread_mutex_unlock(&atomic_guard_lock);
 322 }
 323
 324 void cfs_atomic_sub(int b, cfs_atomic_t *a)
 325 {
 326         pthread_mutex_lock(&atomic_guard_lock);
 327         a->counter -= b;
 328         pthread_mutex_unlock(&atomic_guard_lock);
 329 }
 330
 331 #endif /* HAVE_LIBPTHREAD */
 332
 333
 334 /* !__KERNEL__ */
 335 #endif
 336
 337 /*
 338  * Local variables:
 339  * c-indentation-style: "K&R"
 340  * c-basic-offset: 8
 341  * tab-width: 8
 342  * fill-column: 80
 343  * scroll-step: 1
 344  * End:
 345  */