libcfs/include/libcfs/linux/linux-prim.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   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.
  11  *
  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).
  17  *
  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
  21  *
  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
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * libcfs/include/libcfs/linux/linux-prim.h
  37  *
  38  * Basic library routines.
  39  */
  40
  41 #ifndef __LIBCFS_LINUX_CFS_PRIM_H__
  42 #define __LIBCFS_LINUX_CFS_PRIM_H__
  43
  44 #ifndef __LIBCFS_LIBCFS_H__
  45 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
  46 #endif
  47
  48 #ifndef __KERNEL__
  49 #error This include is only for kernel use.
  50 #endif
  51
  52 #ifndef AUTOCONF_INCLUDED
  53 #include <linux/config.h>
  54 #endif
  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>
  60 #include <linux/mm.h>
  61 #include <linux/timer.h>
  62 #include <linux/signal.h>
  63 #include <linux/sched.h>
  64 #include <linux/kthread.h>
  65
  66 #include <linux/miscdevice.h>
  67 #include <libcfs/linux/portals_compat25.h>
  68 #include <asm/div64.h>
  69
  70 #include <libcfs/linux/linux-time.h>
  71
  72 /*
  73  * Pseudo device register
  74  */
  75 typedef struct miscdevice               cfs_psdev_t;
  76 #define cfs_psdev_register(dev)         misc_register(dev)
  77 #define cfs_psdev_deregister(dev)       misc_deregister(dev)
  78
  79 /*
  80  * Sysctl register
  81  */
  82 typedef struct ctl_table                cfs_sysctl_table_t;
  83 typedef struct ctl_table_header         cfs_sysctl_table_header_t;
  84
  85 #ifdef HAVE_2ARGS_REGISTER_SYSCTL
  86 #define cfs_register_sysctl_table(t, a) register_sysctl_table(t, a)
  87 #else
  88 #define cfs_register_sysctl_table(t, a) register_sysctl_table(t)
  89 #endif
  90 #define cfs_unregister_sysctl_table(t)  unregister_sysctl_table(t)
  91
  92 #define DECLARE_PROC_HANDLER(name)                      \
  93 static int                                              \
  94 LL_PROC_PROTO(name)                                     \
  95 {                                                       \
  96         DECLARE_LL_PROC_PPOS_DECL;                      \
  97                                                         \
  98         return proc_call_handler(table->data, write,    \
  99                                  ppos, buffer, lenp,    \
 100                                  __##name);             \
 101 }
 102
 103 /*
 104  * Symbol register
 105  */
 106 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 107 #define cfs_symbol_register(s, p)       inter_module_register(s, THIS_MODULE, p)
 108 #define cfs_symbol_unregister(s)        inter_module_unregister(s)
 109 #define cfs_symbol_get(s)               inter_module_get(s)
 110 #define cfs_symbol_put(s)               inter_module_put(s)
 111 #define cfs_module_get()                MOD_INC_USE_COUNT
 112 #define cfs_module_put()                MOD_DEC_USE_COUNT
 113 #else
 114 #define cfs_symbol_register(s, p)       do {} while(0)
 115 #define cfs_symbol_unregister(s)        do {} while(0)
 116 #define cfs_symbol_get(s)               symbol_get(s)
 117 #define cfs_symbol_put(s)               symbol_put(s)
 118 #define cfs_module_get()                try_module_get(THIS_MODULE)
 119 #define cfs_module_put()                module_put(THIS_MODULE)
 120 #endif
 121
 122 /*
 123  * Proc file system APIs
 124  */
 125 typedef read_proc_t                     cfs_read_proc_t;
 126 typedef write_proc_t                    cfs_write_proc_t;
 127 typedef struct proc_dir_entry           cfs_proc_dir_entry_t;
 128 #define cfs_create_proc_entry(n, m, p)  create_proc_entry(n, m, p)
 129 #define cfs_free_proc_entry(e)          free_proc_entry(e)
 130 #define cfs_remove_proc_entry(n, e)     remove_proc_entry(n, e)
 131
 132 /*
 133  * Wait Queue
 134  */
 135 #define CFS_TASK_INTERRUPTIBLE          TASK_INTERRUPTIBLE
 136 #define CFS_TASK_UNINT                  TASK_UNINTERRUPTIBLE
 137 #define CFS_TASK_RUNNING                TASK_RUNNING
 138
 139 #define cfs_set_current_state(state) set_current_state(state)
 140
 141 typedef wait_queue_t                    cfs_waitlink_t;
 142 typedef wait_queue_head_t               cfs_waitq_t;
 143 typedef long                            cfs_task_state_t;
 144
 145 #define cfs_kthread_run(fn, data, fmt, arg...) kthread_run(fn, data, fmt, ##arg)
 146
 147 /* Kernel thread */
 148 typedef int (*cfs_thread_t)(void *);
 149
 150 static inline int cfs_kernel_thread(int (*fn)(void *),
 151                                     void *arg, unsigned long flags)
 152 {
 153         void *orig_info = current->journal_info;
 154         int rc;
 155
 156         current->journal_info = NULL;
 157         rc = kernel_thread(fn, arg, flags);
 158         current->journal_info = orig_info;
 159         return rc;
 160 }
 161
 162
 163 /*
 164  * Task struct
 165  */
 166 typedef struct task_struct              cfs_task_t;
 167 #define cfs_current()                   current
 168 #define cfs_task_lock(t)                task_lock(t)
 169 #define cfs_task_unlock(t)              task_unlock(t)
 170 #define CFS_DECL_JOURNAL_DATA           void *journal_info
 171 #define CFS_PUSH_JOURNAL                do {    \
 172         journal_info = current->journal_info;   \
 173         current->journal_info = NULL;           \
 174         } while(0)
 175 #define CFS_POP_JOURNAL                 do {    \
 176         current->journal_info = journal_info;   \
 177         } while(0)
 178
 179 /* Module interfaces */
 180 #define cfs_module(name, version, init, fini) \
 181 module_init(init);                            \
 182 module_exit(fini)
 183
 184 /*
 185  * Signal
 186  */
 187 typedef sigset_t                        cfs_sigset_t;
 188
 189 /*
 190  * Timer
 191  */
 192 typedef struct timer_list cfs_timer_t;
 193
 194 #define CFS_MAX_SCHEDULE_TIMEOUT MAX_SCHEDULE_TIMEOUT
 195
 196 #ifndef wait_event_timeout /* Only for RHEL3 2.4.21 kernel */
 197 #define __wait_event_timeout(wq, condition, timeout, ret)        \
 198 do {                                                             \
 199         int __ret = 0;                                           \
 200         if (!(condition)) {                                      \
 201                 wait_queue_t __wait;                             \
 202                 unsigned long expire;                            \
 203                                                                  \
 204                 init_waitqueue_entry(&__wait, current);          \
 205                 expire = timeout + jiffies;                      \
 206                 add_wait_queue(&wq, &__wait);                    \
 207                 for (;;) {                                       \
 208                         set_current_state(TASK_UNINTERRUPTIBLE); \
 209                         if (condition)                           \
 210                                 break;                           \
 211                         if (jiffies > expire) {                  \
 212                                 ret = jiffies - expire;          \
 213                                 break;                           \
 214                         }                                        \
 215                         schedule_timeout(timeout);               \
 216                 }                                                \
 217                 current->state = TASK_RUNNING;                   \
 218                 remove_wait_queue(&wq, &__wait);                 \
 219         }                                                        \
 220 } while (0)
 221 /*
 222    retval == 0; condition met; we're good.
 223    retval > 0; timed out.
 224 */
 225 #define cfs_waitq_wait_event_timeout(wq, condition, timeout, ret)    \
 226 do {                                                                 \
 227         ret = 0;                                                     \
 228         if (!(condition))                                            \
 229                 __wait_event_timeout(wq, condition, timeout, ret);   \
 230 } while (0)
 231 #else
 232 #define cfs_waitq_wait_event_timeout(wq, condition, timeout, ret)    \
 233         ret = wait_event_timeout(wq, condition, timeout)
 234 #endif
 235
 236 #ifndef wait_event_interruptible_timeout /* Only for RHEL3 2.4.21 kernel */
 237 #define __wait_event_interruptible_timeout(wq, condition, timeout, ret)   \
 238 do {                                                           \
 239         int __ret = 0;                                         \
 240         if (!(condition)) {                                    \
 241                 wait_queue_t __wait;                           \
 242                 unsigned long expire;                          \
 243                                                                \
 244                 init_waitqueue_entry(&__wait, current);        \
 245                 expire = timeout + jiffies;                    \
 246                 add_wait_queue(&wq, &__wait);                  \
 247                 for (;;) {                                     \
 248                         set_current_state(TASK_INTERRUPTIBLE); \
 249                         if (condition)                         \
 250                                 break;                         \
 251                         if (jiffies > expire) {                \
 252                                 ret = jiffies - expire;        \
 253                                 break;                         \
 254                         }                                      \
 255                         if (!signal_pending(current)) {        \
 256                                 schedule_timeout(timeout);     \
 257                                 continue;                      \
 258                         }                                      \
 259                         ret = -ERESTARTSYS;                    \
 260                         break;                                 \
 261                 }                                              \
 262                 current->state = TASK_RUNNING;                 \
 263                 remove_wait_queue(&wq, &__wait);               \
 264         }                                                      \
 265 } while (0)
 266
 267 /*
 268    retval == 0; condition met; we're good.
 269    retval < 0; interrupted by signal.
 270    retval > 0; timed out.
 271 */
 272 #define cfs_waitq_wait_event_interruptible_timeout(wq, condition, timeout, ret)\
 273 do {                                                              \
 274         ret = 0;                                                  \
 275         if (!(condition))                                         \
 276                 __wait_event_interruptible_timeout(wq, condition, \
 277                                                 timeout, ret);     \
 278 } while (0)
 279 #else
 280 #define cfs_waitq_wait_event_interruptible_timeout(wq, c, timeout, ret) \
 281         ret = wait_event_interruptible_timeout(wq, c, timeout)
 282 #endif
 283
 284 /*
 285  * atomic
 286  */
 287
 288 typedef atomic_t cfs_atomic_t;
 289
 290 #define cfs_atomic_read(atom)         atomic_read(atom)
 291 #define cfs_atomic_inc(atom)          atomic_inc(atom)
 292 #define cfs_atomic_dec(atom)          atomic_dec(atom)
 293 #define cfs_atomic_dec_and_test(atom) atomic_dec_and_test(atom)
 294 #define cfs_atomic_set(atom, value)   atomic_set(atom, value)
 295 #define cfs_atomic_add(value, atom)   atomic_add(value, atom)
 296 #define cfs_atomic_sub(value, atom)   atomic_sub(value, atom)
 297
 298 /*
 299  * membar
 300  */
 301
 302 #define cfs_mb() mb()
 303
 304 /*
 305  * interrupt
 306  */
 307
 308 #define cfs_in_interrupt() in_interrupt()
 309
 310 #endif