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