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