libcfs/include/libcfs/linux/linux-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/linux/linux-lock.h
  37  *
  38  * Basic library routines.
  39  */
  40
  41 #ifndef __LIBCFS_LINUX_CFS_LOCK_H__
  42 #define __LIBCFS_LINUX_CFS_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 #ifndef __KERNEL__
  49 #error This include is only for kernel use.
  50 #endif
  51
  52 #include <linux/smp_lock.h>
  53 #include <linux/mutex.h>
  54
  55 /*
  56  * IMPORTANT !!!!!!!!
  57  *
  58  * All locks' declaration are not guaranteed to be initialized,
  59  * Althought some of they are initialized in Linux. All locks
  60  * declared by CFS_DECL_* should be initialized explicitly.
  61  */
  62
  63
  64 /*
  65  * spin_lock (use Linux kernel's primitives)
  66  *
  67  * - spin_lock_init(x)
  68  * - spin_lock(x)
  69  * - spin_unlock(x)
  70  * - spin_trylock(x)
  71  *
  72  * - spin_lock_irqsave(x, f)
  73  * - spin_unlock_irqrestore(x, f)
  74  */
  75
  76 /*
  77  * rw_semaphore (use Linux kernel's primitives)
  78  *
  79  * - init_rwsem(x)
  80  * - down_read(x)
  81  * - up_read(x)
  82  * - down_write(x)
  83  * - up_write(x)
  84  */
  85 #define fini_rwsem(s) do {} while(0)
  86
  87 /*
  88  * rwlock_t (use Linux kernel's primitives)
  89  *
  90  * - rwlock_init(x)
  91  * - read_lock(x)
  92  * - read_unlock(x)
  93  * - write_lock(x)
  94  * - write_unlock(x)
  95  */
  96
  97 /*
  98  * mutex:
  99  *
 100  * - init_mutex(x)
 101  * - init_mutex_locked(x)
 102  * - mutex_up(x)
 103  * - mutex_down(x)
 104  */
 105 #define init_mutex(x)                   init_MUTEX(x)
 106 #define init_mutex_locked(x)            init_MUTEX_LOCKED(x)
 107 #define mutex_up(x)                     up(x)
 108 #define mutex_down(x)                   down(x)
 109 #define mutex_down_trylock(x)           down_trylock(x)
 110
 111 /*
 112  * completion (use Linux kernel's primitives)
 113  *
 114  * - init_complition(c)
 115  * - complete(c)
 116  * - wait_for_completion(c)
 117  */
 118
 119 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,16)
 120
 121 /**************************************************************************
 122  *
 123  * Mutex interface from newer Linux kernels.
 124  *
 125  * this augments compatibility interface from include/linux/mutex.h
 126  *
 127  **************************************************************************/
 128
 129 struct mutex;
 130
 131 static inline void mutex_destroy(struct mutex *lock)
 132 {
 133 }
 134
 135 /*
 136  * This is for use in assertions _only_, i.e., this function should always
 137  * return 1.
 138  *
 139  * \retval 1 mutex is locked.
 140  *
 141  * \retval 0 mutex is not locked. This should never happen.
 142  */
 143 static inline int mutex_is_locked(struct mutex *lock)
 144 {
 145         return 1;
 146 }
 147 #endif /* LINUX_VERSION_CODE < KERNEL_VERSION(2,6,16) */
 148
 149 #ifndef lockdep_set_class
 150
 151 /**************************************************************************
 152  *
 153  * Lockdep "implementation". Also see liblustre.h
 154  *
 155  **************************************************************************/
 156
 157 struct lock_class_key {
 158         ;
 159 };
 160
 161 # define lockdep_set_class(lock, key) \
 162         do { (void)sizeof (lock);(void)sizeof (key); } while (0)
 163
 164 /* This has to be a macro, so that `subclass' can be undefined in kernels that
 165  * do not support lockdep. */
 166 #ifndef mutex_lock_nested
 167 # define mutex_lock_nested(mutex, subclass) mutex_lock(mutex)
 168 #endif
 169
 170 #ifndef spin_lock_nested
 171 # define spin_lock_nested(lock, subclass) spin_lock(lock)
 172 #endif
 173
 174 #ifndef down_read_nested
 175 # define down_read_nested(lock, subclass) down_read(lock)
 176 #endif
 177
 178 #ifndef down_write_nested
 179 # define down_write_nested(lock, subclass) down_write(lock)
 180 #endif
 181
 182 #endif /* LINUX_VERSION_CODE < KERNEL_VERSION(2,6,18) */
 183
 184 #endif /* __LIBCFS_LINUX_CFS_LOCK_H__ */