1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
29 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * libcfs/include/libcfs/linux/linux-lock.h
38 * Basic library routines.
41 #ifndef __LIBCFS_LINUX_CFS_LOCK_H__
42 #define __LIBCFS_LINUX_CFS_LOCK_H__
44 #ifndef __LIBCFS_LIBCFS_H__
45 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
49 #error This include is only for kernel use.
52 #include <linux/smp_lock.h>
53 #include <linux/mutex.h>
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.
64 * spin_lock "implementation" (use Linux kernel's primitives)
69 * - spin_lock_bh_init(x)
76 * - spin_lock_irqsave(x, f)
77 * - spin_unlock_irqrestore(x, f)
78 * - read_lock_irqsave(lock, f)
79 * - write_lock_irqsave(lock, f)
80 * - write_unlock_irqrestore(lock, f)
82 * - SPIN_LOCK_UNLOCKED
86 * spinlock "implementation"
89 typedef spinlock_t cfs_spinlock_t;
91 #define cfs_spin_lock_init(lock) spin_lock_init(lock)
92 #define cfs_spin_lock(lock) spin_lock(lock)
93 #define cfs_spin_lock_bh(lock) spin_lock_bh(lock)
94 #define cfs_spin_lock_bh_init(lock) spin_lock_bh_init(lock)
95 #define cfs_spin_unlock(lock) spin_unlock(lock)
96 #define cfs_spin_unlock_bh(lock) spin_unlock_bh(lock)
97 #define cfs_spin_trylock(lock) spin_trylock(lock)
98 #define cfs_spin_is_locked(lock) spin_is_locked(lock)
100 #define cfs_spin_lock_irq(lock) spin_lock_irq(lock)
101 #define cfs_spin_unlock_irq(lock) spin_unlock_irq(lock)
102 #define cfs_read_lock_irqsave(lock, f) read_lock_irqsave(lock, f)
103 #define cfs_write_lock_irqsave(lock, f) write_lock_irqsave(lock, f)
104 #define cfs_write_unlock_irqrestore(lock, f) write_unlock_irqrestore(lock, f)
105 #define cfs_spin_lock_irqsave(lock, f) spin_lock_irqsave(lock, f)
106 #define cfs_spin_unlock_irqrestore(lock, f) spin_unlock_irqrestore(lock, f)
108 #define CFS_SPIN_LOCK_UNLOCKED SPIN_LOCK_UNLOCKED
111 * rw_semaphore "implementation" (use Linux kernel's primitives)
120 typedef struct rw_semaphore cfs_rw_semaphore_t;
122 #define cfs_sema_init(s, val) sema_init(s, val)
123 #define cfs_init_rwsem(s) init_rwsem(s)
124 #define cfs_down_read(s) down_read(s)
125 #define cfs_down_read_trylock(s) down_read_trylock(s)
126 #define cfs_up_read(s) up_read(s)
127 #define cfs_down_write(s) down_write(s)
128 #define cfs_down_write_trylock(s) down_write_trylock(s)
129 #define cfs_up_write(s) up_write(s)
131 #define cfs_fini_rwsem(s) do {} while(0)
133 #define CFS_DECLARE_RWSEM(name) DECLARE_RWSEM(name)
136 * semaphore "implementation" (use Linux kernel's primitives)
138 typedef struct semaphore cfs_semaphore_t;
141 * rwlock_t "implementation" (use Linux kernel's primitives)
149 * - write_unlock_bh(x)
153 typedef rwlock_t cfs_rwlock_t;
155 #define cfs_rwlock_init(lock) rwlock_init(lock)
156 #define cfs_read_lock(lock) read_lock(lock)
157 #define cfs_read_unlock(lock) read_unlock(lock)
158 #define cfs_read_unlock_irqrestore(lock,flags) \
159 read_unlock_irqrestore(lock, flags)
160 #define cfs_write_lock(lock) write_lock(lock)
161 #define cfs_write_unlock(lock) write_unlock(lock)
162 #define cfs_write_lock_bh(lock) write_lock_bh(lock)
163 #define cfs_write_unlock_bh(lock) write_unlock_bh(lock)
165 #define CFS_RW_LOCK_UNLOCKED RW_LOCK_UNLOCKED
168 * completion "implementation" (use Linux kernel's primitives)
170 * - DECLARE_COMPLETION(work)
171 * - INIT_COMPLETION(c)
172 * - COMPLETION_INITIALIZER(work)
173 * - init_completion(c)
175 * - wait_for_completion(c)
176 * - wait_for_completion_interruptible(c)
177 * - fini_completion(c)
179 typedef struct completion cfs_completion_t;
181 #define CFS_DECLARE_COMPLETION(work) DECLARE_COMPLETION(work)
182 #define CFS_INIT_COMPLETION(c) INIT_COMPLETION(c)
183 #define CFS_COMPLETION_INITIALIZER(work) COMPLETION_INITIALIZER(work)
184 #define cfs_init_completion(c) init_completion(c)
185 #define cfs_complete(c) complete(c)
186 #define cfs_wait_for_completion(c) wait_for_completion(c)
187 #define cfs_wait_for_completion_interruptible(c) \
188 wait_for_completion_interruptible(c)
189 #define cfs_complete_and_exit(c, code) complete_and_exit(c, code)
190 #define cfs_fini_completion(c) do { } while (0)
193 * mutex "implementation" (use Linux kernel's primitives)
195 * - DECLARE_MUTEX(name)
198 * - init_mutex_locked(x)
199 * - init_MUTEX_LOCKED(x)
204 * - mutex_down_trylock(x)
208 typedef struct mutex cfs_mutex_t;
210 #define CFS_DEFINE_MUTEX(name) DEFINE_MUTEX(name)
211 #define CFS_DECLARE_MUTEX(name) DECLARE_MUTEX(name)
213 #define cfs_mutex_init(x) mutex_init(x)
214 #define cfs_init_mutex(x) init_MUTEX(x)
215 #define cfs_init_mutex_locked(x) init_MUTEX_LOCKED(x)
216 #define cfs_mutex_up(x) up(x)
217 #define cfs_mutex_down(x) down(x)
218 #define cfs_up(x) up(x)
219 #define cfs_down(x) down(x)
220 #define cfs_mutex_down_trylock(x) down_trylock(x)
221 #define cfs_mutex_lock(x) mutex_lock(x)
222 #define cfs_mutex_unlock(x) mutex_unlock(x)
223 #define cfs_mutex_trylock(x) mutex_trylock(x)
225 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,16)
227 /**************************************************************************
229 * Mutex interface from newer Linux kernels.
231 * this augments compatibility interface from include/linux/mutex.h
233 **************************************************************************/
235 static inline void cfs_mutex_destroy(cfs_mutex_t *lock)
240 * This is for use in assertions _only_, i.e., this function should always
243 * \retval 1 mutex is locked.
245 * \retval 0 mutex is not locked. This should never happen.
247 static inline int cfs_mutex_is_locked(cfs_mutex_t *lock)
251 #else /* LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,16) */
252 #define cfs_mutex_destroy(x) mutex_destroy(x)
253 #define cfs_mutex_is_locked(x) mutex_is_locked(x)
254 #endif /* LINUX_VERSION_CODE < KERNEL_VERSION(2,6,16) */
257 * Kernel locking primitives
262 #define cfs_lock_kernel() lock_kernel()
263 #define cfs_unlock_kernel() unlock_kernel()
265 #ifndef lockdep_set_class
267 /**************************************************************************
269 * Lockdep "implementation". Also see liblustre.h
271 **************************************************************************/
273 typedef struct cfs_lock_class_key {
275 } cfs_lock_class_key_t;
277 #define cfs_lockdep_set_class(lock, key) \
278 do { (void)sizeof (lock);(void)sizeof (key); } while (0)
279 /* This has to be a macro, so that `subclass' can be undefined in kernels that
280 * do not support lockdep. */
283 static inline void cfs_lockdep_off(void)
287 static inline void cfs_lockdep_on(void)
291 typedef struct lock_class_key cfs_lock_class_key_t;
293 #define cfs_lockdep_set_class(lock, key) lockdep_set_class(lock, key)
294 #define cfs_lockdep_off() lockdep_off()
295 #define cfs_lockdep_on() lockdep_on()
296 #endif /* lockdep_set_class */
298 #ifndef CONFIG_DEBUG_LOCK_ALLOC
299 #ifndef mutex_lock_nested
300 #define cfs_mutex_lock_nested(mutex, subclass) mutex_lock(mutex)
302 #define cfs_mutex_lock_nested(mutex, subclass) \
303 mutex_lock_nested(mutex, subclass)
306 #ifndef spin_lock_nested
307 #define cfs_spin_lock_nested(lock, subclass) spin_lock(lock)
309 #define cfs_spin_lock_nested(lock, subclass) spin_lock_nested(lock, subclass)
312 #ifndef down_read_nested
313 #define cfs_down_read_nested(lock, subclass) down_read(lock)
315 #define cfs_down_read_nested(lock, subclass) down_read_nested(lock, subclass)
318 #ifndef down_write_nested
319 #define cfs_down_write_nested(lock, subclass) down_write(lock)
321 #define cfs_down_write_nested(lock, subclass) down_write_nested(lock, subclass)
323 #else /* CONFIG_DEBUG_LOCK_ALLOC is defined */
324 #define cfs_mutex_lock_nested(mutex, subclass) \
325 mutex_lock_nested(mutex, subclass)
326 #define cfs_spin_lock_nested(lock, subclass) spin_lock_nested(lock, subclass)
327 #define cfs_down_read_nested(lock, subclass) down_read_nested(lock, subclass)
328 #define cfs_down_write_nested(lock, subclass) down_write_nested(lock, subclass)
329 #endif /* CONFIG_DEBUG_LOCK_ALLOC */
332 #endif /* __LIBCFS_LINUX_CFS_LOCK_H__ */