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