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, 2013, Intel Corporation.
  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 #include <linux/kernel.h>
  42 #include <linux/mm.h>
  43 #include <linux/string.h>
  44 #include <linux/stat.h>
  45 #include <linux/init.h>
  46 #include <linux/errno.h>
  47 #include <linux/unistd.h>
  48 #include <linux/kmod.h>
  49 #include <linux/notifier.h>
  50 #include <linux/fs.h>
  51 #include <linux/miscdevice.h>
  52 #include <linux/vmalloc.h>
  53 #include <linux/time.h>
  54 #include <linux/slab.h>
  55 #include <linux/interrupt.h>
  56 #include <linux/highmem.h>
  57 #include <linux/module.h>
  58 #include <linux/version.h>
  59 #include <asm/atomic.h>
  60 #include <asm/uaccess.h>
  61 #include <linux/rwsem.h>
  62 #include <linux/proc_fs.h>
  63 #include <linux/file.h>
  64 #include <linux/smp.h>
  65 #include <linux/ctype.h>
  66 #include <linux/compiler.h>
  67 #ifdef HAVE_MM_INLINE
  68 # include <linux/mm_inline.h>
  69 #endif
  70 #include <linux/kallsyms.h>
  71 #include <linux/moduleparam.h>
  72 #include <linux/scatterlist.h>
  73
  74 #include <libcfs/linux/portals_compat25.h>
  75
  76 /* ------------------------------------------------------------------- */
  77
  78 #define PORTAL_SYMBOL_GET(x) symbol_get(x)
  79 #define PORTAL_SYMBOL_PUT(x) symbol_put(x)
  80
  81 #define PORTAL_MODULE_USE       try_module_get(THIS_MODULE)
  82 #define PORTAL_MODULE_UNUSE     module_put(THIS_MODULE)
  83
  84
  85 /******************************************************************************/
  86 /* Module parameter support */
  87 #define CFS_MODULE_PARM(name, t, type, perm, desc) \
  88         module_param(name, type, perm);\
  89         MODULE_PARM_DESC(name, desc)
  90
  91 #define CFS_SYSFS_MODULE_PARM  1 /* module parameters accessible via sysfs */
  92
  93 /******************************************************************************/
  94
  95 #if (__GNUC__)
  96 /* Use the special GNU C __attribute__ hack to have the compiler check the
  97  * printf style argument string against the actual argument count and
  98  * types.
  99  */
 100 #ifdef printf
 101 # warning printf has been defined as a macro...
 102 # undef printf
 103 #endif
 104
 105 #endif /* __GNUC__ */
 106
 107 # define fprintf(a, format, b...) CDEBUG(D_OTHER, format , ## b)
 108 # define printf(format, b...) CDEBUG(D_OTHER, format , ## b)
 109 # define time(a) CURRENT_TIME
 110
 111 /******************************************************************************/
 112 /* Light-weight trace
 113  * Support for temporary event tracing with minimal Heisenberg effect. */
 114 #define LWT_SUPPORT  0
 115
 116 #define LWT_MEMORY   (16<<20)
 117
 118 #ifndef KLWT_SUPPORT
 119 # if defined(__KERNEL__)
 120 #  if !defined(BITS_PER_LONG)
 121 #   error "BITS_PER_LONG not defined"
 122 #  endif
 123 # elif !defined(__WORDSIZE)
 124 #  error "__WORDSIZE not defined"
 125 # else
 126 #  define BITS_PER_LONG __WORDSIZE
 127 # endif
 128
 129 /* kernel hasn't defined this? */
 130 typedef struct {
 131         long long   lwte_when;
 132         char       *lwte_where;
 133         void       *lwte_task;
 134         long        lwte_p1;
 135         long        lwte_p2;
 136         long        lwte_p3;
 137         long        lwte_p4;
 138 # if BITS_PER_LONG > 32
 139         long        lwte_pad;
 140 # endif
 141 } lwt_event_t;
 142 #endif /* !KLWT_SUPPORT */
 143
 144 #if LWT_SUPPORT
 145 # ifdef __KERNEL__
 146 #  if !KLWT_SUPPORT
 147
 148 typedef struct _lwt_page {
 149         cfs_list_t               lwtp_list;
 150         struct page             *lwtp_page;
 151         lwt_event_t             *lwtp_events;
 152 } lwt_page_t;
 153
 154 typedef struct {
 155         int                lwtc_current_index;
 156         lwt_page_t        *lwtc_current_page;
 157 } lwt_cpu_t;
 158
 159 extern int       lwt_enabled;
 160 extern lwt_cpu_t lwt_cpus[];
 161
 162 /* Note that we _don't_ define LWT_EVENT at all if LWT_SUPPORT isn't set.
 163  * This stuff is meant for finding specific problems; it never stays in
 164  * production code... */
 165
 166 #define LWTSTR(n)       #n
 167 #define LWTWHERE(f,l)   f ":" LWTSTR(l)
 168 #define LWT_EVENTS_PER_PAGE (PAGE_CACHE_SIZE / sizeof(lwt_event_t))
 169
 170 #define LWT_EVENT(p1, p2, p3, p4)                                       \
 171 do {                                                                    \
 172         unsigned long    flags;                                         \
 173         lwt_cpu_t       *cpu;                                           \
 174         lwt_page_t      *p;                                             \
 175         lwt_event_t     *e;                                             \
 176                                                                         \
 177         if (lwt_enabled) {                                              \
 178                 local_irq_save (flags);                                 \
 179                                                                         \
 180                 cpu = &lwt_cpus[smp_processor_id()];                    \
 181                 p = cpu->lwtc_current_page;                             \
 182                 e = &p->lwtp_events[cpu->lwtc_current_index++];         \
 183                                                                         \
 184                 if (cpu->lwtc_current_index >= LWT_EVENTS_PER_PAGE) {   \
 185                         cpu->lwtc_current_page =                        \
 186                                 cfs_list_entry (p->lwtp_list.next,      \
 187                                                 lwt_page_t, lwtp_list); \
 188                         cpu->lwtc_current_index = 0;                    \
 189                 }                                                       \
 190                                                                         \
 191                 e->lwte_when  = get_cycles();                           \
 192                 e->lwte_where = LWTWHERE(__FILE__,__LINE__);            \
 193                 e->lwte_task  = current;                                \
 194                 e->lwte_p1    = (long)(p1);                             \
 195                 e->lwte_p2    = (long)(p2);                             \
 196                 e->lwte_p3    = (long)(p3);                             \
 197                 e->lwte_p4    = (long)(p4);                             \
 198                                                                         \
 199                 local_irq_restore (flags);                              \
 200         }                                                               \
 201 } while (0)
 202
 203 #endif /* !KLWT_SUPPORT */
 204
 205 extern int  lwt_init (void);
 206 extern void lwt_fini (void);
 207 extern int  lwt_lookup_string (int *size, char *knlptr,
 208                                char *usrptr, int usrsize);
 209 extern int  lwt_control (int enable, int clear);
 210 extern int  lwt_snapshot (cfs_cycles_t *now, int *ncpu, int *total_size,
 211                           void *user_ptr, int user_size);
 212 # else  /* __KERNEL__ */
 213 #  define LWT_EVENT(p1,p2,p3,p4)     /* no userland implementation yet */
 214 # endif /* __KERNEL__ */
 215 #endif /* LWT_SUPPORT */
 216
 217 /* ------------------------------------------------------------------ */
 218
 219 #define IOCTL_LIBCFS_TYPE long
 220
 221 #ifdef __CYGWIN__
 222 # ifndef BITS_PER_LONG
 223 #  if (~0UL) == 0xffffffffUL
 224 #   define BITS_PER_LONG 32
 225 #  else
 226 #   define BITS_PER_LONG 64
 227 #  endif
 228 # endif
 229 #endif
 230
 231 #if BITS_PER_LONG > 32
 232 # define LI_POISON ((int)0x5a5a5a5a5a5a5a5a)
 233 # define LL_POISON ((long)0x5a5a5a5a5a5a5a5a)
 234 # define LP_POISON ((void *)(long)0x5a5a5a5a5a5a5a5a)
 235 #else
 236 # define LI_POISON ((int)0x5a5a5a5a)
 237 # define LL_POISON ((long)0x5a5a5a5a)
 238 # define LP_POISON ((void *)(long)0x5a5a5a5a)
 239 #endif
 240
 241 /* this is a bit chunky */
 242
 243 #define _LWORDSIZE BITS_PER_LONG
 244
 245 #if (defined(__KERNEL__) && defined(HAVE_KERN__U64_LONG_LONG)) || \
 246     (!defined(__KERNEL__) && defined(HAVE_USER__U64_LONG_LONG))
 247 # define LPU64 "%llu"
 248 # define LPD64 "%lld"
 249 # define LPX64 "%#llx"
 250 # define LPX64i "%llx"
 251 # define LPO64 "%#llo"
 252 # define LPF64 "L"
 253 #else
 254 # define LPU64 "%lu"
 255 # define LPD64 "%ld"
 256 # define LPX64 "%#lx"
 257 # define LPX64i "%lx"
 258 # define LPO64 "%#lo"
 259 # define LPF64 "l"
 260 #endif
 261
 262 /*
 263  * long_ptr_t & ulong_ptr_t, same to "long" for gcc
 264  */
 265 # define LPLU "%lu"
 266 # define LPLD "%ld"
 267 # define LPLX "%#lx"
 268
 269 /*
 270  * pid_t
 271  */
 272 # define LPPID "%d"
 273
 274 #ifndef LPU64
 275 # error "No word size defined"
 276 #endif
 277
 278 #undef _LWORDSIZE
 279
 280 #ifdef HAVE_SYSCTL_CTLNAME
 281 #define INIT_CTL_NAME(a) .ctl_name = a,
 282 #define INIT_STRATEGY(a) .strategy = a,
 283 #else
 284 #define INIT_CTL_NAME(a)
 285 #define INIT_STRATEGY(a)
 286 #endif
 287
 288 #endif