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