lnet/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  * lnet/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 #ifdef __KERNEL__
  49 #ifndef AUTOCONF_INCLUDED
  50 #include <linux/config.h>
  51 #endif
  52 #include <linux/module.h>
  53 #include <linux/kernel.h>
  54 #include <linux/version.h>
  55 #include <linux/proc_fs.h>
  56 #include <linux/mm.h>
  57 #include <linux/timer.h>
  58 #include <linux/signal.h>
  59 #include <linux/sched.h>
  60
  61 #include <linux/miscdevice.h>
  62 #include <libcfs/linux/portals_compat25.h>
  63 #include <asm/div64.h>
  64
  65 #include <libcfs/linux/linux-time.h>
  66
  67 /*
  68  * Pseudo device register
  69  */
  70 typedef struct miscdevice               cfs_psdev_t;
  71 #define cfs_psdev_register(dev)         misc_register(dev)
  72 #define cfs_psdev_deregister(dev)       misc_deregister(dev)
  73
  74 /*
  75  * Sysctl register
  76  */
  77 typedef struct ctl_table                cfs_sysctl_table_t;
  78 typedef struct ctl_table_header         cfs_sysctl_table_header_t;
  79
  80 #ifdef HAVE_2ARGS_REGISTER_SYSCTL
  81 #define cfs_register_sysctl_table(t, a) register_sysctl_table(t, a)
  82 #else
  83 #define cfs_register_sysctl_table(t, a) register_sysctl_table(t)
  84 #endif
  85 #define cfs_unregister_sysctl_table(t)  unregister_sysctl_table(t)
  86
  87 #define DECLARE_PROC_HANDLER(name)                      \
  88 static int                                              \
  89 LL_PROC_PROTO(name)                                     \
  90 {                                                       \
  91         DECLARE_LL_PROC_PPOS_DECL;                      \
  92                                                         \
  93         return proc_call_handler(table->data, write,    \
  94                                  ppos, buffer, lenp,    \
  95                                  __##name);             \
  96 }
  97
  98 /*
  99  * Symbol register
 100  */
 101 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 102 #define cfs_symbol_register(s, p)       inter_module_register(s, THIS_MODULE, p)
 103 #define cfs_symbol_unregister(s)        inter_module_unregister(s)
 104 #define cfs_symbol_get(s)               inter_module_get(s)
 105 #define cfs_symbol_put(s)               inter_module_put(s)
 106 #define cfs_module_get()                MOD_INC_USE_COUNT
 107 #define cfs_module_put()                MOD_DEC_USE_COUNT
 108 #else
 109 #define cfs_symbol_register(s, p)       do {} while(0)
 110 #define cfs_symbol_unregister(s)        do {} while(0)
 111 #define cfs_symbol_get(s)               symbol_get(s)
 112 #define cfs_symbol_put(s)               symbol_put(s)
 113 #define cfs_module_get()                try_module_get(THIS_MODULE)
 114 #define cfs_module_put()                module_put(THIS_MODULE)
 115 #endif
 116
 117 /*
 118  * Proc file system APIs
 119  */
 120 typedef read_proc_t                     cfs_read_proc_t;
 121 typedef write_proc_t                    cfs_write_proc_t;
 122 typedef struct proc_dir_entry           cfs_proc_dir_entry_t;
 123 #define cfs_create_proc_entry(n, m, p)  create_proc_entry(n, m, p)
 124 #define cfs_free_proc_entry(e)          free_proc_entry(e)
 125 #define cfs_remove_proc_entry(n, e)     remove_proc_entry(n, e)
 126
 127 /*
 128  * Wait Queue
 129  */
 130 #define CFS_TASK_INTERRUPTIBLE          TASK_INTERRUPTIBLE
 131 #define CFS_TASK_UNINT                  TASK_UNINTERRUPTIBLE
 132 #define CFS_TASK_RUNNING                TASK_RUNNING
 133
 134 #define cfs_set_current_state(state) set_current_state(state)
 135
 136 typedef wait_queue_t                    cfs_waitlink_t;
 137 typedef wait_queue_head_t               cfs_waitq_t;
 138
 139 typedef long                            cfs_task_state_t;
 140
 141 #define cfs_waitq_init(w)               init_waitqueue_head(w)
 142 #define cfs_waitlink_init(l)            init_waitqueue_entry(l, current)
 143 #define cfs_waitq_add(w, l)             add_wait_queue(w, l)
 144 #define cfs_waitq_add_exclusive(w, l)   add_wait_queue_exclusive(w, l)
 145 #define cfs_waitq_forward(l, w)         do {} while(0)
 146 #define cfs_waitq_del(w, l)             remove_wait_queue(w, l)
 147 #define cfs_waitq_active(w)             waitqueue_active(w)
 148 #define cfs_waitq_signal(w)             wake_up(w)
 149 #define cfs_waitq_signal_nr(w,n)        wake_up_nr(w, n)
 150 #define cfs_waitq_broadcast(w)          wake_up_all(w)
 151 #define cfs_waitq_wait(l, s)            schedule()
 152 #define cfs_waitq_timedwait(l, s, t)    schedule_timeout(t)
 153 #define cfs_schedule_timeout(s, t)      schedule_timeout(t)
 154 #define cfs_schedule()                  schedule()
 155
 156 /* Kernel thread */
 157 typedef int (*cfs_thread_t)(void *);
 158
 159 static inline int cfs_kernel_thread(int (*fn)(void *),
 160                                     void *arg, unsigned long flags)
 161 {
 162         void *orig_info = current->journal_info;
 163         int rc;
 164
 165         current->journal_info = NULL;
 166         rc = kernel_thread(fn, arg, flags);
 167         current->journal_info = orig_info;
 168         return rc;
 169 }
 170
 171 #define CFS_MAX_SCHEDULE_TIMEOUT MAX_SCHEDULE_TIMEOUT
 172
 173 /*
 174  * Task struct
 175  */
 176 typedef struct task_struct              cfs_task_t;
 177 #define cfs_current()                   current
 178 #define cfs_task_lock(t)                task_lock(t)
 179 #define cfs_task_unlock(t)              task_unlock(t)
 180 #define CFS_DECL_JOURNAL_DATA           void *journal_info
 181 #define CFS_PUSH_JOURNAL                do {    \
 182         journal_info = current->journal_info;   \
 183         current->journal_info = NULL;           \
 184         } while(0)
 185 #define CFS_POP_JOURNAL                 do {    \
 186         current->journal_info = journal_info;   \
 187         } while(0)
 188
 189 /* Module interfaces */
 190 #define cfs_module(name, version, init, fini) \
 191 module_init(init);                            \
 192 module_exit(fini)
 193
 194 /*
 195  * Signal
 196  */
 197 typedef sigset_t                        cfs_sigset_t;
 198
 199 /*
 200  * Timer
 201  */
 202 typedef struct timer_list cfs_timer_t;
 203 typedef  void (*timer_func_t)(unsigned long);
 204
 205 #define cfs_init_timer(t)       init_timer(t)
 206
 207 static inline void cfs_timer_init(cfs_timer_t *t, void (*func)(unsigned long), void *arg)
 208 {
 209         init_timer(t);
 210         t->function = (timer_func_t)func;
 211         t->data = (unsigned long)arg;
 212 }
 213
 214 static inline void cfs_timer_done(cfs_timer_t *t)
 215 {
 216         return;
 217 }
 218
 219 static inline void cfs_timer_arm(cfs_timer_t *t, cfs_time_t deadline)
 220 {
 221         mod_timer(t, deadline);
 222 }
 223
 224 static inline void cfs_timer_disarm(cfs_timer_t *t)
 225 {
 226         del_timer(t);
 227 }
 228
 229 static inline int  cfs_timer_is_armed(cfs_timer_t *t)
 230 {
 231         return timer_pending(t);
 232 }
 233
 234 static inline cfs_time_t cfs_timer_deadline(cfs_timer_t *t)
 235 {
 236         return t->expires;
 237 }
 238
 239 #define CFS_MAX_SCHEDULE_TIMEOUT MAX_SCHEDULE_TIMEOUT
 240
 241 /* deschedule for a bit... */
 242 static inline void cfs_pause(cfs_duration_t ticks)
 243 {
 244         set_current_state(TASK_UNINTERRUPTIBLE);
 245         schedule_timeout(ticks);
 246 }
 247
 248 #ifndef wait_event_timeout /* Only for RHEL3 2.4.21 kernel */
 249 #define __wait_event_timeout(wq, condition, timeout, ret)        \
 250 do {                                                             \
 251         int __ret = 0;                                           \
 252         if (!(condition)) {                                      \
 253                 wait_queue_t __wait;                             \
 254                 unsigned long expire;                            \
 255                                                                  \
 256                 init_waitqueue_entry(&__wait, current);          \
 257                 expire = timeout + jiffies;                      \
 258                 add_wait_queue(&wq, &__wait);                    \
 259                 for (;;) {                                       \
 260                         set_current_state(TASK_UNINTERRUPTIBLE); \
 261                         if (condition)                           \
 262                                 break;                           \
 263                         if (jiffies > expire) {                  \
 264                                 ret = jiffies - expire;          \
 265                                 break;                           \
 266                         }                                        \
 267                         schedule_timeout(timeout);               \
 268                 }                                                \
 269                 current->state = TASK_RUNNING;                   \
 270                 remove_wait_queue(&wq, &__wait);                 \
 271         }                                                        \
 272 } while (0)
 273 /*
 274    retval == 0; condition met; we're good.
 275    retval > 0; timed out.
 276 */
 277 #define cfs_waitq_wait_event_timeout(wq, condition, timeout)         \
 278 ({                                                                   \
 279         int __ret = 0;                                               \
 280         if (!(condition))                                            \
 281                 __wait_event_timeout(wq, condition, timeout, __ret); \
 282         __ret;                                                       \
 283 })
 284 #else
 285 #define cfs_waitq_wait_event_timeout  wait_event_timeout
 286 #endif
 287
 288 #ifndef wait_event_interruptible_timeout /* Only for RHEL3 2.4.21 kernel */
 289 #define __wait_event_interruptible_timeout(wq, condition, timeout, ret)   \
 290 do {                                                           \
 291         int __ret = 0;                                         \
 292         if (!(condition)) {                                    \
 293                 wait_queue_t __wait;                           \
 294                 unsigned long expire;                          \
 295                                                                \
 296                 init_waitqueue_entry(&__wait, current);        \
 297                 expire = timeout + jiffies;                    \
 298                 add_wait_queue(&wq, &__wait);                  \
 299                 for (;;) {                                     \
 300                         set_current_state(TASK_INTERRUPTIBLE); \
 301                         if (condition)                         \
 302                                 break;                         \
 303                         if (jiffies > expire) {                \
 304                                 ret = jiffies - expire;        \
 305                                 break;                         \
 306                         }                                      \
 307                         if (!signal_pending(current)) {        \
 308                                 schedule_timeout(timeout);     \
 309                                 continue;                      \
 310                         }                                      \
 311                         ret = -ERESTARTSYS;                    \
 312                         break;                                 \
 313                 }                                              \
 314                 current->state = TASK_RUNNING;                 \
 315                 remove_wait_queue(&wq, &__wait);               \
 316         }                                                      \
 317 } while (0)
 318
 319 /*
 320    retval == 0; condition met; we're good.
 321    retval < 0; interrupted by signal.
 322    retval > 0; timed out.
 323 */
 324 #define cfs_waitq_wait_event_interruptible_timeout(wq, condition, timeout) \
 325 ({                                                                \
 326         int __ret = 0;                                            \
 327         if (!(condition))                                         \
 328                 __wait_event_interruptible_timeout(wq, condition, \
 329                                                 timeout, __ret);  \
 330         __ret;                                                    \
 331 })
 332 #else
 333 #define cfs_waitq_wait_event_interruptible_timeout wait_event_interruptible_timeout
 334 #endif
 335
 336 #define cfs_wait_event_interruptible_exclusive(wq, condition, rc)       \
 337 ({                                                                      \
 338         rc = wait_event_interruptible_exclusive(wq, condition);         \
 339 })
 340
 341 /*
 342  * atomic
 343  */
 344
 345 typedef atomic_t cfs_atomic_t;
 346
 347 #define cfs_atomic_read(atom)         atomic_read(atom)
 348 #define cfs_atomic_inc(atom)          atomic_inc(atom)
 349 #define cfs_atomic_dec(atom)          atomic_dec(atom)
 350 #define cfs_atomic_dec_and_test(atom) atomic_dec_and_test(atom)
 351 #define cfs_atomic_set(atom, value)   atomic_set(atom, value)
 352 #define cfs_atomic_add(value, atom)   atomic_add(value, atom)
 353 #define cfs_atomic_sub(value, atom)   atomic_sub(value, atom)
 354
 355 /*
 356  * membar
 357  */
 358
 359 #define cfs_mb() mb()
 360
 361 /*
 362  * interrupt
 363  */
 364
 365 #define cfs_in_interrupt() in_interrupt()
 366
 367 #else   /* !__KERNEL__ */
 368
 369 typedef struct proc_dir_entry           cfs_proc_dir_entry_t;
 370 #include "../user-prim.h"
 371
 372 #endif /* __KERNEL__ */
 373
 374 #endif