4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, Intel Corporation.
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-prim.h
38 * Basic library routines.
41 #ifndef __LIBCFS_LINUX_CFS_PRIM_H__
42 #define __LIBCFS_LINUX_CFS_PRIM_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/module.h>
53 #include <linux/init.h>
54 #include <linux/kernel.h>
55 #include <linux/version.h>
56 #include <linux/proc_fs.h>
58 #include <linux/timer.h>
59 #include <linux/signal.h>
60 #include <linux/sched.h>
61 #include <linux/kthread.h>
62 #ifdef HAVE_LINUX_RANDOM_H
63 #include <linux/random.h>
66 #include <linux/miscdevice.h>
67 #include <libcfs/linux/portals_compat25.h>
68 #include <asm/div64.h>
70 #include <libcfs/linux/linux-time.h>
76 #ifdef for_each_possible_cpu
77 #define cfs_for_each_possible_cpu(cpu) for_each_possible_cpu(cpu)
78 #elif defined(for_each_cpu)
79 #define cfs_for_each_possible_cpu(cpu) for_each_cpu(cpu)
86 #define DECLARE_PROC_HANDLER(name) \
90 DECLARE_LL_PROC_PPOS_DECL; \
92 return proc_call_handler(table->data, write, \
98 * Proc file system APIs
100 typedef read_proc_t cfs_read_proc_t;
101 typedef write_proc_t cfs_write_proc_t;
102 typedef struct proc_dir_entry cfs_proc_dir_entry_t;
103 #define cfs_create_proc_entry(n, m, p) create_proc_entry(n, m, p)
104 #define cfs_free_proc_entry(e) free_proc_entry(e)
105 #define cfs_remove_proc_entry(n, e) remove_proc_entry(n, e)
112 #define CFS_DECL_WAITQ(wq) DECLARE_WAIT_QUEUE_HEAD(wq)
114 #define LIBCFS_WQITQ_MACROS 1
115 #define init_waitqueue_entry_current(w) init_waitqueue_entry(w, current)
116 #define waitq_wait(w, s) schedule()
117 #define waitq_timedwait(w, s, t) schedule_timeout(t)
119 #ifndef HAVE___ADD_WAIT_QUEUE_EXCLUSIVE
120 static inline void __add_wait_queue_exclusive(wait_queue_head_t *q,
123 wait->flags |= WQ_FLAG_EXCLUSIVE;
124 __add_wait_queue(q, wait);
126 #endif /* HAVE___ADD_WAIT_QUEUE_EXCLUSIVE */
129 * wait_queue_t of Linux (version < 2.6.34) is a FIFO list for exclusively
130 * waiting threads, which is not always desirable because all threads will
131 * be waken up again and again, even user only needs a few of them to be
132 * active most time. This is not good for performance because cache can
133 * be polluted by different threads.
135 * LIFO list can resolve this problem because we always wakeup the most
136 * recent active thread by default.
138 * NB: please don't call non-exclusive & exclusive wait on the same
139 * waitq if add_wait_queue_exclusive_head is used.
141 #define add_wait_queue_exclusive_head(waitq, link) \
143 unsigned long flags; \
145 spin_lock_irqsave(&((waitq)->lock), flags); \
146 __add_wait_queue_exclusive(waitq, link); \
147 spin_unlock_irqrestore(&((waitq)->lock), flags); \
150 #define schedule_timeout_and_set_state(state, timeout) \
152 set_current_state(state); \
153 schedule_timeout(timeout); \
156 /* deschedule for a bit... */
157 #define cfs_pause(ticks) \
159 set_current_state(TASK_UNINTERRUPTIBLE); \
160 schedule_timeout(ticks); \
163 #define DECL_JOURNAL_DATA void *journal_info
164 #define PUSH_JOURNAL do { \
165 journal_info = current->journal_info; \
166 current->journal_info = NULL; \
168 #define POP_JOURNAL do { \
169 current->journal_info = journal_info; \
172 /* Module interfaces */
173 #define cfs_module(name, version, init, fini) \
181 typedef atomic_t cfs_atomic_t;
183 #define cfs_atomic_read(atom) atomic_read(atom)
184 #define cfs_atomic_inc(atom) atomic_inc(atom)
185 #define cfs_atomic_inc_and_test(atom) atomic_inc_and_test(atom)
186 #define cfs_atomic_inc_return(atom) atomic_inc_return(atom)
187 #define cfs_atomic_inc_not_zero(atom) atomic_inc_not_zero(atom)
188 #define cfs_atomic_add_unless(atom, a, u) atomic_add_unless(atom, a, u)
189 #define cfs_atomic_dec(atom) atomic_dec(atom)
190 #define cfs_atomic_dec_and_test(atom) atomic_dec_and_test(atom)
191 #define cfs_atomic_dec_and_lock(atom, lock) atomic_dec_and_lock(atom, lock)
192 #define cfs_atomic_dec_return(atom) atomic_dec_return(atom)
193 #define cfs_atomic_set(atom, value) atomic_set(atom, value)
194 #define cfs_atomic_add(value, atom) atomic_add(value, atom)
195 #define cfs_atomic_add_return(value, atom) atomic_add_return(value, atom)
196 #define cfs_atomic_sub(value, atom) atomic_sub(value, atom)
197 #define cfs_atomic_sub_and_test(value, atom) atomic_sub_and_test(value, atom)
198 #define cfs_atomic_sub_return(value, atom) atomic_sub_return(value, atom)
199 #define cfs_atomic_cmpxchg(atom, old, nv) atomic_cmpxchg(atom, old, nv)
200 #define CFS_ATOMIC_INIT(i) ATOMIC_INIT(i)