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>
65 #ifdef HAVE_LINUX_RANDOM_H
66 #include <linux/random.h>
69 #include <linux/miscdevice.h>
70 #include <libcfs/linux/portals_compat25.h>
71 #include <asm/div64.h>
73 #include <libcfs/linux/linux-time.h>
75 #define CFS_KERN_EMERG KERN_EMERG
76 #define CFS_KERN_ALERT KERN_ALERT
77 #define CFS_KERN_CRIT KERN_CRIT
78 #define CFS_KERN_ERR KERN_ERR
79 #define CFS_KERN_WARNING KERN_WARNING
80 #define CFS_KERN_NOTICE KERN_NOTICE
81 #define CFS_KERN_INFO KERN_INFO
82 #define CFS_KERN_DEBUG KERN_DEBUG
87 #ifdef for_each_possible_cpu
88 #define cfs_for_each_possible_cpu(cpu) for_each_possible_cpu(cpu)
89 #elif defined(for_each_cpu)
90 #define cfs_for_each_possible_cpu(cpu) for_each_cpu(cpu)
94 #define CFS_NR_CPUS NR_CPUS
99 #define cfs_set_cpus_allowed(t, mask) set_cpus_allowed(t, mask)
103 #define CFS_L1_CACHE_ALIGN(x) L1_CACHE_ALIGN(x)
108 #define CFS_NR_IRQS NR_IRQS
110 #define CFS_EXPORT_SYMBOL(s) EXPORT_SYMBOL(s)
113 * Pseudo device register
115 typedef struct miscdevice cfs_psdev_t;
116 #define cfs_psdev_register(dev) misc_register(dev)
117 #define cfs_psdev_deregister(dev) misc_deregister(dev)
122 typedef struct ctl_table cfs_sysctl_table_t;
123 typedef struct ctl_table_header cfs_sysctl_table_header_t;
125 #ifdef HAVE_2ARGS_REGISTER_SYSCTL
126 #define cfs_register_sysctl_table(t, a) register_sysctl_table(t, a)
128 #define cfs_register_sysctl_table(t, a) register_sysctl_table(t)
130 #define cfs_unregister_sysctl_table(t) unregister_sysctl_table(t)
132 #define DECLARE_PROC_HANDLER(name) \
134 LL_PROC_PROTO(name) \
136 DECLARE_LL_PROC_PPOS_DECL; \
138 return proc_call_handler(table->data, write, \
139 ppos, buffer, lenp, \
146 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
147 #define cfs_symbol_register(s, p) inter_module_register(s, THIS_MODULE, p)
148 #define cfs_symbol_unregister(s) inter_module_unregister(s)
149 #define cfs_symbol_get(s) inter_module_get(s)
150 #define cfs_symbol_put(s) inter_module_put(s)
151 #define cfs_module_get() MOD_INC_USE_COUNT
153 #define cfs_symbol_register(s, p) do {} while(0)
154 #define cfs_symbol_unregister(s) do {} while(0)
155 #define cfs_symbol_get(s) symbol_get(s)
156 #define cfs_symbol_put(s) symbol_put(s)
157 #define cfs_module_get() try_module_get(THIS_MODULE)
158 #define cfs_try_module_get(m) try_module_get(m)
159 #define __cfs_module_get(m) __module_get(m)
160 #define cfs_module_put(m) module_put(m)
161 #define cfs_module_refcount(m) module_refcount(m)
164 typedef struct module cfs_module_t;
167 * Proc file system APIs
169 typedef read_proc_t cfs_read_proc_t;
170 typedef write_proc_t cfs_write_proc_t;
171 typedef struct proc_dir_entry cfs_proc_dir_entry_t;
172 #define cfs_create_proc_entry(n, m, p) create_proc_entry(n, m, p)
173 #define cfs_free_proc_entry(e) free_proc_entry(e)
174 #define cfs_remove_proc_entry(n, e) remove_proc_entry(n, e)
179 #define CFS_TASK_INTERRUPTIBLE TASK_INTERRUPTIBLE
180 #define CFS_TASK_UNINT TASK_UNINTERRUPTIBLE
181 #define CFS_TASK_RUNNING TASK_RUNNING
183 #define cfs_set_current_state(state) set_current_state(state)
184 #define cfs_wait_event(wq, cond) wait_event(wq, cond)
186 typedef wait_queue_t cfs_waitlink_t;
187 typedef wait_queue_head_t cfs_waitq_t;
188 typedef long cfs_task_state_t;
190 #define cfs_kthread_run(fn, data, fmt, arg...) kthread_run(fn, data, fmt, ##arg)
193 typedef int (*cfs_thread_t)(void *);
195 static inline int cfs_kernel_thread(int (*fn)(void *),
196 void *arg, unsigned long flags)
198 void *orig_info = current->journal_info;
201 current->journal_info = NULL;
202 rc = kernel_thread(fn, arg, flags);
203 current->journal_info = orig_info;
211 typedef struct task_struct cfs_task_t;
212 #define cfs_current() current
213 #define cfs_task_lock(t) task_lock(t)
214 #define cfs_task_unlock(t) task_unlock(t)
215 #define CFS_DECL_JOURNAL_DATA void *journal_info
216 #define CFS_PUSH_JOURNAL do { \
217 journal_info = current->journal_info; \
218 current->journal_info = NULL; \
220 #define CFS_POP_JOURNAL do { \
221 current->journal_info = journal_info; \
224 /* Module interfaces */
225 #define cfs_module(name, version, init, fini) \
228 #define cfs_request_module request_module
233 typedef sigset_t cfs_sigset_t;
238 typedef struct timer_list cfs_timer_t;
240 #define CFS_MAX_SCHEDULE_TIMEOUT MAX_SCHEDULE_TIMEOUT
242 #ifndef wait_event_timeout /* Only for RHEL3 2.4.21 kernel */
243 #define __wait_event_timeout(wq, condition, timeout, ret) \
246 if (!(condition)) { \
247 wait_queue_t __wait; \
248 unsigned long expire; \
250 init_waitqueue_entry(&__wait, current); \
251 expire = timeout + jiffies; \
252 add_wait_queue(&wq, &__wait); \
254 set_current_state(TASK_UNINTERRUPTIBLE); \
257 if (jiffies > expire) { \
258 ret = jiffies - expire; \
261 schedule_timeout(timeout); \
263 current->state = TASK_RUNNING; \
264 remove_wait_queue(&wq, &__wait); \
268 retval == 0; condition met; we're good.
269 retval > 0; timed out.
271 #define cfs_waitq_wait_event_timeout(wq, condition, timeout, ret) \
275 __wait_event_timeout(wq, condition, timeout, ret); \
278 #define cfs_waitq_wait_event_timeout(wq, condition, timeout, ret) \
279 ret = wait_event_timeout(wq, condition, timeout)
282 #ifndef wait_event_interruptible_timeout /* Only for RHEL3 2.4.21 kernel */
283 #define __wait_event_interruptible_timeout(wq, condition, timeout, ret) \
286 if (!(condition)) { \
287 wait_queue_t __wait; \
288 unsigned long expire; \
290 init_waitqueue_entry(&__wait, current); \
291 expire = timeout + jiffies; \
292 add_wait_queue(&wq, &__wait); \
294 set_current_state(TASK_INTERRUPTIBLE); \
297 if (jiffies > expire) { \
298 ret = jiffies - expire; \
301 if (!signal_pending(current)) { \
302 schedule_timeout(timeout); \
305 ret = -ERESTARTSYS; \
308 current->state = TASK_RUNNING; \
309 remove_wait_queue(&wq, &__wait); \
314 retval == 0; condition met; we're good.
315 retval < 0; interrupted by signal.
316 retval > 0; timed out.
318 #define cfs_waitq_wait_event_interruptible_timeout(wq, condition, timeout, ret)\
322 __wait_event_interruptible_timeout(wq, condition, \
326 #define cfs_waitq_wait_event_interruptible_timeout(wq, c, timeout, ret) \
327 ret = wait_event_interruptible_timeout(wq, c, timeout)
334 typedef atomic_t cfs_atomic_t;
336 #define cfs_atomic_read(atom) atomic_read(atom)
337 #define cfs_atomic_inc(atom) atomic_inc(atom)
338 #define cfs_atomic_inc_and_test(atom) atomic_inc_and_test(atom)
339 #define cfs_atomic_inc_return(atom) atomic_inc_return(atom)
340 #define cfs_atomic_inc_not_zero(atom) atomic_inc_not_zero(atom)
341 #define cfs_atomic_dec(atom) atomic_dec(atom)
342 #define cfs_atomic_dec_and_test(atom) atomic_dec_and_test(atom)
343 #define cfs_atomic_dec_and_lock(atom, lock) atomic_dec_and_lock(atom, lock)
344 #define cfs_atomic_dec_return(atom) atomic_dec_return(atom)
345 #define cfs_atomic_set(atom, value) atomic_set(atom, value)
346 #define cfs_atomic_add(value, atom) atomic_add(value, atom)
347 #define cfs_atomic_add_return(value, atom) atomic_add_return(value, atom)
348 #define cfs_atomic_sub(value, atom) atomic_sub(value, atom)
349 #define cfs_atomic_sub_and_test(value, atom) atomic_sub_and_test(value, atom)
350 #define cfs_atomic_sub_return(value, atom) atomic_sub_return(value, atom)
351 #define CFS_ATOMIC_INIT(i) ATOMIC_INIT(i)
357 #define cfs_mb() mb()
363 #define cfs_in_interrupt() in_interrupt()
368 #define cfs_might_sleep() might_sleep()
373 typedef struct group_info cfs_group_info_t;
375 #define cfs_get_group_info(group_info) get_group_info(group_info)
376 #define cfs_put_group_info(group_info) put_group_info(group_info)
377 #define cfs_set_current_groups(group_info) set_current_groups(group_info)
378 #define cfs_groups_free(group_info) groups_free(group_info)
379 #define cfs_groups_alloc(gidsetsize) groups_alloc(gidsetsize)
384 #define cfs_get_random_bytes_prim(buf, nbytes) get_random_bytes(buf, nbytes)