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_lock_nested(spinlock_t *lock, unsigned int subclass)
  86 {
  87         (void)lock;
  88         (void)subclass;
  89 }
  90
  91 void spin_unlock(spinlock_t *lock)
  92 {
  93         (void)lock;
  94 }
  95
  96 int spin_trylock(spinlock_t *lock)
  97 {
  98         (void)lock;
  99         return 1;
 100 }
 101
 102 void spin_lock_bh_init(spinlock_t *lock)
 103 {
 104         LASSERT(lock != NULL);
 105         (void)lock;
 106 }
 107
 108 void spin_lock_bh(spinlock_t *lock)
 109 {
 110         LASSERT(lock != NULL);
 111         (void)lock;
 112 }
 113
 114 void spin_unlock_bh(spinlock_t *lock)
 115 {
 116         LASSERT(lock != NULL);
 117         (void)lock;
 118 }
 119
 120 /*
 121  * Semaphore
 122  *
 123  * - sema_init(x, v)
 124  * - __down(x)
 125  * - __up(x)
 126  */
 127
 128 void sema_init(struct semaphore *s, int val)
 129 {
 130         LASSERT(s != NULL);
 131         (void)s;
 132         (void)val;
 133 }
 134
 135 void __down(struct semaphore *s)
 136 {
 137         LASSERT(s != NULL);
 138         (void)s;
 139 }
 140
 141 void __up(struct semaphore *s)
 142 {
 143         LASSERT(s != NULL);
 144         (void)s;
 145 }
 146
 147
 148 /*
 149  * Completion:
 150  *
 151  * - init_completion(c)
 152  * - complete(c)
 153  * - wait_for_completion(c)
 154  */
 155
 156 void init_completion(struct completion *c)
 157 {
 158         LASSERT(c != NULL);
 159         c->done = 0;
 160         cfs_waitq_init(&c->wait);
 161 }
 162
 163 void complete(struct completion *c)
 164 {
 165         LASSERT(c != NULL);
 166         c->done  = 1;
 167         cfs_waitq_signal(&c->wait);
 168 }
 169
 170 void wait_for_completion(struct completion *c)
 171 {
 172         LASSERT(c != NULL);
 173 }
 174
 175 int wait_for_completion_interruptible(struct completion *c)
 176 {
 177         LASSERT(c != NULL);
 178         return 0;
 179 }
 180
 181 /*
 182  * rw_semaphore:
 183  *
 184  * - DECLARE_RWSEM(x)
 185  * - init_rwsem(x)
 186  * - down_read(x)
 187  * - up_read(x)
 188  * - down_write(x)
 189  * - up_write(x)
 190  */
 191
 192 void init_rwsem(struct rw_semaphore *s)
 193 {
 194         LASSERT(s != NULL);
 195         (void)s;
 196 }
 197
 198 void down_read(struct rw_semaphore *s)
 199 {
 200         LASSERT(s != NULL);
 201         (void)s;
 202 }
 203
 204 int down_read_trylock(struct rw_semaphore *s)
 205 {
 206         LASSERT(s != NULL);
 207         (void)s;
 208         return 1;
 209 }
 210
 211 void down_write(struct rw_semaphore *s)
 212 {
 213         LASSERT(s != NULL);
 214         (void)s;
 215 }
 216
 217 int down_write_trylock(struct rw_semaphore *s)
 218 {
 219         LASSERT(s != NULL);
 220         (void)s;
 221         return 1;
 222 }
 223
 224 void up_read(struct rw_semaphore *s)
 225 {
 226         LASSERT(s != NULL);
 227         (void)s;
 228 }
 229
 230 void up_write(struct rw_semaphore *s)
 231 {
 232         LASSERT(s != NULL);
 233         (void)s;
 234 }
 235
 236 #ifdef HAVE_LIBPTHREAD
 237
 238 /*
 239  * Completion
 240  */
 241
 242 void cfs_init_completion(struct cfs_completion *c)
 243 {
 244         LASSERT(c != NULL);
 245         c->c_done = 0;
 246         pthread_mutex_init(&c->c_mut, NULL);
 247         pthread_cond_init(&c->c_cond, NULL);
 248 }
 249
 250 void cfs_fini_completion(struct cfs_completion *c)
 251 {
 252         LASSERT(c != NULL);
 253         pthread_mutex_destroy(&c->c_mut);
 254         pthread_cond_destroy(&c->c_cond);
 255 }
 256
 257 void cfs_complete(struct cfs_completion *c)
 258 {
 259         LASSERT(c != NULL);
 260         pthread_mutex_lock(&c->c_mut);
 261         c->c_done++;
 262         pthread_cond_signal(&c->c_cond);
 263         pthread_mutex_unlock(&c->c_mut);
 264 }
 265
 266 void cfs_wait_for_completion(struct cfs_completion *c)
 267 {
 268         LASSERT(c != NULL);
 269         pthread_mutex_lock(&c->c_mut);
 270         while (c->c_done == 0)
 271                 pthread_cond_wait(&c->c_cond, &c->c_mut);
 272         c->c_done--;
 273         pthread_mutex_unlock(&c->c_mut);
 274 }
 275
 276 /*
 277  * atomic primitives
 278  */
 279
 280 static pthread_mutex_t atomic_guard_lock = PTHREAD_MUTEX_INITIALIZER;
 281
 282 int cfs_atomic_read(cfs_atomic_t *a)
 283 {
 284         int r;
 285
 286         pthread_mutex_lock(&atomic_guard_lock);
 287         r = a->counter;
 288         pthread_mutex_unlock(&atomic_guard_lock);
 289         return r;
 290 }
 291
 292 void cfs_atomic_set(cfs_atomic_t *a, int b)
 293 {
 294         pthread_mutex_lock(&atomic_guard_lock);
 295         a->counter = b;
 296         pthread_mutex_unlock(&atomic_guard_lock);
 297 }
 298
 299 int cfs_atomic_dec_and_test(cfs_atomic_t *a)
 300 {
 301         int r;
 302
 303         pthread_mutex_lock(&atomic_guard_lock);
 304         r = --a->counter;
 305         pthread_mutex_unlock(&atomic_guard_lock);
 306         return (r == 0);
 307 }
 308
 309 void cfs_atomic_inc(cfs_atomic_t *a)
 310 {
 311         pthread_mutex_lock(&atomic_guard_lock);
 312         ++a->counter;
 313         pthread_mutex_unlock(&atomic_guard_lock);
 314 }
 315
 316 void cfs_atomic_dec(cfs_atomic_t *a)
 317 {
 318         pthread_mutex_lock(&atomic_guard_lock);
 319         --a->counter;
 320         pthread_mutex_unlock(&atomic_guard_lock);
 321 }
 322 void cfs_atomic_add(int b, cfs_atomic_t *a)
 323
 324 {
 325         pthread_mutex_lock(&atomic_guard_lock);
 326         a->counter += b;
 327         pthread_mutex_unlock(&atomic_guard_lock);
 328 }
 329
 330 void cfs_atomic_sub(int b, cfs_atomic_t *a)
 331 {
 332         pthread_mutex_lock(&atomic_guard_lock);
 333         a->counter -= b;
 334         pthread_mutex_unlock(&atomic_guard_lock);
 335 }
 336
 337 #endif /* HAVE_LIBPTHREAD */
 338
 339
 340 /* !__KERNEL__ */
 341 #endif
 342
 343 /*
 344  * Local variables:
 345  * c-indentation-style: "K&R"
 346  * c-basic-offset: 8
 347  * tab-width: 8
 348  * fill-column: 80
 349  * scroll-step: 1
 350  * End:
 351  */