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