drivers/staging/lustre/include/linux/libcfs/linux/linux-prim.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, Intel Corporation.
  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 <linux/libcfs/libcfs.h> instead
  46 #endif
  47
  48
  49 #include <linux/module.h>
  50 #include <linux/init.h>
  51 #include <linux/kernel.h>
  52 #include <linux/proc_fs.h>
  53 #include <linux/mm.h>
  54 #include <linux/timer.h>
  55 #include <linux/signal.h>
  56 #include <linux/sched.h>
  57 #include <linux/kthread.h>
  58 #include <linux/random.h>
  59
  60 #include <linux/miscdevice.h>
  61 #include <linux/libcfs/linux/portals_compat25.h>
  62 #include <asm/div64.h>
  63
  64 #include <linux/libcfs/linux/linux-time.h>
  65
  66 /*
  67  * Sysctl register
  68  */
  69 typedef struct ctl_table                ctl_table_t;
  70 typedef struct ctl_table_header         ctl_table_header_t;
  71
  72 #define DECLARE_PROC_HANDLER(name)                    \
  73 static int                                            \
  74 LL_PROC_PROTO(name)                                  \
  75 {                                                      \
  76         DECLARE_LL_PROC_PPOS_DECL;                    \
  77                                                         \
  78         return proc_call_handler(table->data, write,    \
  79                                  ppos, buffer, lenp,    \
  80                                  __##name);          \
  81 }
  82
  83 /*
  84  * Proc file system APIs
  85  */
  86 typedef struct proc_dir_entry      proc_dir_entry_t;
  87
  88 /*
  89  * Wait Queue
  90  */
  91
  92
  93 typedef long                        cfs_task_state_t;
  94
  95 #define CFS_DECL_WAITQ(wq)              DECLARE_WAIT_QUEUE_HEAD(wq)
  96
  97 /*
  98  * Task struct
  99  */
 100 typedef struct task_struct            task_t;
 101 #define DECL_JOURNAL_DATA          void *journal_info
 102 #define PUSH_JOURNAL            do {    \
 103         journal_info = current->journal_info;   \
 104         current->journal_info = NULL;      \
 105         } while(0)
 106 #define POP_JOURNAL              do {    \
 107         current->journal_info = journal_info;   \
 108         } while(0)
 109
 110 /* Module interfaces */
 111 #define cfs_module(name, version, init, fini) \
 112         module_init(init);                  \
 113         module_exit(fini)
 114
 115 /*
 116  * Signal
 117  */
 118
 119 /*
 120  * Timer
 121  */
 122 typedef struct timer_list timer_list_t;
 123
 124
 125 #ifndef wait_event_timeout /* Only for RHEL3 2.4.21 kernel */
 126 #define __wait_event_timeout(wq, condition, timeout, ret)       \
 127 do {                                                         \
 128         int __ret = 0;                                     \
 129         if (!(condition)) {                                   \
 130                 wait_queue_t __wait;                         \
 131                 unsigned long expire;                       \
 132                                                                  \
 133                 init_waitqueue_entry(&__wait, current);   \
 134                 expire = timeout + jiffies;                   \
 135                 add_wait_queue(&wq, &__wait);               \
 136                 for (;;) {                                     \
 137                         set_current_state(TASK_UNINTERRUPTIBLE); \
 138                         if (condition)                     \
 139                                 break;                     \
 140                         if (jiffies > expire) {           \
 141                                 ret = jiffies - expire;   \
 142                                 break;                     \
 143                         }                                       \
 144                         schedule_timeout(timeout);             \
 145                 }                                               \
 146                 current->state = TASK_RUNNING;             \
 147                 remove_wait_queue(&wq, &__wait);                 \
 148         }                                                       \
 149 } while (0)
 150 /*
 151    retval == 0; condition met; we're good.
 152    retval > 0; timed out.
 153 */
 154 #define cfs_waitq_wait_event_timeout(wq, condition, timeout, ret)    \
 155 do {                                                             \
 156         ret = 0;                                                     \
 157         if (!(condition))                                           \
 158                 __wait_event_timeout(wq, condition, timeout, ret);   \
 159 } while (0)
 160 #else
 161 #define cfs_waitq_wait_event_timeout(wq, condition, timeout, ret)    \
 162         ret = wait_event_timeout(wq, condition, timeout)
 163 #endif
 164
 165 #define cfs_waitq_wait_event_interruptible_timeout(wq, c, timeout, ret) \
 166         ret = wait_event_interruptible_timeout(wq, c, timeout)
 167
 168 /*
 169  * atomic
 170  */
 171
 172
 173 #define cfs_atomic_add_unless(atom, a, u)    atomic_add_unless(atom, a, u)
 174 #define cfs_atomic_cmpxchg(atom, old, nv)    atomic_cmpxchg(atom, old, nv)
 175
 176 /*
 177  * membar
 178  */
 179
 180
 181 /*
 182  * interrupt
 183  */
 184
 185
 186 /*
 187  * might_sleep
 188  */
 189
 190 /*
 191  * group_info
 192  */
 193 typedef struct group_info group_info_t;
 194
 195
 196 /*
 197  * Random bytes
 198  */
 199 #endif