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