libcfs/include/libcfs/linux/kp30.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, Whamcloud, Inc.
  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 <asm/atomic.h>
  64 #include <asm/uaccess.h>
  65 #include <linux/rwsem.h>
  66 #include <linux/proc_fs.h>
  67 #include <linux/file.h>
  68 #include <linux/smp.h>
  69 #include <linux/ctype.h>
  70 #include <linux/compiler.h>
  71 #ifdef HAVE_MM_INLINE
  72 # include <linux/mm_inline.h>
  73 #endif
  74 #include <linux/kallsyms.h>
  75 #include <linux/moduleparam.h>
  76 #include <linux/scatterlist.h>
  77
  78 #include <libcfs/linux/portals_compat25.h>
  79
  80 #ifdef HAVE_3ARGS_INIT_WORK
  81
  82 #define prepare_work(wq,cb,cbdata)                                            \
  83 do {                                                                          \
  84         INIT_WORK((wq), (void *)(cb), (void *)(cbdata));                      \
  85 } while (0)
  86
  87 #define cfs_get_work_data(type,field,data)   (data)
  88
  89 #else
  90
  91 #define prepare_work(wq,cb,cbdata)                                            \
  92 do {                                                                          \
  93         INIT_WORK((wq), (void *)(cb));                                        \
  94 } while (0)
  95
  96 #define cfs_get_work_data(type,field,data) container_of(data,type,field)
  97
  98 #endif
  99
 100 #define cfs_num_online_cpus() num_online_cpus()
 101 #define wait_on_page wait_on_page_locked
 102 #define our_recalc_sigpending(current) recalc_sigpending()
 103 #define strtok(a,b) strpbrk(a, b)
 104 #define work_struct_t      struct work_struct
 105
 106 #ifdef CONFIG_SMP
 107 #define LASSERT_SPIN_LOCKED(lock) LASSERT(spin_is_locked(lock))
 108 #define LINVRNT_SPIN_LOCKED(lock) LINVRNT(spin_is_locked(lock))
 109 #else
 110 #define LASSERT_SPIN_LOCKED(lock) do {(void)sizeof(lock);} while(0)
 111 #define LINVRNT_SPIN_LOCKED(lock) do {(void)sizeof(lock);} while(0)
 112 #endif
 113
 114 #define LASSERT_SEM_LOCKED(sem) LASSERT(down_trylock(sem) != 0)
 115 #define LASSERT_MUTEX_LOCKED(x) LASSERT(mutex_is_locked(x))
 116
 117 #ifdef HAVE_SEM_COUNT_ATOMIC
 118 #define SEM_COUNT(sem)          (atomic_read(&(sem)->count))
 119 #else
 120 #define SEM_COUNT(sem)          ((sem)->count)
 121 #endif
 122
 123 #define LIBCFS_PANIC(msg)            panic(msg)
 124
 125 /* ------------------------------------------------------------------- */
 126
 127 #define PORTAL_SYMBOL_REGISTER(x)
 128 #define PORTAL_SYMBOL_UNREGISTER(x)
 129
 130 #define PORTAL_SYMBOL_GET(x) symbol_get(x)
 131 #define PORTAL_SYMBOL_PUT(x) symbol_put(x)
 132
 133 #define PORTAL_MODULE_USE       try_module_get(THIS_MODULE)
 134 #define PORTAL_MODULE_UNUSE     module_put(THIS_MODULE)
 135
 136
 137 /******************************************************************************/
 138 /* Module parameter support */
 139 #define CFS_MODULE_PARM(name, t, type, perm, desc) \
 140         module_param(name, type, perm);\
 141         MODULE_PARM_DESC(name, desc)
 142
 143 #define CFS_SYSFS_MODULE_PARM  1 /* module parameters accessible via sysfs */
 144
 145 /******************************************************************************/
 146
 147 #if (__GNUC__)
 148 /* Use the special GNU C __attribute__ hack to have the compiler check the
 149  * printf style argument string against the actual argument count and
 150  * types.
 151  */
 152 #ifdef printf
 153 # warning printf has been defined as a macro...
 154 # undef printf
 155 #endif
 156
 157 #endif /* __GNUC__ */
 158
 159 # define fprintf(a, format, b...) CDEBUG(D_OTHER, format , ## b)
 160 # define printf(format, b...) CDEBUG(D_OTHER, format , ## b)
 161 # define time(a) CURRENT_TIME
 162
 163 # define cfs_num_possible_cpus() num_possible_cpus()
 164 # define cfs_num_present_cpus()  num_present_cpus()
 165
 166 /******************************************************************************/
 167 /* Light-weight trace
 168  * Support for temporary event tracing with minimal Heisenberg effect. */
 169 #define LWT_SUPPORT  0
 170
 171 #define LWT_MEMORY   (16<<20)
 172
 173 #ifndef KLWT_SUPPORT
 174 # if defined(__KERNEL__)
 175 #  if !defined(BITS_PER_LONG)
 176 #   error "BITS_PER_LONG not defined"
 177 #  endif
 178 # elif !defined(__WORDSIZE)
 179 #  error "__WORDSIZE not defined"
 180 # else
 181 #  define BITS_PER_LONG __WORDSIZE
 182 # endif
 183
 184 /* kernel hasn't defined this? */
 185 typedef struct {
 186         long long   lwte_when;
 187         char       *lwte_where;
 188         void       *lwte_task;
 189         long        lwte_p1;
 190         long        lwte_p2;
 191         long        lwte_p3;
 192         long        lwte_p4;
 193 # if BITS_PER_LONG > 32
 194         long        lwte_pad;
 195 # endif
 196 } lwt_event_t;
 197 #endif /* !KLWT_SUPPORT */
 198
 199 #if LWT_SUPPORT
 200 # ifdef __KERNEL__
 201 #  if !KLWT_SUPPORT
 202
 203 typedef struct _lwt_page {
 204         cfs_list_t               lwtp_list;
 205         struct page             *lwtp_page;
 206         lwt_event_t             *lwtp_events;
 207 } lwt_page_t;
 208
 209 typedef struct {
 210         int                lwtc_current_index;
 211         lwt_page_t        *lwtc_current_page;
 212 } lwt_cpu_t;
 213
 214 extern int       lwt_enabled;
 215 extern lwt_cpu_t lwt_cpus[];
 216
 217 /* Note that we _don't_ define LWT_EVENT at all if LWT_SUPPORT isn't set.
 218  * This stuff is meant for finding specific problems; it never stays in
 219  * production code... */
 220
 221 #define LWTSTR(n)       #n
 222 #define LWTWHERE(f,l)   f ":" LWTSTR(l)
 223 #define LWT_EVENTS_PER_PAGE (CFS_PAGE_SIZE / sizeof (lwt_event_t))
 224
 225 #define LWT_EVENT(p1, p2, p3, p4)                                       \
 226 do {                                                                    \
 227         unsigned long    flags;                                         \
 228         lwt_cpu_t       *cpu;                                           \
 229         lwt_page_t      *p;                                             \
 230         lwt_event_t     *e;                                             \
 231                                                                         \
 232         if (lwt_enabled) {                                              \
 233                 local_irq_save (flags);                                 \
 234                                                                         \
 235                 cpu = &lwt_cpus[smp_processor_id()];                    \
 236                 p = cpu->lwtc_current_page;                             \
 237                 e = &p->lwtp_events[cpu->lwtc_current_index++];         \
 238                                                                         \
 239                 if (cpu->lwtc_current_index >= LWT_EVENTS_PER_PAGE) {   \
 240                         cpu->lwtc_current_page =                        \
 241                                 cfs_list_entry (p->lwtp_list.next,      \
 242                                                 lwt_page_t, lwtp_list); \
 243                         cpu->lwtc_current_index = 0;                    \
 244                 }                                                       \
 245                                                                         \
 246                 e->lwte_when  = get_cycles();                           \
 247                 e->lwte_where = LWTWHERE(__FILE__,__LINE__);            \
 248                 e->lwte_task  = current;                                \
 249                 e->lwte_p1    = (long)(p1);                             \
 250                 e->lwte_p2    = (long)(p2);                             \
 251                 e->lwte_p3    = (long)(p3);                             \
 252                 e->lwte_p4    = (long)(p4);                             \
 253                                                                         \
 254                 local_irq_restore (flags);                              \
 255         }                                                               \
 256 } while (0)
 257
 258 #endif /* !KLWT_SUPPORT */
 259
 260 extern int  lwt_init (void);
 261 extern void lwt_fini (void);
 262 extern int  lwt_lookup_string (int *size, char *knlptr,
 263                                char *usrptr, int usrsize);
 264 extern int  lwt_control (int enable, int clear);
 265 extern int  lwt_snapshot (cfs_cycles_t *now, int *ncpu, int *total_size,
 266                           void *user_ptr, int user_size);
 267 # else  /* __KERNEL__ */
 268 #  define LWT_EVENT(p1,p2,p3,p4)     /* no userland implementation yet */
 269 # endif /* __KERNEL__ */
 270 #endif /* LWT_SUPPORT */
 271
 272 /* ------------------------------------------------------------------ */
 273
 274 #define IOCTL_LIBCFS_TYPE long
 275
 276 #ifdef __CYGWIN__
 277 # ifndef BITS_PER_LONG
 278 #  if (~0UL) == 0xffffffffUL
 279 #   define BITS_PER_LONG 32
 280 #  else
 281 #   define BITS_PER_LONG 64
 282 #  endif
 283 # endif
 284 #endif
 285
 286 #if BITS_PER_LONG > 32
 287 # define LI_POISON ((int)0x5a5a5a5a5a5a5a5a)
 288 # define LL_POISON ((long)0x5a5a5a5a5a5a5a5a)
 289 # define LP_POISON ((void *)(long)0x5a5a5a5a5a5a5a5a)
 290 #else
 291 # define LI_POISON ((int)0x5a5a5a5a)
 292 # define LL_POISON ((long)0x5a5a5a5a)
 293 # define LP_POISON ((void *)(long)0x5a5a5a5a)
 294 #endif
 295
 296 /* this is a bit chunky */
 297
 298 #define _LWORDSIZE BITS_PER_LONG
 299
 300 #if (defined(__KERNEL__) && defined(HAVE_KERN__U64_LONG_LONG)) || \
 301     (!defined(__KERNEL__) && defined(HAVE_USER__U64_LONG_LONG))
 302 # define LPU64 "%llu"
 303 # define LPD64 "%lld"
 304 # define LPX64 "%#llx"
 305 # define LPX64i "%llx"
 306 # define LPO64 "%#llo"
 307 # define LPF64 "L"
 308 #else
 309 # define LPU64 "%lu"
 310 # define LPD64 "%ld"
 311 # define LPX64 "%#lx"
 312 # define LPX64i "%lx"
 313 # define LPO64 "%#lo"
 314 # define LPF64 "l"
 315 #endif
 316
 317 /*
 318  * long_ptr_t & ulong_ptr_t, same to "long" for gcc
 319  */
 320 # define LPLU "%lu"
 321 # define LPLD "%ld"
 322 # define LPLX "%#lx"
 323
 324 /*
 325  * pid_t
 326  */
 327 # define LPPID "%d"
 328
 329 #ifndef LPU64
 330 # error "No word size defined"
 331 #endif
 332
 333 #undef _LWORDSIZE
 334
 335 /* compat macroses */
 336 #ifndef HAVE_SCATTERLIST_SETPAGE
 337 static inline void sg_set_page(struct scatterlist *sg, struct page *page,
 338                                unsigned int len, unsigned int offset)
 339 {
 340         sg->page = page;
 341         sg->offset = offset;
 342         sg->length = len;
 343 }
 344 #endif
 345
 346 #define cfs_smp_processor_id()  smp_processor_id()
 347
 348 #ifndef get_cpu
 349 # ifdef CONFIG_PREEMPT
 350 #  define cfs_get_cpu()  ({ preempt_disable(); smp_processor_id(); })
 351 #  define cfs_put_cpu()  preempt_enable()
 352 # else
 353 #  define cfs_get_cpu()  smp_processor_id()
 354 #  define cfs_put_cpu()
 355 # endif
 356 #else
 357 # define cfs_get_cpu()   get_cpu()
 358 # define cfs_put_cpu()   put_cpu()
 359 #endif /* get_cpu & put_cpu */
 360
 361 #ifdef HAVE_SYSCTL_CTLNAME
 362 #define INIT_CTL_NAME(a) .ctl_name = a,
 363 #define INIT_STRATEGY(a) .strategy = a,
 364 #else
 365 #define INIT_CTL_NAME(a)
 366 #define INIT_STRATEGY(a)
 367 #endif
 368
 369 #endif