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