libcfs/include/libcfs/linux/linux-prim.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  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 #ifndef AUTOCONF_INCLUDED
  53 #include <linux/config.h>
  54 #endif
  55 #include <linux/module.h>
  56 #include <linux/init.h>
  57 #include <linux/kernel.h>
  58 #include <linux/version.h>
  59 #include <linux/proc_fs.h>
  60 #include <linux/mm.h>
  61 #include <linux/timer.h>
  62 #include <linux/signal.h>
  63 #include <linux/sched.h>
  64 #include <linux/kthread.h>
  65 #ifdef HAVE_LINUX_RANDOM_H
  66 #include <linux/random.h>
  67 #endif
  68
  69 #include <linux/miscdevice.h>
  70 #include <libcfs/linux/portals_compat25.h>
  71 #include <asm/div64.h>
  72
  73 #include <libcfs/linux/linux-time.h>
  74
  75 #define CFS_KERN_EMERG   KERN_EMERG
  76 #define CFS_KERN_ALERT   KERN_ALERT
  77 #define CFS_KERN_CRIT    KERN_CRIT
  78 #define CFS_KERN_ERR     KERN_ERR
  79 #define CFS_KERN_WARNING KERN_WARNING
  80 #define CFS_KERN_NOTICE  KERN_NOTICE
  81 #define CFS_KERN_INFO    KERN_INFO
  82 #define CFS_KERN_DEBUG   KERN_DEBUG
  83
  84 /*
  85  * CPU
  86  */
  87 #ifdef for_each_possible_cpu
  88 #define cfs_for_each_possible_cpu(cpu) for_each_possible_cpu(cpu)
  89 #elif defined(for_each_cpu)
  90 #define cfs_for_each_possible_cpu(cpu) for_each_cpu(cpu)
  91 #endif
  92
  93 #ifdef NR_CPUS
  94 #define CFS_NR_CPUS     NR_CPUS
  95 #else
  96 #define CFS_NR_CPUS     1
  97 #endif
  98
  99 #ifdef HAVE_SET_CPUS_ALLOWED
 100 #define cfs_set_cpus_allowed(t, mask)  set_cpus_allowed(t, mask)
 101 #else
 102 #define cfs_set_cpus_allowed(t, mask)  set_cpus_allowed_ptr(t, &(mask))
 103 #endif
 104
 105 /*
 106  * cache
 107  */
 108 #define CFS_L1_CACHE_ALIGN(x)           L1_CACHE_ALIGN(x)
 109
 110 /*
 111  * IRQs
 112  */
 113 #define CFS_NR_IRQS                     NR_IRQS
 114
 115 #define CFS_EXPORT_SYMBOL(s)            EXPORT_SYMBOL(s)
 116
 117 /*
 118  * Pseudo device register
 119  */
 120 typedef struct miscdevice               cfs_psdev_t;
 121 #define cfs_psdev_register(dev)         misc_register(dev)
 122 #define cfs_psdev_deregister(dev)       misc_deregister(dev)
 123
 124 /*
 125  * Sysctl register
 126  */
 127 typedef struct ctl_table                cfs_sysctl_table_t;
 128 typedef struct ctl_table_header         cfs_sysctl_table_header_t;
 129
 130 #ifdef HAVE_2ARGS_REGISTER_SYSCTL
 131 #define cfs_register_sysctl_table(t, a) register_sysctl_table(t, a)
 132 #else
 133 #define cfs_register_sysctl_table(t, a) register_sysctl_table(t)
 134 #endif
 135 #define cfs_unregister_sysctl_table(t)  unregister_sysctl_table(t)
 136
 137 #define DECLARE_PROC_HANDLER(name)                      \
 138 static int                                              \
 139 LL_PROC_PROTO(name)                                     \
 140 {                                                       \
 141         DECLARE_LL_PROC_PPOS_DECL;                      \
 142                                                         \
 143         return proc_call_handler(table->data, write,    \
 144                                  ppos, buffer, lenp,    \
 145                                  __##name);             \
 146 }
 147
 148 /*
 149  * Symbol register
 150  */
 151 #define cfs_symbol_register(s, p)       do {} while(0)
 152 #define cfs_symbol_unregister(s)        do {} while(0)
 153 #define cfs_symbol_get(s)               symbol_get(s)
 154 #define cfs_symbol_put(s)               symbol_put(s)
 155 #define cfs_module_get()                try_module_get(THIS_MODULE)
 156 #define cfs_try_module_get(m)           try_module_get(m)
 157 #define __cfs_module_get(m)             __module_get(m)
 158 #define cfs_module_put(m)               module_put(m)
 159 #define cfs_module_refcount(m)          module_refcount(m)
 160
 161 typedef struct module cfs_module_t;
 162
 163 /*
 164  * Proc file system APIs
 165  */
 166 typedef read_proc_t                     cfs_read_proc_t;
 167 typedef write_proc_t                    cfs_write_proc_t;
 168 typedef struct proc_dir_entry           cfs_proc_dir_entry_t;
 169 #define cfs_create_proc_entry(n, m, p)  create_proc_entry(n, m, p)
 170 #define cfs_free_proc_entry(e)          free_proc_entry(e)
 171 #define cfs_remove_proc_entry(n, e)     remove_proc_entry(n, e)
 172
 173 /*
 174  * Wait Queue
 175  */
 176 #define CFS_TASK_INTERRUPTIBLE          TASK_INTERRUPTIBLE
 177 #define CFS_TASK_UNINT                  TASK_UNINTERRUPTIBLE
 178 #define CFS_TASK_RUNNING                TASK_RUNNING
 179
 180 #define cfs_set_current_state(state)    set_current_state(state)
 181 #define cfs_wait_event(wq, cond)        wait_event(wq, cond)
 182
 183 typedef wait_queue_t                    cfs_waitlink_t;
 184 typedef wait_queue_head_t               cfs_waitq_t;
 185 typedef long                            cfs_task_state_t;
 186
 187 #define cfs_kthread_run(fn, data, fmt, arg...) kthread_run(fn, data, fmt, ##arg)
 188
 189 /* Kernel thread */
 190 typedef int (*cfs_thread_t)(void *);
 191
 192 #define CFS_DAEMON_FLAGS (CLONE_VM | CLONE_FILES)
 193 extern int cfs_create_thread(int (*fn)(void *),
 194                              void *arg, unsigned long flags);
 195
 196 /*
 197  * Task struct
 198  */
 199 typedef struct task_struct              cfs_task_t;
 200 #define cfs_current()                   current
 201 #define cfs_task_lock(t)                task_lock(t)
 202 #define cfs_task_unlock(t)              task_unlock(t)
 203 #define CFS_DECL_JOURNAL_DATA           void *journal_info
 204 #define CFS_PUSH_JOURNAL                do {    \
 205         journal_info = current->journal_info;   \
 206         current->journal_info = NULL;           \
 207         } while(0)
 208 #define CFS_POP_JOURNAL                 do {    \
 209         current->journal_info = journal_info;   \
 210         } while(0)
 211
 212 /* Module interfaces */
 213 #define cfs_module(name, version, init, fini) \
 214         module_init(init);                    \
 215         module_exit(fini)
 216 #define cfs_request_module              request_module
 217
 218 /*
 219  * Signal
 220  */
 221 typedef sigset_t                        cfs_sigset_t;
 222
 223 /*
 224  * Timer
 225  */
 226 typedef struct timer_list cfs_timer_t;
 227
 228 #define CFS_MAX_SCHEDULE_TIMEOUT MAX_SCHEDULE_TIMEOUT
 229
 230 #ifndef wait_event_timeout /* Only for RHEL3 2.4.21 kernel */
 231 #define __wait_event_timeout(wq, condition, timeout, ret)        \
 232 do {                                                             \
 233         int __ret = 0;                                           \
 234         if (!(condition)) {                                      \
 235                 wait_queue_t __wait;                             \
 236                 unsigned long expire;                            \
 237                                                                  \
 238                 init_waitqueue_entry(&__wait, current);          \
 239                 expire = timeout + jiffies;                      \
 240                 add_wait_queue(&wq, &__wait);                    \
 241                 for (;;) {                                       \
 242                         set_current_state(TASK_UNINTERRUPTIBLE); \
 243                         if (condition)                           \
 244                                 break;                           \
 245                         if (jiffies > expire) {                  \
 246                                 ret = jiffies - expire;          \
 247                                 break;                           \
 248                         }                                        \
 249                         schedule_timeout(timeout);               \
 250                 }                                                \
 251                 current->state = TASK_RUNNING;                   \
 252                 remove_wait_queue(&wq, &__wait);                 \
 253         }                                                        \
 254 } while (0)
 255 /*
 256    retval == 0; condition met; we're good.
 257    retval > 0; timed out.
 258 */
 259 #define cfs_waitq_wait_event_timeout(wq, condition, timeout, ret)    \
 260 do {                                                                 \
 261         ret = 0;                                                     \
 262         if (!(condition))                                            \
 263                 __wait_event_timeout(wq, condition, timeout, ret);   \
 264 } while (0)
 265 #else
 266 #define cfs_waitq_wait_event_timeout(wq, condition, timeout, ret)    \
 267         ret = wait_event_timeout(wq, condition, timeout)
 268 #endif
 269
 270 #define cfs_waitq_wait_event_interruptible_timeout(wq, c, timeout, ret) \
 271         ret = wait_event_interruptible_timeout(wq, c, timeout)
 272
 273 /*
 274  * atomic
 275  */
 276
 277 typedef atomic_t cfs_atomic_t;
 278
 279 #define cfs_atomic_read(atom)                atomic_read(atom)
 280 #define cfs_atomic_inc(atom)                 atomic_inc(atom)
 281 #define cfs_atomic_inc_and_test(atom)        atomic_inc_and_test(atom)
 282 #define cfs_atomic_inc_return(atom)          atomic_inc_return(atom)
 283 #define cfs_atomic_inc_not_zero(atom)        atomic_inc_not_zero(atom)
 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_INIT(i)                   ATOMIC_INIT(i)
 295
 296 /*
 297  * membar
 298  */
 299
 300 #define cfs_mb() mb()
 301
 302 /*
 303  * interrupt
 304  */
 305
 306 #define cfs_in_interrupt() in_interrupt()
 307
 308 /*
 309  * might_sleep
 310  */
 311 #define cfs_might_sleep() might_sleep()
 312
 313 /*
 314  * group_info
 315  */
 316 typedef struct group_info cfs_group_info_t;
 317
 318 #define cfs_get_group_info(group_info)     get_group_info(group_info)
 319 #define cfs_put_group_info(group_info)     put_group_info(group_info)
 320 #define cfs_set_current_groups(group_info) set_current_groups(group_info)
 321 #define cfs_groups_free(group_info)        groups_free(group_info)
 322 #define cfs_groups_alloc(gidsetsize)       groups_alloc(gidsetsize)
 323
 324 /*
 325  * Random bytes
 326  */
 327 #define cfs_get_random_bytes_prim(buf, nbytes)  get_random_bytes(buf, nbytes)
 328 #endif