libcfs/include/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 <libcfs/libcfs.h> instead
  46 #endif
  47
  48 #ifndef __KERNEL__
  49 #error This include is only for kernel use.
  50 #endif
  51
  52 #include <linux/module.h>
  53 #include <linux/init.h>
  54 #include <linux/kernel.h>
  55 #include <linux/version.h>
  56 #include <linux/proc_fs.h>
  57 #include <linux/mm.h>
  58 #include <linux/timer.h>
  59 #include <linux/signal.h>
  60 #include <linux/sched.h>
  61 #include <linux/kthread.h>
  62 #ifdef HAVE_LINUX_RANDOM_H
  63 #include <linux/random.h>
  64 #endif
  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 #define CFS_KERN_EMERG   KERN_EMERG
  73 #define CFS_KERN_ALERT   KERN_ALERT
  74 #define CFS_KERN_CRIT    KERN_CRIT
  75 #define CFS_KERN_ERR     KERN_ERR
  76 #define CFS_KERN_WARNING KERN_WARNING
  77 #define CFS_KERN_NOTICE  KERN_NOTICE
  78 #define CFS_KERN_INFO    KERN_INFO
  79 #define CFS_KERN_DEBUG   KERN_DEBUG
  80
  81 /*
  82  * CPU
  83  */
  84 #ifdef for_each_possible_cpu
  85 #define cfs_for_each_possible_cpu(cpu) for_each_possible_cpu(cpu)
  86 #elif defined(for_each_cpu)
  87 #define cfs_for_each_possible_cpu(cpu) for_each_cpu(cpu)
  88 #endif
  89
  90 #ifndef NR_CPUS
  91 #define NR_CPUS                         1
  92 #endif
  93
  94 /*
  95  * cache
  96  */
  97 #define CFS_L1_CACHE_ALIGN(x)           L1_CACHE_ALIGN(x)
  98
  99 /*
 100  * IRQs
 101  */
 102 #define CFS_NR_IRQS                     NR_IRQS
 103
 104 #define CFS_EXPORT_SYMBOL(s)            EXPORT_SYMBOL(s)
 105
 106 /*
 107  * Pseudo device register
 108  */
 109 typedef struct miscdevice               cfs_psdev_t;
 110 #define cfs_psdev_register(dev)         misc_register(dev)
 111 #define cfs_psdev_deregister(dev)       misc_deregister(dev)
 112
 113 /*
 114  * Sysctl register
 115  */
 116 typedef struct ctl_table                cfs_sysctl_table_t;
 117 typedef struct ctl_table_header         cfs_sysctl_table_header_t;
 118
 119 #define cfs_register_sysctl_table(t, a) register_sysctl_table(t)
 120 #define cfs_unregister_sysctl_table(t)  unregister_sysctl_table(t)
 121
 122 #define DECLARE_PROC_HANDLER(name)                      \
 123 static int                                              \
 124 LL_PROC_PROTO(name)                                     \
 125 {                                                       \
 126         DECLARE_LL_PROC_PPOS_DECL;                      \
 127                                                         \
 128         return proc_call_handler(table->data, write,    \
 129                                  ppos, buffer, lenp,    \
 130                                  __##name);             \
 131 }
 132
 133 /*
 134  * Symbol register
 135  */
 136 #define cfs_symbol_register(s, p)       do {} while(0)
 137 #define cfs_symbol_unregister(s)        do {} while(0)
 138 #define cfs_symbol_get(s)               symbol_get(s)
 139 #define cfs_symbol_put(s)               symbol_put(s)
 140 #define cfs_module_get()                try_module_get(THIS_MODULE)
 141 #define cfs_try_module_get(m)           try_module_get(m)
 142 #define __cfs_module_get(m)             __module_get(m)
 143 #define cfs_module_put(m)               module_put(m)
 144 #define cfs_module_refcount(m)          module_refcount(m)
 145
 146 typedef struct module cfs_module_t;
 147
 148 /*
 149  * Proc file system APIs
 150  */
 151 typedef read_proc_t                     cfs_read_proc_t;
 152 typedef write_proc_t                    cfs_write_proc_t;
 153 typedef struct proc_dir_entry           cfs_proc_dir_entry_t;
 154 #define cfs_create_proc_entry(n, m, p)  create_proc_entry(n, m, p)
 155 #define cfs_free_proc_entry(e)          free_proc_entry(e)
 156 #define cfs_remove_proc_entry(n, e)     remove_proc_entry(n, e)
 157
 158 /*
 159  * Wait Queue
 160  */
 161 #define CFS_TASK_INTERRUPTIBLE          TASK_INTERRUPTIBLE
 162 #define CFS_TASK_UNINT                  TASK_UNINTERRUPTIBLE
 163 #define CFS_TASK_RUNNING                TASK_RUNNING
 164
 165 #define cfs_set_current_state(state)    set_current_state(state)
 166 #define cfs_wait_event(wq, cond)        wait_event(wq, cond)
 167
 168 typedef wait_queue_t                    cfs_waitlink_t;
 169 typedef wait_queue_head_t               cfs_waitq_t;
 170 typedef long                            cfs_task_state_t;
 171
 172 #define CFS_DECL_WAITQ(wq)              DECLARE_WAIT_QUEUE_HEAD(wq)
 173
 174 /*
 175  * Task struct
 176  */
 177 typedef struct task_struct              cfs_task_t;
 178 #define cfs_current()                   current
 179 #define cfs_task_lock(t)                task_lock(t)
 180 #define cfs_task_unlock(t)              task_unlock(t)
 181 #define CFS_DECL_JOURNAL_DATA           void *journal_info
 182 #define CFS_PUSH_JOURNAL                do {    \
 183         journal_info = current->journal_info;   \
 184         current->journal_info = NULL;           \
 185         } while(0)
 186 #define CFS_POP_JOURNAL                 do {    \
 187         current->journal_info = journal_info;   \
 188         } while(0)
 189
 190 /* Module interfaces */
 191 #define cfs_module(name, version, init, fini) \
 192         module_init(init);                    \
 193         module_exit(fini)
 194 #define cfs_request_module              request_module
 195
 196 /*
 197  * Signal
 198  */
 199 typedef sigset_t                        cfs_sigset_t;
 200
 201 /*
 202  * Timer
 203  */
 204 typedef struct timer_list cfs_timer_t;
 205
 206 #define CFS_MAX_SCHEDULE_TIMEOUT MAX_SCHEDULE_TIMEOUT
 207
 208 #ifndef wait_event_timeout /* Only for RHEL3 2.4.21 kernel */
 209 #define __wait_event_timeout(wq, condition, timeout, ret)        \
 210 do {                                                             \
 211         int __ret = 0;                                           \
 212         if (!(condition)) {                                      \
 213                 wait_queue_t __wait;                             \
 214                 unsigned long expire;                            \
 215                                                                  \
 216                 init_waitqueue_entry(&__wait, current);          \
 217                 expire = timeout + jiffies;                      \
 218                 add_wait_queue(&wq, &__wait);                    \
 219                 for (;;) {                                       \
 220                         set_current_state(TASK_UNINTERRUPTIBLE); \
 221                         if (condition)                           \
 222                                 break;                           \
 223                         if (jiffies > expire) {                  \
 224                                 ret = jiffies - expire;          \
 225                                 break;                           \
 226                         }                                        \
 227                         schedule_timeout(timeout);               \
 228                 }                                                \
 229                 current->state = TASK_RUNNING;                   \
 230                 remove_wait_queue(&wq, &__wait);                 \
 231         }                                                        \
 232 } while (0)
 233 /*
 234    retval == 0; condition met; we're good.
 235    retval > 0; timed out.
 236 */
 237 #define cfs_waitq_wait_event_timeout(wq, condition, timeout, ret)    \
 238 do {                                                                 \
 239         ret = 0;                                                     \
 240         if (!(condition))                                            \
 241                 __wait_event_timeout(wq, condition, timeout, ret);   \
 242 } while (0)
 243 #else
 244 #define cfs_waitq_wait_event_timeout(wq, condition, timeout, ret)    \
 245         ret = wait_event_timeout(wq, condition, timeout)
 246 #endif
 247
 248 #define cfs_waitq_wait_event_interruptible_timeout(wq, c, timeout, ret) \
 249         ret = wait_event_interruptible_timeout(wq, c, timeout)
 250
 251 /*
 252  * atomic
 253  */
 254
 255 typedef atomic_t cfs_atomic_t;
 256
 257 #define cfs_atomic_read(atom)                atomic_read(atom)
 258 #define cfs_atomic_inc(atom)                 atomic_inc(atom)
 259 #define cfs_atomic_inc_and_test(atom)        atomic_inc_and_test(atom)
 260 #define cfs_atomic_inc_return(atom)          atomic_inc_return(atom)
 261 #define cfs_atomic_inc_not_zero(atom)        atomic_inc_not_zero(atom)
 262 #define cfs_atomic_add_unless(atom, a, u)    atomic_add_unless(atom, a, u)
 263 #define cfs_atomic_dec(atom)                 atomic_dec(atom)
 264 #define cfs_atomic_dec_and_test(atom)        atomic_dec_and_test(atom)
 265 #define cfs_atomic_dec_and_lock(atom, lock)  atomic_dec_and_lock(atom, lock)
 266 #define cfs_atomic_dec_return(atom)          atomic_dec_return(atom)
 267 #define cfs_atomic_set(atom, value)          atomic_set(atom, value)
 268 #define cfs_atomic_add(value, atom)          atomic_add(value, atom)
 269 #define cfs_atomic_add_return(value, atom)   atomic_add_return(value, atom)
 270 #define cfs_atomic_sub(value, atom)          atomic_sub(value, atom)
 271 #define cfs_atomic_sub_and_test(value, atom) atomic_sub_and_test(value, atom)
 272 #define cfs_atomic_sub_return(value, atom)   atomic_sub_return(value, atom)
 273 #define cfs_atomic_cmpxchg(atom, old, nv)    atomic_cmpxchg(atom, old, nv)
 274 #define CFS_ATOMIC_INIT(i)                   ATOMIC_INIT(i)
 275
 276 /*
 277  * membar
 278  */
 279
 280 #define cfs_mb() mb()
 281
 282 /*
 283  * interrupt
 284  */
 285
 286 #define cfs_in_interrupt() in_interrupt()
 287
 288 /*
 289  * might_sleep
 290  */
 291 #define cfs_might_sleep() might_sleep()
 292
 293 /*
 294  * group_info
 295  */
 296 typedef struct group_info cfs_group_info_t;
 297
 298 #define cfs_get_group_info(group_info)     get_group_info(group_info)
 299 #define cfs_put_group_info(group_info)     put_group_info(group_info)
 300 #define cfs_set_current_groups(group_info) set_current_groups(group_info)
 301 #define cfs_groups_free(group_info)        groups_free(group_info)
 302 #define cfs_groups_alloc(gidsetsize)       groups_alloc(gidsetsize)
 303
 304 /*
 305  * Random bytes
 306  */
 307 #define cfs_get_random_bytes_prim(buf, nbytes)  get_random_bytes(buf, nbytes)
 308 #endif