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
  65 #include <linux/miscdevice.h>
  66 #include <libcfs/linux/portals_compat25.h>
  67 #include <asm/div64.h>
  68
  69 #include <libcfs/linux/linux-time.h>
  70
  71 /*
  72  * Pseudo device register
  73  */
  74 typedef struct miscdevice               cfs_psdev_t;
  75 #define cfs_psdev_register(dev)         misc_register(dev)
  76 #define cfs_psdev_deregister(dev)       misc_deregister(dev)
  77
  78 /*
  79  * Sysctl register
  80  */
  81 typedef struct ctl_table                cfs_sysctl_table_t;
  82 typedef struct ctl_table_header         cfs_sysctl_table_header_t;
  83
  84 #ifdef HAVE_2ARGS_REGISTER_SYSCTL
  85 #define cfs_register_sysctl_table(t, a) register_sysctl_table(t, a)
  86 #else
  87 #define cfs_register_sysctl_table(t, a) register_sysctl_table(t)
  88 #endif
  89 #define cfs_unregister_sysctl_table(t)  unregister_sysctl_table(t)
  90
  91 #define DECLARE_PROC_HANDLER(name)                      \
  92 static int                                              \
  93 LL_PROC_PROTO(name)                                     \
  94 {                                                       \
  95         DECLARE_LL_PROC_PPOS_DECL;                      \
  96                                                         \
  97         return proc_call_handler(table->data, write,    \
  98                                  ppos, buffer, lenp,    \
  99                                  __##name);             \
 100 }
 101
 102 /*
 103  * Symbol register
 104  */
 105 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 106 #define cfs_symbol_register(s, p)       inter_module_register(s, THIS_MODULE, p)
 107 #define cfs_symbol_unregister(s)        inter_module_unregister(s)
 108 #define cfs_symbol_get(s)               inter_module_get(s)
 109 #define cfs_symbol_put(s)               inter_module_put(s)
 110 #define cfs_module_get()                MOD_INC_USE_COUNT
 111 #define cfs_module_put()                MOD_DEC_USE_COUNT
 112 #else
 113 #define cfs_symbol_register(s, p)       do {} while(0)
 114 #define cfs_symbol_unregister(s)        do {} while(0)
 115 #define cfs_symbol_get(s)               symbol_get(s)
 116 #define cfs_symbol_put(s)               symbol_put(s)
 117 #define cfs_module_get()                try_module_get(THIS_MODULE)
 118 #define cfs_module_put()                module_put(THIS_MODULE)
 119 #endif
 120
 121 /*
 122  * Proc file system APIs
 123  */
 124 typedef read_proc_t                     cfs_read_proc_t;
 125 typedef write_proc_t                    cfs_write_proc_t;
 126 typedef struct proc_dir_entry           cfs_proc_dir_entry_t;
 127 #define cfs_create_proc_entry(n, m, p)  create_proc_entry(n, m, p)
 128 #define cfs_free_proc_entry(e)          free_proc_entry(e)
 129 #define cfs_remove_proc_entry(n, e)     remove_proc_entry(n, e)
 130
 131 /*
 132  * Wait Queue
 133  */
 134 #define CFS_TASK_INTERRUPTIBLE          TASK_INTERRUPTIBLE
 135 #define CFS_TASK_UNINT                  TASK_UNINTERRUPTIBLE
 136 #define CFS_TASK_RUNNING                TASK_RUNNING
 137
 138 typedef wait_queue_t                    cfs_waitlink_t;
 139 typedef wait_queue_head_t               cfs_waitq_t;
 140 typedef long                            cfs_task_state_t;
 141
 142 /* Kernel thread */
 143 typedef int (*cfs_thread_t)(void *);
 144
 145 static inline int cfs_kernel_thread(int (*fn)(void *),
 146                                     void *arg, unsigned long flags)
 147 {
 148         void *orig_info = current->journal_info;
 149         int rc;
 150
 151         current->journal_info = NULL;
 152         rc = kernel_thread(fn, arg, flags);
 153         current->journal_info = orig_info;
 154         return rc;
 155 }
 156
 157
 158 /*
 159  * Task struct
 160  */
 161 typedef struct task_struct              cfs_task_t;
 162 #define cfs_current()                   current
 163 #define cfs_task_lock(t)                task_lock(t)
 164 #define cfs_task_unlock(t)              task_unlock(t)
 165 #define CFS_DECL_JOURNAL_DATA           void *journal_info
 166 #define CFS_PUSH_JOURNAL                do {    \
 167         journal_info = current->journal_info;   \
 168         current->journal_info = NULL;           \
 169         } while(0)
 170 #define CFS_POP_JOURNAL                 do {    \
 171         current->journal_info = journal_info;   \
 172         } while(0)
 173
 174 /* Module interfaces */
 175 #define cfs_module(name, version, init, fini) \
 176 module_init(init);                            \
 177 module_exit(fini)
 178
 179 /*
 180  * Signal
 181  */
 182 typedef sigset_t                        cfs_sigset_t;
 183
 184 /*
 185  * Timer
 186  */
 187 typedef struct timer_list cfs_timer_t;
 188
 189
 190 #ifndef wait_event_timeout /* Only for RHEL3 2.4.21 kernel */
 191 #define __wait_event_timeout(wq, condition, timeout, ret)        \
 192 do {                                                             \
 193         int __ret = 0;                                           \
 194         if (!(condition)) {                                      \
 195                 wait_queue_t __wait;                             \
 196                 unsigned long expire;                            \
 197                                                                  \
 198                 init_waitqueue_entry(&__wait, current);          \
 199                 expire = timeout + jiffies;                      \
 200                 add_wait_queue(&wq, &__wait);                    \
 201                 for (;;) {                                       \
 202                         set_current_state(TASK_UNINTERRUPTIBLE); \
 203                         if (condition)                           \
 204                                 break;                           \
 205                         if (jiffies > expire) {                  \
 206                                 ret = jiffies - expire;          \
 207                                 break;                           \
 208                         }                                        \
 209                         schedule_timeout(timeout);               \
 210                 }                                                \
 211                 current->state = TASK_RUNNING;                   \
 212                 remove_wait_queue(&wq, &__wait);                 \
 213         }                                                        \
 214 } while (0)
 215 /*
 216    retval == 0; condition met; we're good.
 217    retval > 0; timed out.
 218 */
 219 #define cfs_waitq_wait_event_timeout(wq, condition, timeout, ret)    \
 220 do {                                                                 \
 221         ret = 0;                                                     \
 222         if (!(condition))                                            \
 223                 __wait_event_timeout(wq, condition, timeout, ret);   \
 224 } while (0)
 225 #else
 226 #define cfs_waitq_wait_event_timeout(wq, condition, timeout, ret)    \
 227         ret = wait_event_timeout(wq, condition, timeout)
 228 #endif
 229
 230 #ifndef wait_event_interruptible_timeout /* Only for RHEL3 2.4.21 kernel */
 231 #define __wait_event_interruptible_timeout(wq, condition, timeout, ret)   \
 232 do {                                                           \
 233         int __ret = 0;                                         \
 234         if (!(condition)) {                                    \
 235                 wait_queue_t __wait;                           \
 236                 unsigned long expire;                          \
 237                                                                \
 238                 init_waitqueue_entry(&__wait, current);        \
 239                 expire = timeout + jiffies;                    \
 240                 add_wait_queue(&wq, &__wait);                  \
 241                 for (;;) {                                     \
 242                         set_current_state(TASK_INTERRUPTIBLE); \
 243                         if (condition)                         \
 244                                 break;                         \
 245                         if (jiffies > expire) {                \
 246                                 ret = jiffies - expire;        \
 247                                 break;                         \
 248                         }                                      \
 249                         if (!signal_pending(current)) {        \
 250                                 schedule_timeout(timeout);     \
 251                                 continue;                      \
 252                         }                                      \
 253                         ret = -ERESTARTSYS;                    \
 254                         break;                                 \
 255                 }                                              \
 256                 current->state = TASK_RUNNING;                 \
 257                 remove_wait_queue(&wq, &__wait);               \
 258         }                                                      \
 259 } while (0)
 260
 261 /*
 262    retval == 0; condition met; we're good.
 263    retval < 0; interrupted by signal.
 264    retval > 0; timed out.
 265 */
 266 #define cfs_waitq_wait_event_interruptible_timeout(wq, condition, timeout, ret)\
 267 do {                                                              \
 268         ret = 0;                                                  \
 269         if (!(condition))                                         \
 270                 __wait_event_interruptible_timeout(wq, condition, \
 271                                                 timeout, ret);     \
 272 } while (0)
 273 #else
 274 #define cfs_waitq_wait_event_interruptible_timeout(wq, c, timeout, ret) \
 275         ret = wait_event_interruptible_timeout(wq, c, timeout)
 276 #endif
 277
 278 #endif