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/version.h>
  53 #include <linux/proc_fs.h>
  54 #include <linux/mm.h>
  55 #include <linux/timer.h>
  56 #include <linux/signal.h>
  57 #include <linux/sched.h>
  58 #include <linux/kthread.h>
  59 #include <linux/random.h>
  60
  61 #include <linux/miscdevice.h>
  62 #include <linux/libcfs/linux/portals_compat25.h>
  63 #include <asm/div64.h>
  64
  65 #include <linux/libcfs/linux/linux-time.h>
  66
  67
  68 /*
  69  * CPU
  70  */
  71 #ifdef for_each_possible_cpu
  72 #define cfs_for_each_possible_cpu(cpu) for_each_possible_cpu(cpu)
  73 #elif defined(for_each_cpu)
  74 #define cfs_for_each_possible_cpu(cpu) for_each_cpu(cpu)
  75 #endif
  76
  77 #ifdef NR_CPUS
  78 #else
  79 #define NR_CPUS     1
  80 #endif
  81
  82 #define cfs_set_cpus_allowed(t, mask)  set_cpus_allowed(t, mask)
  83
  84 /*
  85  * cache
  86  */
  87
  88 /*
  89  * IRQs
  90  */
  91
  92
  93 /*
  94  * Pseudo device register
  95  */
  96 typedef struct miscdevice               psdev_t;
  97
  98 /*
  99  * Sysctl register
 100  */
 101 typedef struct ctl_table                ctl_table_t;
 102 typedef struct ctl_table_header         ctl_table_header_t;
 103
 104 #define cfs_register_sysctl_table(t, a) register_sysctl_table(t)
 105
 106 #define DECLARE_PROC_HANDLER(name)                    \
 107 static int                                            \
 108 LL_PROC_PROTO(name)                                  \
 109 {                                                      \
 110         DECLARE_LL_PROC_PPOS_DECL;                    \
 111                                                         \
 112         return proc_call_handler(table->data, write,    \
 113                                  ppos, buffer, lenp,    \
 114                                  __##name);          \
 115 }
 116
 117 /*
 118  * Symbol register
 119  */
 120 #define cfs_symbol_register(s, p)       do {} while(0)
 121 #define cfs_symbol_unregister(s)        do {} while(0)
 122 #define cfs_symbol_get(s)              symbol_get(s)
 123 #define cfs_symbol_put(s)              symbol_put(s)
 124
 125 typedef struct module module_t;
 126
 127 /*
 128  * Proc file system APIs
 129  */
 130 typedef struct proc_dir_entry      proc_dir_entry_t;
 131
 132 /*
 133  * Wait Queue
 134  */
 135
 136
 137 typedef long                        cfs_task_state_t;
 138
 139 #define CFS_DECL_WAITQ(wq)              DECLARE_WAIT_QUEUE_HEAD(wq)
 140
 141 /*
 142  * Task struct
 143  */
 144 typedef struct task_struct            task_t;
 145 #define DECL_JOURNAL_DATA          void *journal_info
 146 #define PUSH_JOURNAL            do {    \
 147         journal_info = current->journal_info;   \
 148         current->journal_info = NULL;      \
 149         } while(0)
 150 #define POP_JOURNAL              do {    \
 151         current->journal_info = journal_info;   \
 152         } while(0)
 153
 154 /* Module interfaces */
 155 #define cfs_module(name, version, init, fini) \
 156         module_init(init);                  \
 157         module_exit(fini)
 158
 159 /*
 160  * Signal
 161  */
 162
 163 /*
 164  * Timer
 165  */
 166 typedef struct timer_list timer_list_t;
 167
 168
 169 #ifndef wait_event_timeout /* Only for RHEL3 2.4.21 kernel */
 170 #define __wait_event_timeout(wq, condition, timeout, ret)       \
 171 do {                                                         \
 172         int __ret = 0;                                     \
 173         if (!(condition)) {                                   \
 174                 wait_queue_t __wait;                         \
 175                 unsigned long expire;                       \
 176                                                                  \
 177                 init_waitqueue_entry(&__wait, current);   \
 178                 expire = timeout + jiffies;                   \
 179                 add_wait_queue(&wq, &__wait);               \
 180                 for (;;) {                                     \
 181                         set_current_state(TASK_UNINTERRUPTIBLE); \
 182                         if (condition)                     \
 183                                 break;                     \
 184                         if (jiffies > expire) {           \
 185                                 ret = jiffies - expire;   \
 186                                 break;                     \
 187                         }                                       \
 188                         schedule_timeout(timeout);             \
 189                 }                                               \
 190                 current->state = TASK_RUNNING;             \
 191                 remove_wait_queue(&wq, &__wait);                 \
 192         }                                                       \
 193 } while (0)
 194 /*
 195    retval == 0; condition met; we're good.
 196    retval > 0; timed out.
 197 */
 198 #define cfs_waitq_wait_event_timeout(wq, condition, timeout, ret)    \
 199 do {                                                             \
 200         ret = 0;                                                     \
 201         if (!(condition))                                           \
 202                 __wait_event_timeout(wq, condition, timeout, ret);   \
 203 } while (0)
 204 #else
 205 #define cfs_waitq_wait_event_timeout(wq, condition, timeout, ret)    \
 206         ret = wait_event_timeout(wq, condition, timeout)
 207 #endif
 208
 209 #define cfs_waitq_wait_event_interruptible_timeout(wq, c, timeout, ret) \
 210         ret = wait_event_interruptible_timeout(wq, c, timeout)
 211
 212 /*
 213  * atomic
 214  */
 215
 216
 217 #define cfs_atomic_add_unless(atom, a, u)    atomic_add_unless(atom, a, u)
 218 #define cfs_atomic_cmpxchg(atom, old, nv)    atomic_cmpxchg(atom, old, nv)
 219
 220 /*
 221  * membar
 222  */
 223
 224
 225 /*
 226  * interrupt
 227  */
 228
 229
 230 /*
 231  * might_sleep
 232  */
 233
 234 /*
 235  * group_info
 236  */
 237 typedef struct group_info group_info_t;
 238
 239
 240 /*
 241  * Random bytes
 242  */
 243 #endif