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 2008 Sun Microsystems, Inc. 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.
65 * spin_lock (use Linux kernel's primitives)
72 * - spin_lock_irqsave(x, f)
73 * - spin_unlock_irqrestore(x, f)
77 * rw_semaphore (use Linux kernel's primitives)
87 * rwlock_t (use Linux kernel's primitives)
100 * - init_mutex_locked(x)
104 #define init_mutex(x) init_MUTEX(x)
105 #define init_mutex_locked(x) init_MUTEX_LOCKED(x)
106 #define mutex_up(x) up(x)
107 #define mutex_down(x) down(x)
108 #define mutex_down_trylock(x) down_trylock(x)
111 * completion (use Linux kernel's primitives)
113 * - init_complition(c)
115 * - wait_for_completion(c)
118 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,16)
120 /**************************************************************************
122 * Mutex interface from newer Linux kernels.
124 * this augments compatibility interface from include/linux/mutex.h
126 **************************************************************************/
130 static inline void mutex_destroy(struct mutex *lock)
135 * This is for use in assertions _only_, i.e., this function should always
138 * \retval 1 mutex is locked.
140 * \retval 0 mutex is not locked. This should never happen.
142 static inline int mutex_is_locked(struct mutex *lock)
146 #endif /* LINUX_VERSION_CODE < KERNEL_VERSION(2,6,16) */
148 #ifndef lockdep_set_class
150 /**************************************************************************
152 * Lockdep "implementation". Also see liblustre.h
154 **************************************************************************/
156 struct lock_class_key {
160 # define lockdep_set_class(lock, key) \
161 do { (void)sizeof (lock);(void)sizeof (key); } while (0)
163 /* This has to be a macro, so that `subclass' can be undefined in kernels that
164 * do not support lockdep. */
165 #ifndef mutex_lock_nested
166 # define mutex_lock_nested(mutex, subclass) mutex_lock(mutex)
169 #ifndef spin_lock_nested
170 # define spin_lock_nested(lock, subclass) spin_lock(lock)
173 #ifndef down_read_nested
174 # define down_read_nested(lock, subclass) down_read(lock)
177 #ifndef down_write_nested
178 # define down_write_nested(lock, subclass) down_write(lock)
181 #endif /* LINUX_VERSION_CODE < KERNEL_VERSION(2,6,18) */
183 #endif /* __LIBCFS_LINUX_CFS_LOCK_H__ */