libcfs/include/libcfs/linux/kp30.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  2008 Sun Microsystems, Inc. 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
  37 #ifndef __LIBCFS_LINUX_KP30_H__
  38 #define __LIBCFS_LINUX_KP30_H__
  39
  40
  41 #ifndef AUTOCONF_INCLUDED
  42 # include <linux/config.h>
  43 #endif
  44 #include <linux/kernel.h>
  45 #include <linux/mm.h>
  46 #include <linux/string.h>
  47 #include <linux/stat.h>
  48 #include <linux/init.h>
  49 #include <linux/errno.h>
  50 #include <linux/unistd.h>
  51 #include <asm/system.h>
  52 #include <linux/kmod.h>
  53 #include <linux/notifier.h>
  54 #include <linux/fs.h>
  55 #include <linux/miscdevice.h>
  56 #include <linux/vmalloc.h>
  57 #include <linux/time.h>
  58 #include <linux/slab.h>
  59 #include <linux/interrupt.h>
  60 #include <linux/highmem.h>
  61 #include <linux/module.h>
  62 #include <linux/version.h>
  63 #include <linux/smp_lock.h>
  64 #include <asm/atomic.h>
  65 #include <asm/uaccess.h>
  66 #include <linux/rwsem.h>
  67 #include <linux/proc_fs.h>
  68 #include <linux/file.h>
  69 #include <linux/smp.h>
  70 #include <linux/ctype.h>
  71 #include <linux/compiler.h>
  72 #ifdef HAVE_MM_INLINE
  73 # include <linux/mm_inline.h>
  74 #endif
  75 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2,5,0))
  76 # include <linux/kallsyms.h>
  77 # include <linux/moduleparam.h>
  78 #endif
  79 #include <linux/scatterlist.h>
  80
  81 #include <libcfs/linux/portals_compat25.h>
  82
  83 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
  84 #define schedule_work schedule_task
  85 #define prepare_work(wq,cb,cbdata)                                            \
  86 do {                                                                          \
  87         INIT_TQUEUE((wq), 0, 0);                                              \
  88         PREPARE_TQUEUE((wq), (cb), (cbdata));                                 \
  89 } while (0)
  90
  91 #define PageUptodate Page_Uptodate
  92 #define our_recalc_sigpending(current) recalc_sigpending(current)
  93 #define num_online_cpus() smp_num_cpus
  94 static inline void our_cond_resched(void)
  95 {
  96         if (current->need_resched)
  97                schedule ();
  98 }
  99 #define work_struct_t                   struct tq_struct
 100 #define cfs_get_work_data(type,field,data)   (data)
 101 #else
 102
 103 #ifdef HAVE_3ARGS_INIT_WORK
 104
 105 #define prepare_work(wq,cb,cbdata)                                            \
 106 do {                                                                          \
 107         INIT_WORK((wq), (void *)(cb), (void *)(cbdata));                      \
 108 } while (0)
 109
 110 #define cfs_get_work_data(type,field,data)   (data)
 111
 112 #else
 113
 114 #define prepare_work(wq,cb,cbdata)                                            \
 115 do {                                                                          \
 116         INIT_WORK((wq), (void *)(cb));                                        \
 117 } while (0)
 118
 119 #define cfs_get_work_data(type,field,data) container_of(data,type,field)
 120
 121 #endif
 122
 123 #define wait_on_page wait_on_page_locked
 124 #define our_recalc_sigpending(current) recalc_sigpending()
 125 #define strtok(a,b) strpbrk(a, b)
 126 static inline void our_cond_resched(void)
 127 {
 128         cond_resched();
 129 }
 130 #define work_struct_t      struct work_struct
 131
 132 #endif /* LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0) */
 133
 134 #ifdef CONFIG_SMP
 135 #define LASSERT_SPIN_LOCKED(lock) LASSERT(spin_is_locked(lock))
 136 #define LINVRNT_SPIN_LOCKED(lock) LINVRNT(spin_is_locked(lock))
 137 #else
 138 #define LASSERT_SPIN_LOCKED(lock) do {(void)sizeof(lock);} while(0)
 139 #define LINVRNT_SPIN_LOCKED(lock) do {(void)sizeof(lock);} while(0)
 140 #endif
 141 #define LASSERT_SEM_LOCKED(sem) LASSERT(down_trylock(sem) != 0)
 142
 143 #ifdef HAVE_SEM_COUNT_ATOMIC
 144 #define SEM_COUNT(sem)          (atomic_read(&(sem)->count))
 145 #else
 146 #define SEM_COUNT(sem)          ((sem)->count)
 147 #endif
 148
 149 #define LIBCFS_PANIC(msg)            panic(msg)
 150
 151 /* ------------------------------------------------------------------- */
 152
 153 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 154
 155 #define PORTAL_SYMBOL_REGISTER(x) inter_module_register(#x, THIS_MODULE, &x)
 156 #define PORTAL_SYMBOL_UNREGISTER(x) inter_module_unregister(#x)
 157
 158 #define PORTAL_SYMBOL_GET(x) ((typeof(&x))inter_module_get(#x))
 159 #define PORTAL_SYMBOL_PUT(x) inter_module_put(#x)
 160
 161 #define PORTAL_MODULE_USE       MOD_INC_USE_COUNT
 162 #define PORTAL_MODULE_UNUSE     MOD_DEC_USE_COUNT
 163 #else
 164
 165 #define PORTAL_SYMBOL_REGISTER(x)
 166 #define PORTAL_SYMBOL_UNREGISTER(x)
 167
 168 #define PORTAL_SYMBOL_GET(x) symbol_get(x)
 169 #define PORTAL_SYMBOL_PUT(x) symbol_put(x)
 170
 171 #define PORTAL_MODULE_USE       try_module_get(THIS_MODULE)
 172 #define PORTAL_MODULE_UNUSE     module_put(THIS_MODULE)
 173
 174 #endif
 175
 176 /******************************************************************************/
 177 /* Module parameter support */
 178 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 179 # define CFS_MODULE_PARM(name, t, type, perm, desc) \
 180         MODULE_PARM(name, t);\
 181         MODULE_PARM_DESC(name, desc)
 182
 183 #else
 184 # define CFS_MODULE_PARM(name, t, type, perm, desc) \
 185         module_param(name, type, perm);\
 186         MODULE_PARM_DESC(name, desc)
 187 #endif
 188
 189 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,6,9))
 190 # define CFS_SYSFS_MODULE_PARM  0 /* no sysfs module parameters */
 191 #else
 192 # define CFS_SYSFS_MODULE_PARM  1 /* module parameters accessible via sysfs */
 193 #endif
 194 /******************************************************************************/
 195
 196 #if (__GNUC__)
 197 /* Use the special GNU C __attribute__ hack to have the compiler check the
 198  * printf style argument string against the actual argument count and
 199  * types.
 200  */
 201 #ifdef printf
 202 # warning printf has been defined as a macro...
 203 # undef printf
 204 #endif
 205
 206 #endif /* __GNUC__ */
 207
 208 # define fprintf(a, format, b...) CDEBUG(D_OTHER, format , ## b)
 209 # define printf(format, b...) CDEBUG(D_OTHER, format , ## b)
 210 # define time(a) CURRENT_TIME
 211
 212 #ifndef num_possible_cpus
 213 #define num_possible_cpus() NR_CPUS
 214 #endif
 215 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0)
 216 #define i_size_read(a) ((a)->i_size)
 217 #endif
 218
 219
 220 /******************************************************************************/
 221 /* Light-weight trace
 222  * Support for temporary event tracing with minimal Heisenberg effect. */
 223 #define LWT_SUPPORT  0
 224
 225 #define LWT_MEMORY   (16<<20)
 226
 227 #ifndef KLWT_SUPPORT
 228 # if defined(__KERNEL__)
 229 #  if !defined(BITS_PER_LONG)
 230 #   error "BITS_PER_LONG not defined"
 231 #  endif
 232 # elif !defined(__WORDSIZE)
 233 #  error "__WORDSIZE not defined"
 234 # else
 235 #  define BITS_PER_LONG __WORDSIZE
 236 # endif
 237
 238 /* kernel hasn't defined this? */
 239 typedef struct {
 240         long long   lwte_when;
 241         char       *lwte_where;
 242         void       *lwte_task;
 243         long        lwte_p1;
 244         long        lwte_p2;
 245         long        lwte_p3;
 246         long        lwte_p4;
 247 # if BITS_PER_LONG > 32
 248         long        lwte_pad;
 249 # endif
 250 } lwt_event_t;
 251 #endif /* !KLWT_SUPPORT */
 252
 253 #if LWT_SUPPORT
 254 # ifdef __KERNEL__
 255 #  if !KLWT_SUPPORT
 256
 257 typedef struct _lwt_page {
 258         struct list_head     lwtp_list;
 259         struct page         *lwtp_page;
 260         lwt_event_t         *lwtp_events;
 261 } lwt_page_t;
 262
 263 typedef struct {
 264         int                lwtc_current_index;
 265         lwt_page_t        *lwtc_current_page;
 266 } lwt_cpu_t;
 267
 268 extern int       lwt_enabled;
 269 extern lwt_cpu_t lwt_cpus[];
 270
 271 /* Note that we _don't_ define LWT_EVENT at all if LWT_SUPPORT isn't set.
 272  * This stuff is meant for finding specific problems; it never stays in
 273  * production code... */
 274
 275 #define LWTSTR(n)       #n
 276 #define LWTWHERE(f,l)   f ":" LWTSTR(l)
 277 #define LWT_EVENTS_PER_PAGE (CFS_PAGE_SIZE / sizeof (lwt_event_t))
 278
 279 #define LWT_EVENT(p1, p2, p3, p4)                                       \
 280 do {                                                                    \
 281         unsigned long    flags;                                         \
 282         lwt_cpu_t       *cpu;                                           \
 283         lwt_page_t      *p;                                             \
 284         lwt_event_t     *e;                                             \
 285                                                                         \
 286         if (lwt_enabled) {                                              \
 287                 local_irq_save (flags);                                 \
 288                                                                         \
 289                 cpu = &lwt_cpus[smp_processor_id()];                    \
 290                 p = cpu->lwtc_current_page;                             \
 291                 e = &p->lwtp_events[cpu->lwtc_current_index++];         \
 292                                                                         \
 293                 if (cpu->lwtc_current_index >= LWT_EVENTS_PER_PAGE) {   \
 294                         cpu->lwtc_current_page =                        \
 295                                 list_entry (p->lwtp_list.next,          \
 296                                             lwt_page_t, lwtp_list);     \
 297                         cpu->lwtc_current_index = 0;                    \
 298                 }                                                       \
 299                                                                         \
 300                 e->lwte_when  = get_cycles();                           \
 301                 e->lwte_where = LWTWHERE(__FILE__,__LINE__);            \
 302                 e->lwte_task  = current;                                \
 303                 e->lwte_p1    = (long)(p1);                             \
 304                 e->lwte_p2    = (long)(p2);                             \
 305                 e->lwte_p3    = (long)(p3);                             \
 306                 e->lwte_p4    = (long)(p4);                             \
 307                                                                         \
 308                 local_irq_restore (flags);                              \
 309         }                                                               \
 310 } while (0)
 311
 312 #endif /* !KLWT_SUPPORT */
 313
 314 extern int  lwt_init (void);
 315 extern void lwt_fini (void);
 316 extern int  lwt_lookup_string (int *size, char *knlptr,
 317                                char *usrptr, int usrsize);
 318 extern int  lwt_control (int enable, int clear);
 319 extern int  lwt_snapshot (cycles_t *now, int *ncpu, int *total_size,
 320                           void *user_ptr, int user_size);
 321 # else  /* __KERNEL__ */
 322 #  define LWT_EVENT(p1,p2,p3,p4)     /* no userland implementation yet */
 323 # endif /* __KERNEL__ */
 324 #endif /* LWT_SUPPORT */
 325
 326 /* ------------------------------------------------------------------ */
 327
 328 #define IOCTL_LIBCFS_TYPE long
 329
 330 #ifdef __CYGWIN__
 331 # ifndef BITS_PER_LONG
 332 #  if (~0UL) == 0xffffffffUL
 333 #   define BITS_PER_LONG 32
 334 #  else
 335 #   define BITS_PER_LONG 64
 336 #  endif
 337 # endif
 338 #endif
 339
 340 #if BITS_PER_LONG > 32
 341 # define LI_POISON ((int)0x5a5a5a5a5a5a5a5a)
 342 # define LL_POISON ((long)0x5a5a5a5a5a5a5a5a)
 343 # define LP_POISON ((void *)(long)0x5a5a5a5a5a5a5a5a)
 344 #else
 345 # define LI_POISON ((int)0x5a5a5a5a)
 346 # define LL_POISON ((long)0x5a5a5a5a)
 347 # define LP_POISON ((void *)(long)0x5a5a5a5a)
 348 #endif
 349
 350 /* this is a bit chunky */
 351
 352 #define _LWORDSIZE BITS_PER_LONG
 353
 354 #if defined(HAVE_U64_LONG_LONG)
 355 # define LPU64 "%Lu"
 356 # define LPD64 "%Ld"
 357 # define LPX64 "%#Lx"
 358 # define LPF64 "L"
 359 #else
 360 # define LPU64 "%lu"
 361 # define LPD64 "%ld"
 362 # define LPX64 "%#lx"
 363 # define LPF64 "l"
 364 #endif
 365
 366 /*
 367  * long_ptr_t & ulong_ptr_t, same to "long" for gcc
 368  */
 369 # define LPLU "%lu"
 370 # define LPLD "%ld"
 371 # define LPLX "%#lx"
 372
 373 /*
 374  * pid_t
 375  */
 376 # define LPPID "%d"
 377
 378 #ifdef HAVE_SIZE_T_LONG
 379 # define LPSZ  "%lu"
 380 #else
 381 # define LPSZ  "%u"
 382 #endif
 383
 384 #ifdef HAVE_SSIZE_T_LONG
 385 # define LPSSZ "%ld"
 386 #else
 387 # define LPSSZ "%d"
 388 #endif
 389
 390 #ifndef LPU64
 391 # error "No word size defined"
 392 #endif
 393
 394 #undef _LWORDSIZE
 395
 396 /* compat macroses */
 397 #ifndef HAVE_SCATTERLIST_SETPAGE
 398 static inline void sg_set_page(struct scatterlist *sg, struct page *page,
 399                                unsigned int len, unsigned int offset)
 400 {
 401         sg->page = page;
 402         sg->offset = offset;
 403         sg->length = len;
 404 }
 405 #endif
 406
 407 #ifndef get_cpu
 408 # ifdef CONFIG_PREEMPT
 409 #  define cfs_get_cpu()  ({ preempt_disable(); smp_processor_id(); })
 410 #  define cfs_put_cpu()  preempt_enable()
 411 # else
 412 #  define cfs_get_cpu()  smp_processor_id()
 413 #  define cfs_put_cpu()
 414 # endif
 415 #else
 416 # define cfs_get_cpu()   get_cpu()
 417 # define cfs_put_cpu()   put_cpu()
 418 #endif /* get_cpu & put_cpu */
 419
 420 #endif