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