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