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-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 #ifndef AUTOCONF_INCLUDED
53 #include <linux/config.h>
55 #include <linux/module.h>
56 #include <linux/init.h>
57 #include <linux/kernel.h>
58 #include <linux/version.h>
59 #include <linux/proc_fs.h>
61 #include <linux/timer.h>
62 #include <linux/signal.h>
63 #include <linux/sched.h>
64 #include <linux/kthread.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>
72 #define CFS_KERN_EMERG KERN_EMERG
73 #define CFS_KERN_ALERT KERN_ALERT
74 #define CFS_KERN_CRIT KERN_CRIT
75 #define CFS_KERN_ERR KERN_ERR
76 #define CFS_KERN_WARNING KERN_WARNING
77 #define CFS_KERN_NOTICE KERN_NOTICE
78 #define CFS_KERN_INFO KERN_INFO
79 #define CFS_KERN_DEBUG KERN_DEBUG
84 #ifdef for_each_possible_cpu
85 #define cfs_for_each_possible_cpu(cpu) for_each_possible_cpu(cpu)
86 #elif defined(for_each_cpu)
87 #define cfs_for_each_possible_cpu(cpu) for_each_cpu(cpu)
91 #define CFS_NR_CPUS NR_CPUS
96 #define cfs_set_cpus_allowed(t, mask) set_cpus_allowed(t, mask)
100 #define CFS_L1_CACHE_ALIGN(x) L1_CACHE_ALIGN(x)
105 #define CFS_NR_IRQS NR_IRQS
107 #define CFS_EXPORT_SYMBOL(s) EXPORT_SYMBOL(s)
110 * Pseudo device register
112 typedef struct miscdevice cfs_psdev_t;
113 #define cfs_psdev_register(dev) misc_register(dev)
114 #define cfs_psdev_deregister(dev) misc_deregister(dev)
119 typedef struct ctl_table cfs_sysctl_table_t;
120 typedef struct ctl_table_header cfs_sysctl_table_header_t;
122 #ifdef HAVE_2ARGS_REGISTER_SYSCTL
123 #define cfs_register_sysctl_table(t, a) register_sysctl_table(t, a)
125 #define cfs_register_sysctl_table(t, a) register_sysctl_table(t)
127 #define cfs_unregister_sysctl_table(t) unregister_sysctl_table(t)
129 #define DECLARE_PROC_HANDLER(name) \
131 LL_PROC_PROTO(name) \
133 DECLARE_LL_PROC_PPOS_DECL; \
135 return proc_call_handler(table->data, write, \
136 ppos, buffer, lenp, \
143 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
144 #define cfs_symbol_register(s, p) inter_module_register(s, THIS_MODULE, p)
145 #define cfs_symbol_unregister(s) inter_module_unregister(s)
146 #define cfs_symbol_get(s) inter_module_get(s)
147 #define cfs_symbol_put(s) inter_module_put(s)
148 #define cfs_module_get() MOD_INC_USE_COUNT
150 #define cfs_symbol_register(s, p) do {} while(0)
151 #define cfs_symbol_unregister(s) do {} while(0)
152 #define cfs_symbol_get(s) symbol_get(s)
153 #define cfs_symbol_put(s) symbol_put(s)
154 #define cfs_module_get() try_module_get(THIS_MODULE)
155 #define cfs_try_module_get(m) try_module_get(m)
156 #define __cfs_module_get(m) __module_get(m)
157 #define cfs_module_put(m) module_put(m)
158 #define cfs_module_refcount(m) module_refcount(m)
161 typedef struct module cfs_module_t;
164 * Proc file system APIs
166 typedef read_proc_t cfs_read_proc_t;
167 typedef write_proc_t cfs_write_proc_t;
168 typedef struct proc_dir_entry cfs_proc_dir_entry_t;
169 #define cfs_create_proc_entry(n, m, p) create_proc_entry(n, m, p)
170 #define cfs_free_proc_entry(e) free_proc_entry(e)
171 #define cfs_remove_proc_entry(n, e) remove_proc_entry(n, e)
176 #define CFS_TASK_INTERRUPTIBLE TASK_INTERRUPTIBLE
177 #define CFS_TASK_UNINT TASK_UNINTERRUPTIBLE
178 #define CFS_TASK_RUNNING TASK_RUNNING
180 #define cfs_set_current_state(state) set_current_state(state)
181 #define cfs_wait_event(wq, cond) wait_event(wq, cond)
183 typedef wait_queue_t cfs_waitlink_t;
184 typedef wait_queue_head_t cfs_waitq_t;
185 typedef long cfs_task_state_t;
187 #define cfs_kthread_run(fn, data, fmt, arg...) kthread_run(fn, data, fmt, ##arg)
190 typedef int (*cfs_thread_t)(void *);
192 static inline int cfs_kernel_thread(int (*fn)(void *),
193 void *arg, unsigned long flags)
195 void *orig_info = current->journal_info;
198 current->journal_info = NULL;
199 rc = kernel_thread(fn, arg, flags);
200 current->journal_info = orig_info;
208 typedef struct task_struct cfs_task_t;
209 #define cfs_current() current
210 #define cfs_task_lock(t) task_lock(t)
211 #define cfs_task_unlock(t) task_unlock(t)
212 #define CFS_DECL_JOURNAL_DATA void *journal_info
213 #define CFS_PUSH_JOURNAL do { \
214 journal_info = current->journal_info; \
215 current->journal_info = NULL; \
217 #define CFS_POP_JOURNAL do { \
218 current->journal_info = journal_info; \
221 /* Module interfaces */
222 #define cfs_module(name, version, init, fini) \
225 #define cfs_request_module request_module
230 typedef sigset_t cfs_sigset_t;
235 typedef struct timer_list cfs_timer_t;
237 #define CFS_MAX_SCHEDULE_TIMEOUT MAX_SCHEDULE_TIMEOUT
239 #ifndef wait_event_timeout /* Only for RHEL3 2.4.21 kernel */
240 #define __wait_event_timeout(wq, condition, timeout, ret) \
243 if (!(condition)) { \
244 wait_queue_t __wait; \
245 unsigned long expire; \
247 init_waitqueue_entry(&__wait, current); \
248 expire = timeout + jiffies; \
249 add_wait_queue(&wq, &__wait); \
251 set_current_state(TASK_UNINTERRUPTIBLE); \
254 if (jiffies > expire) { \
255 ret = jiffies - expire; \
258 schedule_timeout(timeout); \
260 current->state = TASK_RUNNING; \
261 remove_wait_queue(&wq, &__wait); \
265 retval == 0; condition met; we're good.
266 retval > 0; timed out.
268 #define cfs_waitq_wait_event_timeout(wq, condition, timeout, ret) \
272 __wait_event_timeout(wq, condition, timeout, ret); \
275 #define cfs_waitq_wait_event_timeout(wq, condition, timeout, ret) \
276 ret = wait_event_timeout(wq, condition, timeout)
279 #ifndef wait_event_interruptible_timeout /* Only for RHEL3 2.4.21 kernel */
280 #define __wait_event_interruptible_timeout(wq, condition, timeout, ret) \
283 if (!(condition)) { \
284 wait_queue_t __wait; \
285 unsigned long expire; \
287 init_waitqueue_entry(&__wait, current); \
288 expire = timeout + jiffies; \
289 add_wait_queue(&wq, &__wait); \
291 set_current_state(TASK_INTERRUPTIBLE); \
294 if (jiffies > expire) { \
295 ret = jiffies - expire; \
298 if (!signal_pending(current)) { \
299 schedule_timeout(timeout); \
302 ret = -ERESTARTSYS; \
305 current->state = TASK_RUNNING; \
306 remove_wait_queue(&wq, &__wait); \
311 retval == 0; condition met; we're good.
312 retval < 0; interrupted by signal.
313 retval > 0; timed out.
315 #define cfs_waitq_wait_event_interruptible_timeout(wq, condition, timeout, ret)\
319 __wait_event_interruptible_timeout(wq, condition, \
323 #define cfs_waitq_wait_event_interruptible_timeout(wq, c, timeout, ret) \
324 ret = wait_event_interruptible_timeout(wq, c, timeout)
331 typedef atomic_t cfs_atomic_t;
333 #define cfs_atomic_read(atom) atomic_read(atom)
334 #define cfs_atomic_inc(atom) atomic_inc(atom)
335 #define cfs_atomic_inc_and_test(atom) atomic_inc_and_test(atom)
336 #define cfs_atomic_inc_return(atom) atomic_inc_return(atom)
337 #define cfs_atomic_inc_not_zero(atom) atomic_inc_not_zero(atom)
338 #define cfs_atomic_dec(atom) atomic_dec(atom)
339 #define cfs_atomic_dec_and_test(atom) atomic_dec_and_test(atom)
340 #define cfs_atomic_dec_and_lock(atom, lock) atomic_dec_and_lock(atom, lock)
341 #define cfs_atomic_dec_return(atom) atomic_dec_return(atom)
342 #define cfs_atomic_set(atom, value) atomic_set(atom, value)
343 #define cfs_atomic_add(value, atom) atomic_add(value, atom)
344 #define cfs_atomic_add_return(value, atom) atomic_add_return(value, atom)
345 #define cfs_atomic_sub(value, atom) atomic_sub(value, atom)
346 #define cfs_atomic_sub_and_test(value, atom) atomic_sub_and_test(value, atom)
347 #define cfs_atomic_sub_return(value, atom) atomic_sub_return(value, atom)
348 #define CFS_ATOMIC_INIT(i) ATOMIC_INIT(i)
354 #define cfs_mb() mb()
360 #define cfs_in_interrupt() in_interrupt()
365 #define cfs_might_sleep() might_sleep()
370 typedef struct group_info cfs_group_info_t;
372 #define cfs_get_group_info(group_info) get_group_info(group_info)
373 #define cfs_put_group_info(group_info) put_group_info(group_info)
374 #define cfs_set_current_groups(group_info) set_current_groups(group_info)
375 #define cfs_groups_free(group_info) groups_free(group_info)
376 #define cfs_groups_alloc(gidsetsize) groups_alloc(gidsetsize)
381 #define cfs_get_random_bytes(buf, nbytes) get_random_bytes(buf, nbytes)